Initial lexer and parser for specifying Mary multi assets via the cli #2072

Jimbo4350 · 2020-11-09T11:20:41Z

Introduce CLI parsing of a new proposed syntax for multi-asset Values and TxOuts. Note that this new syntax is backward-compatible with the old syntax. i.e. the old transaction output CLI syntax: ${address}+{lovelace} is still supported.

The new syntax is defined as follows:

Values

Specifying individual values

Lovelace values can be specified in the following ways:
- ${quantity} lovelace (where quantity is a signed integer)
- ${quantity} (where quantity is a signed integer)
Values for other assets can be specified in the following ways:
- ${quantity} ${policyId}.${assetName} (where quantity is a signed integer, policyId is a hex-encoded policy ID [script hash], and assetName is an alphanumeric asset name)
- ${quantity} ${policyId} (where quantity is a signed integer and policyId is a hex-encoded policy ID [script hash])

Negating individual values

Individual values can be negated by utilizing the - prefix operator. All individual values can be prefixed by this operator. Some examples:

-42 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74
-72191 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74.foo
-100
-920 lovelace

Combining individual values

Values can be combined by using the + binary operator. Some examples:

42 lovelace + -1 (this would result in a Value of 41 lovelace)
20 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74 + 12 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74.foo + -2 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74.bar
201 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74.foo + 12 + -1 + 9 lovelace + 10 46f192e30c5d8fcc5ccbcd9c91e430283166b3382cd25261a1601b74

Transaction outputs

Transaction outputs can be specified in the following ways:

${address} ${value} (where address is a Cardano address and value is a value)
${address}+${value} (where address is a Cardano address and value is a value) (n.b. this is actually the old tx out CLI syntax that is additionally supported by the new parser)

intricate

Could we expand upon this PR's description with an example(s) of the kind of input this parser is capable of handling?

cardano-cli/cardano-cli.cabal

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

cardano-cli/test/Test/Cli/Gen.hs

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

intricate

See #2072 (review).

Forgot to select "request changes" on that review.

intricate

Some more comments.

cardano-api/src/Cardano/Api/Value.hs

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

intricate · 2020-11-27T02:11:02Z

Depends on #2129. Marking this PR as a draft until that's been merged.

dcoutts

Looking good.

I think the second patch can be dropped now, as it looks like it was applied already in another PR.

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

dcoutts

Looking good.

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

dcoutts · 2020-11-28T22:39:53Z

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

+data ValueExpr
+  = ValueExprAdd !ValueExpr !ValueExpr
+  | ValueExprLovelace !Quantity
+  | ValueExprMultiAsset !PolicyId !AssetName !Quantity


dcoutts · 2020-11-28T22:43:52Z

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

+tokenParser :: GenTokenParser String u Identity
+tokenParser = makeTokenParser haskellDef -- TODO: What language def to use?


I think we should avoid using this token parser. Our language is very very simple. We don't need to pull in this stuff.

We're only using it here for parens, which we don't actually want, and for reservedOp. The reservedOp is for checking that operators are not prefixes of any other reserved operators. But we have no other operators! So we can define our binary and prefix operators directly, without the token parser stuff.

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

dcoutts · 2020-11-28T23:14:41Z

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

+period :: Parser String
+period = string "."


If we make this have type Parser () then when we use it we don't need the _ <- syntax.

Oh, that's true. Thanks.

cardano-cli/src/Cardano/CLI/Mary/Parser.hs

cardano-api/src/Cardano/Api/Typed.hs

intricate · 2020-11-30T08:20:48Z

cardano-cli/src/Cardano/CLI/Shelley/Parsers.hs

