Support for replicating tokens on chain #311

gkaracha · 2021-12-10T09:45:19Z

Closes #263.

Implement a mock cfmm oracle to use in tests. To ensure that our tests can catch forgotten changes (i.e., avoid mixing it up with the usual mock oracle), the name of the price entrypoint is %getCfmmPrice (as opposed to %getPrice which is the one we use for the mock oracle). This is not very descriptive and does not indicate the units we expect the fraction to have (tok/ctok), but it's only a placeholder for now. We might want to change this in the future, or even perhaps get it from the yaml file at build time.
Also: currently both mock oracles (index and cfmm) have an update entrypoint but since this is not part of Checker's spec I saw no good reason to deviate on the name of this one too.
Extend the yaml specification with another field (tracking_type) which can take one of two values: index or token.
Generalize the type of the (index-)oracle to a pair of nats (CHF in TEZ, (TEZ/CHF)). This reduces the number of differences between token-based and index-based instances quite some.
Turn the calculation of the target into jinja templates. The different price calculation does manifest itself in the drift adjustment (see Generalize checker to be able to replicate tokens on chain #263 (comment)), but indirectly, through the target. Hence the target became a jinja template and not the drift derivative.
Add docs/prices.md with some notes about price calculations, taken from Generalize checker to be able to replicate tokens on chain #263 (comment).
Extend CI to run all the tests with all the three possible configurations: checker-index-tez.yaml, checker-index-fa2.yaml, and checker-token-fa2.yaml.

…t types

github-actions · 2021-12-16T14:45:52Z

Gas costs	`74f9e3d`	`6662564`	Diff
checker%touch	42390	42430	40
checker%create_burrow	22343	22344	1
checker%add_liquidity	12599	12600	1
checker%set_burrow_delegate	18365	18366	1
checker%mint_kit	7131	7132	1
checker%touch_burrow	6102	6103	1
checker%transfer	6311	6312	1
checker%burn_kit	7359	7360	1

Entrypoint sizes	`74f9e3d`	`6662564`	Diff
touch	56504	56687	183
receive_price	287	289	2

Test coverage	`74f9e3d`	`6662564`	Diff
targetCalculation.ml	None	100	100
getOracleEntrypoint.ml	None	75	75
checkerTypes.ml	77.78	78.57	0.789999999999992
checker.ml	94.97	94.98	0.010000000000005116
TOTAL	81.9	81.91	0.009999999999990905

gkaracha · 2021-12-16T15:03:26Z

OK, I think this one is finally ready for review @dorranh! The description is also now up to date.

After merging this I think we'll be at the point where the README should have separate build/deployment/testing instructions per configuration. Hopefully the API won't really change after this PR so we can start looking at #118 soon after.

I had to deactivate three tests that are configuration-specific for CI to pass, but we should be able to renable those tests once #284 is addressed (partially or completely; I might be able to fix that rather easily, being on the OCaml side). Either way, I'd go ahead and merge this PR without them for now.

dorranh

Overall looks good to me! I just had one question regarding units of measure. If the comment is not actually an issue then I am happy merging 🙂

src/targetCalculation.mli

dorranh · 2021-12-17T09:32:07Z

scripts/builder/checker_builder/templates/tokenTargetCalculation.ml.jinja

+(** Calculate the current target based on the current quantity, and the current
+    price of kit in ctok (as given by the CFMM).
+    {[
+      target_{i+1} = FLOOR (q_{i+1} / kit_in_ctok_{i+1})


Is the target still dimensionless if we've removed index from this equation? To me this reads: [1/kit] / [ctok/kit] => [1/ctok]. Perhaps q has different units in the case of a token-based checker? Not sure if this has implications for the system though.

I just re-read the new document covering the units of measure and am still a bit confused about which units q is supposed to have. Perhaps we could discuss this offline as well.

Yeah, let's discuss this more offline. For reference, here's how I've been thinking about the two cases:

index-tracking CHF
index : tok/CHF p_cfmm : tok/kit => (index/p_cfmm) : kit/CHF

token-tracking tzCHF
p_cfmm : tzCHF/kit => (1/p_cfmm) : kit/tzCHF

dorranh · 2021-12-17T09:34:33Z

src/checker.ml

-    let price = fixedpoint_of_ratio_floor (make_ratio (Ligo.int idx) tok_scaling_factor_int) in
+    let price =
+      let (num, den) = oracle_price in
+      fixedpoint_of_ratio_floor (make_ratio (Ligo.int num) (Ligo.int den)) in


Maybe we should add a comment here to make it extra obvious that we are losing some precision?

Ah yes, I added a small note in a9d6a88 👍

… review)

github-actions · 2021-12-17T10:49:28Z

Gas costs	`74f9e3d`	`a9d6a88`	Diff
checker%touch	42390	42430	40
checker%touch_burrow	6102	6103	1
checker%add_liquidity	12599	12600	1
checker%mint_kit	7131	7132	1
checker%transfer	6311	6312	1
checker%set_burrow_delegate	18365	18366	1
checker%create_burrow	22343	22344	1
checker%burn_kit	7359	7360	1
checker%update_operators	5589	5590	1

Entrypoint sizes	`74f9e3d`	`a9d6a88`	Diff
touch	56504	56675	171
receive_price	287	289	2

Test coverage	`74f9e3d`	`a9d6a88`	Diff
targetCalculation.ml	None	100	100
getOracleEntrypoint.ml	None	75	75
checkerTypes.ml	77.78	78.57	0.789999999999992
checker.ml	94.97	94.98	0.010000000000005116
TOTAL	81.9	81.89	-0.010000000000005116

gkaracha · 2021-12-17T13:58:33Z

@dorranh shall I go ahead and merge this?

dorranh · 2021-12-17T14:14:03Z

@gkaracha, yep I think it's good to go following our separate discussion of the target calculation.

This comment has been minimized.

Sign in to view

gkaracha added 17 commits December 15, 2021 17:05

Add a mock cfmm oracle (non-descriptive entrypoint name at the moment)

18716d7

Start working on deployment and integration

a70cff2

Add a tracking_type field to the yaml configuration

9c5b345

Format

23f3759

Disallow (tracking_type=token && collateral_type=tez) during validation

bc317d0

Gather everything? oracle-related into one place

c3fc959

Start addressing FIXMEs

e6d7613

Start working the jinja scaffolding

a45e083

Fix the two templates

2fc8f49

Remove the .mli file so that the index-based tests can pass

a34fd06

Move the target calculation into its own module

1c4051e

More idiomatic

e3d6bbe

[wip] [skip ci]

2f93ffb

[wip] [skip ci]

a70459c

[wip] [skip ci] patch src/tokenTargetCalculation.ml

fb3de86

[wip] [skip ci]

3b17ccf

[wip] [skip ci] both prices come as pairs, even if they have differen…

1923412

…t types

gkaracha force-pushed the gkaracha/cfmm-price branch from 0704155 to 1923412 Compare December 15, 2021 16:05

gkaracha added 6 commits December 16, 2021 11:33

Proper names and patch to get +build-ligo to succeed

43f431b

[skip ci] Turn target calculation into a (two) jinja template(s)

23571ab

[wip] Fix some deployment issues

b1d7614

Patch the OCaml tests

a50accb

work a little on the docs

c13a9d3

Add the notes about prices into the repo

bbb6855

This comment has been minimized.

Sign in to view

gkaracha added 3 commits December 16, 2021 14:57

Add the final configuration combination on CI

a0b4abf

Comment out offending tests

4a19902

format

6662564

gkaracha marked this pull request as ready for review December 16, 2021 15:02

gkaracha requested a review from dorranh December 16, 2021 15:03

dorranh approved these changes Dec 17, 2021

View reviewed changes

Add a comment about the precision of last_index (address comment from…

a9d6a88

… review)

gkaracha merged commit 89b06df into master Dec 17, 2021

gkaracha deleted the gkaracha/cfmm-price branch December 17, 2021 14:16

gkaracha mentioned this pull request Dec 17, 2021

Testing different configurations #284

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for replicating tokens on chain #311

Support for replicating tokens on chain #311

gkaracha commented Dec 10, 2021 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Dec 16, 2021 •

edited

Loading

gkaracha commented Dec 16, 2021 •

edited

Loading

dorranh left a comment

dorranh Dec 17, 2021

dorranh Dec 17, 2021

gkaracha Dec 17, 2021

dorranh Dec 17, 2021

gkaracha Dec 17, 2021

github-actions bot commented Dec 17, 2021 •

edited

Loading

gkaracha commented Dec 17, 2021

dorranh commented Dec 17, 2021

Support for replicating tokens on chain #311

Support for replicating tokens on chain #311

Conversation

gkaracha commented Dec 10, 2021 • edited Loading

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Dec 16, 2021 • edited Loading

gkaracha commented Dec 16, 2021 • edited Loading

dorranh left a comment

Choose a reason for hiding this comment

dorranh Dec 17, 2021

Choose a reason for hiding this comment

dorranh Dec 17, 2021

Choose a reason for hiding this comment

gkaracha Dec 17, 2021

Choose a reason for hiding this comment

dorranh Dec 17, 2021

Choose a reason for hiding this comment

gkaracha Dec 17, 2021

Choose a reason for hiding this comment

github-actions bot commented Dec 17, 2021 • edited Loading

gkaracha commented Dec 17, 2021

dorranh commented Dec 17, 2021

gkaracha commented Dec 10, 2021 •

edited

Loading

github-actions bot commented Dec 16, 2021 •

edited

Loading

gkaracha commented Dec 16, 2021 •

edited

Loading

github-actions bot commented Dec 17, 2021 •

edited

Loading