Add `--output-json` for `call`, `instantiate` & `upload` commands by SkymanOne · Pull Request #722 · use-ink/cargo-contract

SkymanOne · 2022-09-01T17:43:40Z

Summary

As requested this PR closes #682, this PR adds support for printing out response from calling cargo contract instantiate .... and cargo contract call ... outputs in JSON format by introducing --output-json flag.

Previous human-readable format has been preserved.

Examples

Calling a contract with arg

cargo contract call --contract 5HLJobbpgd9EpJFySGDEanHkgh4nMaG6h1pFq9D2A5aTqibt --message inc --args 5 --suri //Alice --skip-confirm --output-json
{
  "verbosity": "Default",
  "estimated_gas": 74999922688,
  "events": [
    {
      "pallet": "Balances",
      "name": "Withdraw",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 86298156
          }
        }
      ]
    },
    {
      "pallet": "TransactionPayment",
      "name": "TransactionFeePaid",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "actual_fee",
          "value": {
            "UInt": 86298156
          }
        },
        {
          "name": "tip",
          "value": {
            "UInt": 0
          }
        }
      ]
    },
    {
      "pallet": "System",
      "name": "ExtrinsicSuccess",
      "fields": [
        {
          "name": "dispatch_info",
          "value": {
            "Map": {
              "weight": {
                "UInt": 7841193043
              },
              "class": {
                "Tuple": {
                  "ident": "Normal",
                  "values": []
                }
              },
              "pays_fee": {
                "Tuple": {
                  "ident": "Yes",
                  "values": []
                }
              }
            }
          }
        }
      ]
    }
  ]
}

Calling a contract with `--dry-run` flag

cargo contract call --contract 5HLJobbpgd9EpJFySGDEanHkgh4nMaG6h1pFq9D2A5aTqibt --message inc --args 5 --suri //Alice --skip-confirm --dry-run --output-json
{
  "result": "Success!",
  "reverted": false,
  "data": "Unit",
  "gas_consumed": 7391961043,
  "gas_required": 74999922688,
  "storage_deposit": {
    "charge": "0x0"
  }
}

Instantiating contract