+    Opt.option (eitherReader readTxOut)
+      (  Opt.long "tx-out"
+      <> Opt.metavar "TX-OUT"
+      -- TODO: Update the help text to describe the new syntax as well.


This needs to be addressed

cardano-cli/src/Cardano/CLI/Mary/TxOutParser.hs

dcoutts

I think this is ok now. We can make further internal improvements later (e.g. the error messages).

If CI tests pass lets squash down to one patch and merge it.

review now out of date

Add a concrete syntax and parser for multi-asset values. Use it in the cli for transaction outputs and minting. Example multi-asset values * "42" 42 lovelace, same syntax as coin values in previous eras * "42 lovelace" same with the special asset id for lovelace * "3 e09d36c79dec9bd1b3d9e152247701cd0bb860b5ebfd1de8abb6735a.foobar" 3 units of the asset with that policy id and asset name "foobar" * "3 e09d36c79dec9bd1b3d9e152247701cd0bb860b5ebfd1de8abb6735a" 3 units of the asset with that policy id and empty asset name "" * "42 lovelace + 3 e09d36c79dec9bd1b3d9e152247701cd0bb860b5ebfd1de8abb6735a" multiple such assets can be combined with + * "-3 e09d36c79dec9bd1b3d9e152247701cd0bb860b5ebfd1de8abb6735a + 42 dd0044a26cf7d4491ecea720fda11afb59d5725b53afa605fdf695e6" negative quantities are allowed for minting * "42 lovelace + -42 lovelace" Empty value! Co-authored-by: Luke Nadur <19835357+intricate@users.noreply.github.com> Co-authored-by: Duncan Coutts <duncan@well-typed.com>

dcoutts · 2020-11-30T19:03:06Z

bors merge

iohk-bors · 2020-11-30T19:58:20Z

Build succeeded:

Jimbo4350 requested review from dcoutts, erikd, intricate, mrBliss and newhoggy as code owners November 9, 2020 11:20

Jimbo4350 force-pushed the jordan/lexing-parsing-forge-value branch 3 times, most recently from a474787 to 71efdff Compare November 12, 2020 11:13

intricate reviewed Nov 12, 2020

View reviewed changes

intricate previously requested changes Nov 12, 2020

View reviewed changes

Jimbo4350 force-pushed the jordan/lexing-parsing-forge-value branch 3 times, most recently from af251c9 to 492e784 Compare November 18, 2020 14:41

intricate reviewed Nov 18, 2020

View reviewed changes

Jimbo4350 force-pushed the jordan/lexing-parsing-forge-value branch 2 times, most recently from 6ee854c to 37c5205 Compare November 26, 2020 09:25

intricate force-pushed the jordan/lexing-parsing-forge-value branch 3 times, most recently from f11528e to e275a4d Compare November 27, 2020 02:10

intricate marked this pull request as draft November 27, 2020 02:11

dcoutts force-pushed the jordan/lexing-parsing-forge-value branch from e275a4d to a5a59ad Compare November 27, 2020 09:06

dcoutts marked this pull request as ready for review November 27, 2020 09:06

dcoutts requested changes Nov 27, 2020

View reviewed changes

intricate mentioned this pull request Nov 27, 2020

Initial CLI update for Allegra and Mary eras #2129

Merged

intricate force-pushed the jordan/lexing-parsing-forge-value branch 2 times, most recently from 1be2c5f to 67e990b Compare November 28, 2020 22:31

dcoutts reviewed Nov 28, 2020

View reviewed changes

intricate self-requested a review November 30, 2020 05:43

intricate force-pushed the jordan/lexing-parsing-forge-value branch from 67e990b to 7019f0b Compare November 30, 2020 06:40

intricate force-pushed the jordan/lexing-parsing-forge-value branch from 7019f0b to 1b5494b Compare November 30, 2020 07:08

intricate self-assigned this Nov 30, 2020

intricate requested a review from dcoutts November 30, 2020 07:47

intricate force-pushed the jordan/lexing-parsing-forge-value branch 2 times, most recently from 9f4bbff to dd8e1da Compare November 30, 2020 08:06

intricate reviewed Nov 30, 2020

View reviewed changes

cardano-cli/src/Cardano/CLI/Mary/TxOutParser.hs Outdated Show resolved Hide resolved

dcoutts force-pushed the jordan/lexing-parsing-forge-value branch from 6e2299c to 24a1b77 Compare November 30, 2020 11:22

Jimbo4350 force-pushed the jordan/lexing-parsing-forge-value branch from f669c6a to 0dd4445 Compare November 30, 2020 15:30

dcoutts force-pushed the jordan/lexing-parsing-forge-value branch from 0dd4445 to f669c6a Compare November 30, 2020 15:32

dcoutts approved these changes Nov 30, 2020

View reviewed changes

dcoutts force-pushed the jordan/lexing-parsing-forge-value branch from 90a5f4f to db8e2f4 Compare November 30, 2020 19:01

iohk-bors bot merged commit a20c58d into master Nov 30, 2020

iohk-bors bot deleted the jordan/lexing-parsing-forge-value branch November 30, 2020 19:58

This was referenced Mar 9, 2022

Test syntax for specifying muti-asset values and txouts via CLI IntersectMBO/cardano-node-tests#967

Closed

Test syntax for specifying muti-asset values and txouts via CLI IntersectMBO/cardano-node-tests#968

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial lexer and parser for specifying Mary multi assets via the cli #2072

Initial lexer and parser for specifying Mary multi assets via the cli #2072

Jimbo4350 commented Nov 9, 2020 •

edited by intricate

intricate left a comment

intricate left a comment

intricate left a comment

intricate commented Nov 27, 2020

dcoutts left a comment

dcoutts left a comment

dcoutts Nov 28, 2020

dcoutts Nov 28, 2020

dcoutts Nov 28, 2020

intricate Nov 28, 2020

intricate Nov 30, 2020

dcoutts left a comment

dcoutts commented Nov 30, 2020

iohk-bors bot commented Nov 30, 2020

		tokenParser :: GenTokenParser String u Identity
		tokenParser = makeTokenParser haskellDef -- TODO: What language def to use?

Initial lexer and parser for specifying Mary multi assets via the cli #2072

Initial lexer and parser for specifying Mary multi assets via the cli #2072

Conversation

Jimbo4350 commented Nov 9, 2020 • edited by intricate

Values

Specifying individual values

Negating individual values

Combining individual values

Transaction outputs

intricate left a comment

Choose a reason for hiding this comment

intricate left a comment

Choose a reason for hiding this comment

intricate left a comment

Choose a reason for hiding this comment

intricate commented Nov 27, 2020

dcoutts left a comment

Choose a reason for hiding this comment

dcoutts left a comment

Choose a reason for hiding this comment

dcoutts Nov 28, 2020

Choose a reason for hiding this comment

dcoutts Nov 28, 2020

Choose a reason for hiding this comment

dcoutts Nov 28, 2020

Choose a reason for hiding this comment

intricate Nov 28, 2020

Choose a reason for hiding this comment

intricate Nov 30, 2020

Choose a reason for hiding this comment

dcoutts left a comment

Choose a reason for hiding this comment

dcoutts commented Nov 30, 2020

iohk-bors bot commented Nov 30, 2020

Jimbo4350 commented Nov 9, 2020 •

edited by intricate