{
  "contract": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9",
  "code_hash": "0xd73514bcae8754202a7cf32b2d4057ba9c95e7e82a3cb8f00b5ce1c64995ab70",
  "verbosity": "Default",
  "estimated_gas": 27371571412,
  "events": [
    {
      "pallet": "Balances",
      "name": "Withdraw",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 31189830465
          }
        }
      ]
    },
    {
      "pallet": "System",
      "name": "NewAccount",
      "fields": [
        {
          "name": "account",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Endowed",
      "fields": [
        {
          "name": "account",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        },
        {
          "name": "free_balance",
          "value": {
            "UInt": 100405000000
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Transfer",
      "fields": [
        {
          "name": "from",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "to",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 100405000000
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Reserved",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 100405000000
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Reserved",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 536140000000
          }
        }
      ]
    },
    {
      "pallet": "Contracts",
      "name": "CodeStored",
      "fields": [
        {
          "name": "code_hash",
          "value": {
            "Hex": {
              "s": "d73514bcae8754202a7cf32b2d4057ba9c95e7e82a3cb8f00b5ce1c64995ab70",
              "bytes": [
                215,
                53,
                20,
                188,
                174,
                135,
                84,
                32,
                42,
                124,
                243,
                43,
                45,
                64,
                87,
                186,
                156,
                149,
                231,
                232,
                42,
                60,
                184,
                240,
                11,
                92,
                225,
                198,
                73,
                149,
                171,
                112
              ]
            }
          }
        }
      ]
    },
    {
      "pallet": "Contracts",
      "name": "Instantiated",
      "fields": [
        {
          "name": "deployer",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "contract",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Transfer",
      "fields": [
        {
          "name": "from",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "to",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 100020000000
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Reserved",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 100020000000
          }
        }
      ]
    },
    {
      "pallet": "Balances",
      "name": "Deposit",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "amount",
          "value": {
            "UInt": 27233000969
          }
        }
      ]
    },
    {
      "pallet": "TransactionPayment",
      "name": "TransactionFeePaid",
      "fields": [
        {
          "name": "who",
          "value": {
            "Literal": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"
          }
        },
        {
          "name": "actual_fee",
          "value": {
            "UInt": 3956829496
          }
        },
        {
          "name": "tip",
          "value": {
            "UInt": 0
          }
        }
      ]
    },
    {
      "pallet": "System",
      "name": "ExtrinsicSuccess",
      "fields": [
        {
          "name": "dispatch_info",
          "value": {
            "Map": {
              "weight": {
                "UInt": 3870509443
              },
              "class": {
                "Tuple": {
                  "ident": "Normal",
                  "values": []
                }
              },
              "pays_fee": {
                "Tuple": {
                  "ident": "Yes",
                  "values": []
                }
              }
            }
          }
        }
      ]
    }
  ]
}

Instantiating a contract with dry-run

cargo contract instantiate --suri //Alice target/ink/incrementer.wasm --skip-dry-run --gas 27371571412 --args 0 --skip-confirm --dry-run --output-json
{
  "result": "Success!",
  "contract": "5EMUDqdfmSsyE7v3uksHtGRuEeQrgk7QteoJ8tXhqGANDCfG",
  "reverted": false,
  "data": "0x",
  "gas_consumed": 7360357127,
  "gas_required": 74999922688,
  "storage_deposit": {
    "charge": "0x2eaa42cc40"
  }
}

Updates

Added serialised StorageDeposit changes
Generic serialisation of Module errors and Generic error
Added an entry to the Changelog

SkymanOne · 2022-09-01T17:45:10Z

Currently, JSON is only displayed when if the operation has been successful. Should JSON response be introduced for errors?

cmichi · 2022-09-02T06:38:10Z

Currently, JSON is only displayed when if the operation has been successful. Should JSON response be introduced for errors?

That would be ideal, then third-party tooling can make better use of --output-json for scripting. I would print the errors as JSON on stderr.

For context: The PR has conflicts with master since we intentionally decided to branch it off before the breaking metadata changes, which currently prevent these commands on master from being used against a Substrate node.

SkymanOne · 2022-09-02T15:25:22Z

Update

Error are now partially json-rendered. Only instantiate command support serialised error output, call command can not produce serialised errors because of Error enum from subxt crate does not have serde derive

Example

cargo contract instantiate --suri //Charlie --code-hash 0xd73514bcae8754202a7cf32b2d4057ba9c95e7e82a3cb8f00b5ce1c64995ab70 --constructor new --args 0 --output-json
{
  "pallet": "Contracts",
  "error": "DuplicateContract",
  "docs": [
    "A contract with the same AccountId already exists."
  ]
}

P.S.

After short conversation with @ascjones It was agreed that RPC error does not have to and can not be serialised properly
Here is a sample result:

cargo contract call --contract 5FUdyfmrdbk1H5F1E4HnweiQjENqwAWnPxH2Mkty6LeK5at9 --message inc --args 5 --suri //Alice_S --skip-confirm --output-json
"Rpc error: RPC call failed: ErrorObject { code: ServerError(1010), message: \"Invalid Transaction\", data: Some(RawValue(\"Inability to pay some fees (e.g. account balance too low)\")) }"

SkymanOne · 2022-09-02T16:53:46Z

Update

Module and Generic errors are now serialised generically

`ModuleError`

{
  "module_error": {
    "pallet": "Contracts",
    "error": "DuplicateContract",
    "docs": [
      "A contract with the same AccountId already exists."
    ]
  }
}

`GenericError`

{
  "generic_error": {
    "error": "Rpc error: RPC call failed: ErrorObject { code: ServerError(1010), message: \"Invalid Transaction\", data: Some(RawValue(\"Inability to pay some fees (e.g. account balance too low)\")) }"
  }
}

ascjones

WIP review

crates/transcode/src/scon/mod.rs

crates/cargo-contract/src/cmd/extrinsics/call.rs

crates/cargo-contract/src/cmd/extrinsics/mod.rs

crates/cargo-contract/src/cmd/extrinsics/call.rs

crates/cargo-contract/src/cmd/extrinsics/events.rs

crates/cargo-contract/src/cmd/extrinsics/call.rs

crates/cargo-contract/src/cmd/extrinsics/upload.rs

crates/cargo-contract/src/cmd/extrinsics/events.rs

crates/transcode/src/scon/mod.rs

crates/cargo-contract/src/cmd/extrinsics/instantiate.rs

crates/cargo-contract/src/cmd/extrinsics/upload.rs

crates/cargo-contract/src/cmd/extrinsics/instantiate.rs

* Convert subxt error to custom ErrorVariant * Refactor displaying of extrinsic result events

crates/cargo-contract/src/cmd/extrinsics/upload.rs

ascjones · 2022-09-08T09:17:44Z

crates/cargo-contract/src/main.rs

-                "ERROR:".bright_red().bold(),
-                format!("{:?}", err).bright_red()
-            );
+            if !suppress_err {


I think we actually want to report the error as json rather than supressing it. At the moment for some errors we will get the pretty printed json at the call site, and all others will not be displayed at all.

If don't do this, then the output result can be like this:

{ "module_error": { "pallet": "Contracts", "error": "DuplicateContract", "docs": [ "A contract with the same AccountId already exists." ] } } { "error": "Pre-submission dry-run failed. Use --skip-dry-run to skip this step." }

Then we will need to rethink the approach. How about instead of printing the json error directly, we bubble it back up as an error?.

So instead of eprintnln!("{}", json_error); Ok(()) you could do (Err(anyhow!("{}", json_err)). Then this would be printed correctly at the top level

I made the error propagate to the top level, all the way back to the main(), then I check if an error is an json format and print out, otherwise I wrap the message into a serializable object.

ascjones · 2022-09-09T17:17:19Z

crates/cargo-contract/src/main.rs

+                // error message can be either plain text or json string
+                // we need to check whether the error message is json object
+                let json_result =
+                    serde_json::from_str::<serde_json::Value>(&err.to_string());


It's not great to serialize to json at the error site and then deserialize again at the top level. I think we can do better with a strongly typed approach see #736

* Move extrinsics error to its own file, update instantiate * Update upload to unify errors * Update call to unify errors * Handle json errors at the top level

ascjones

LGTM 👍

SkymanOne added 6 commits August 31, 2022 15:16

seralisable models for contract call

145412e

displaying events from the object

9a397ff

displaying calls results and fixing serialisation

ea52fde

fix typos

f31406c

json output when calling a contract

df8b16c

json output for dry-run

d994056

SkymanOne requested review from HCastano, ascjones and cmichi as code owners September 1, 2022 17:43

SkymanOne added 2 commits September 1, 2022 19:20

display json for instantiate function and fix typos

9888ca9

renaming contract_hash to contract for consistency

0d73ba7

SkymanOne added 3 commits September 2, 2022 13:38

Merge branch 'master' into gn-json-outputs

17223df

serialise storage deposit changes

fd5f08b

printing error jsons for InstantiateCommand & fmt

22b6443

SkymanOne added enhancement New feature or request blocked This task is blocked until blockers are resolved. and removed blocked This task is blocked until blockers are resolved. labels Sep 2, 2022

json formatting generic errors

442455e

Update CHANGELOG.md

ddda9f0

ascjones reviewed Sep 5, 2022

View reviewed changes

crates/cargo-contract/src/cmd/extrinsics/events.rs Outdated Show resolved Hide resolved

crates/cargo-contract/src/cmd/extrinsics/events.rs Outdated Show resolved Hide resolved

crates/cargo-contract/src/cmd/extrinsics/events.rs Outdated Show resolved Hide resolved

code refactoring

f3929fc

SkymanOne requested a review from ascjones September 5, 2022 15:14

SkymanOne added 2 commits September 5, 2022 16:55

explicit default initialisation of fields

9fb4896

cargo fmt

3fb01b0

ascjones reviewed Sep 5, 2022

View reviewed changes

set correct verbosity flags

c93516d

SkymanOne requested a review from ascjones September 6, 2022 12:30

ascjones reviewed Sep 7, 2022

View reviewed changes

ascjones mentioned this pull request Sep 7, 2022

Suggested refactorings for PR #722 (--output-json) #730

Merged

ascjones and others added 2 commits September 7, 2022 17:57

Suggested refactorings for PR #722 (--output-json) (#730)

59fb254

* Convert subxt error to custom ErrorVariant * Refactor displaying of extrinsic result events

dispalying extrinsic errors, refactoring

3d7224f

SkymanOne requested a review from ascjones September 7, 2022 19:35

ascjones reviewed Sep 8, 2022

View reviewed changes

json output for upload command

1706222

SkymanOne requested a review from ascjones September 9, 2022 11:06

SkymanOne added 3 commits September 9, 2022 12:51

wrapper for generic errors at top level

e9ff06c

cargo fmt

21ff2d4

skip serializing for hex bytes

581ff8e

ascjones reviewed Sep 9, 2022

View reviewed changes

ascjones mentioned this pull request Sep 9, 2022

Suggested unification of error handling for #722 #736

Merged

SkymanOne and others added 3 commits September 12, 2022 13:20

gitignore vscode folder

bd195ae

Suggested unification of error handling for #722 (#736)

cb80e0a

* Move extrinsics error to its own file, update instantiate * Update upload to unify errors * Update call to unify errors * Handle json errors at the top level

refactoring Andrew changes

e242f13

SkymanOne changed the title ~~Add --output-json for call and instantiate commands~~ Add --output-json for call, instantiate & upload commands Sep 12, 2022

SkymanOne requested a review from ascjones September 12, 2022 13:39

ascjones approved these changes Sep 12, 2022

View reviewed changes

SkymanOne merged commit 8ca0b03 into master Sep 12, 2022

SkymanOne deleted the gn-json-outputs branch September 12, 2022 14:10

ascjones mentioned this pull request Sep 21, 2022

Release v2.0.0-alpha.3 #753

Merged

ascjones mentioned this pull request Feb 10, 2023

Pretty-print call dry-run return data #967

Merged

Conversation

SkymanOne commented Sep 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Examples

Calling a contract with arg

Calling a contract with --dry-run flag

Instantiating contract

Instantiating a contract with dry-run

Updates

Uh oh!

SkymanOne commented Sep 1, 2022

Uh oh!

cmichi commented Sep 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SkymanOne commented Sep 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Update

Example

P.S.

Uh oh!

SkymanOne commented Sep 2, 2022

Update

ModuleError

GenericError

Uh oh!

ascjones left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ascjones Sep 8, 2022

Choose a reason for hiding this comment

Uh oh!

SkymanOne Sep 9, 2022

Choose a reason for hiding this comment

Uh oh!

ascjones Sep 9, 2022

Choose a reason for hiding this comment

Uh oh!

SkymanOne Sep 9, 2022

Choose a reason for hiding this comment

Uh oh!

ascjones Sep 9, 2022

Choose a reason for hiding this comment

Uh oh!

ascjones left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SkymanOne commented Sep 1, 2022 •

edited

Loading

Calling a contract with `--dry-run` flag

cmichi commented Sep 2, 2022 •

edited

Loading

SkymanOne commented Sep 2, 2022 •

edited

Loading

`ModuleError`

`GenericError`