Updated documentation

Signed-off-by: artem.ivanov <[email protected]>

Author: Artemkaaas

cli/src/commands/ledger.rs

@@ -44,7 +44,7 @@ pub mod nym_command {
                 .add_optional_param("verkey", "Verification key of new identity")
                 .add_optional_param("role", "Role of identity. One of: STEWARD, TRUSTEE, TRUST_ANCHOR, TGB or empty in case of blacklisting NYM")
                 .add_optional_param("fees_inputs","The list of source inputs")
-                .add_optional_param("fees_outputs","The list of outputs")
+                .add_optional_param("fees_outputs","The list of outputs in the following format: (recipient, amount, Optional<extra>)")
                 .add_example("ledger nym did=VsKV7grR1BUE29mG2Fm2kX")
                 .add_example("ledger nym did=VsKV7grR1BUE29mG2Fm2kX verkey=GjZWsBLgZCR18aL468JAT7w9CZRiBnpxUPPgyQxh4voa")
                 .add_example("ledger nym did=VsKV7grR1BUE29mG2Fm2kX role=TRUSTEE")
@@ -156,7 +156,7 @@ pub mod attrib_command {
                 .add_optional_param("raw", "JSON representation of attribute data")
                 .add_optional_param("enc", "Encrypted attribute data")
                 .add_optional_param("fees_inputs","The list of source inputs")
-                .add_optional_param("fees_outputs","The list of outputs")
+                .add_optional_param("fees_outputs","The list of outputs in the following format: (recipient, amount, Optional<extra>)")
                 .add_example(r#"ledger attrib did=VsKV7grR1BUE29mG2Fm2kX raw={"endpoint":{"ha":"127.0.0.1:5555"}}"#)
                 .add_example(r#"ledger attrib did=VsKV7grR1BUE29mG2Fm2kX hash=83d907821df1c87db829e96569a11f6fc2e7880acba5e43d07ab786959e13bd3"#)
                 .add_example(r#"ledger attrib did=VsKV7grR1BUE29mG2Fm2kX enc=aa3f41f619aa7e5e6b6d0d"#)
@@ -269,7 +269,7 @@ pub mod schema_command {
                 .add_required_param("version", "Schema version")
                 .add_required_param("attr_names", "Schema attributes split by comma")
                 .add_optional_param("fees_inputs","The list of source inputs")
-                .add_optional_param("fees_outputs","The list of outputs")
+                .add_optional_param("fees_outputs","The list of outputs in the following format: (recipient, amount, Optional<extra>)")
                 .add_example("ledger schema name=gvt version=1.0 attr_names=name,age")
                 .add_example("ledger schema name=gvt version=1.0 attr_names=name,age fees_inputs=txo:sov:111_rBuQo2A1sc9jrJg fees_outputs=(pay:sov:FYmoFw55GeQH7SRFa37dkx1d2dZ3zUF8ckg7wmL7ofN4,100)")
                 .finalize()
@@ -431,7 +431,7 @@ pub mod cred_def_command {
                 .add_required_param("primary", "Primary key in json format")
                 .add_optional_param("revocation", "Revocation key in json format")
                 .add_optional_param("fees_inputs","The list of source inputs")
-                .add_optional_param("fees_outputs","The list of outputs")
+                .add_optional_param("fees_outputs","The list of outputs in the following format: (recipient, amount, Optional<extra>)")
                 .add_example(r#"ledger cred-def schema_id=1 signature_type=CL primary={"n":"1","s":"2","rms":"3","r":{"age":"4","name":"5"},"rctxt":"6","z":"7"}"#)
                 .finalize()
     );
@@ -901,7 +901,7 @@ pub mod payment_command {
 
     command!(CommandMetadata::build("payment", "Send request for doing payment.")
                 .add_required_param("inputs","The list of payment sources")
-                .add_required_param("outputs","The list of outputs")
+                .add_required_param("outputs","The list of outputs in the following format: (recipient, amount, Optional<extra>)")
                 .add_example("ledger payment inputs=txo:sov:111_rBuQo2A1sc9jrJg outputs=(pay:sov:FYmoFw55GeQH7SRFa37dkx1d2dZ3zUF8ckg7wmL7ofN4,100,extradata)")
                 .add_example("ledger payment inputs=txo:sov:111_rBuQo2A1sc9jrJg,txo:sov:222_aEwACvA1sc9jrJg outputs=(pay:sov:FYmoFw55GeQH7SRFa37dkx1d2dZ3zUF8ckg7wmL7ofN4,100,extradata),(pay:sov:ABABefwrhscbaAShva7dkx1d2dZ3zUF8ckg7wmL7ofN4,5)")
                 .finalize()
@@ -1005,7 +1005,7 @@ pub mod mint_prepare_command {
     use super::*;
 
     command!(CommandMetadata::build("mint-prepare", "Prepare MINT transaction.")
-                .add_required_param("outputs","The list of outputs")
+                .add_required_param("outputs","The list of outputs in the following format: (recipient, amount, Optional<extra>)")
                 .add_example("ledger mint-prepare outputs=(pay:sov:FYmoFw55GeQH7SRFa37dkx1d2dZ3zUF8ckg7wmL7ofN4,100,extradata)")
                 .add_example("ledger mint-prepare outputs=(pay:sov:FYmoFw55GeQH7SRFa37dkx1d2dZ3zUF8ckg7wmL7ofN4,100,extradata),(pay:sov:ABABaaVwSascbaAShva7dkx1d2dZ3zUF8ckg7wmL7ofN4,5)")
                 .finalize()

doc/design/001-cli/README.md

@@ -235,7 +235,7 @@ indy> ledger <subcommand>
 #### NYM transaction
 Send NYM transaction
 ```
-ledger nym did=<did-value> [verkey=<verkey-value>] [role=<role-value>] [fees_inputs=<utxo-1,..,utxo-n>] [fees_outputs=(<pay-addr-1>,<amount>,<extra>),..,(<pay-addr-n>,<amount>,<extra>)]
+ledger nym did=<did-value> [verkey=<verkey-value>] [role=<role-value>] [fees_inputs=<source-1,..,source-n>] [fees_outputs=(<recipient-1>,<amount>,<extra>),..,(<recipient-n>,<amount>,<extra>)]
 ```
 
 #### GET_NYM transaction
@@ -247,7 +247,7 @@ ledger get-nym did=<did-value>
 #### ATTRIB transaction
 Send ATTRIB transaction
 ```
-ledger attrib did=<did-value> [hash=<hash-value>] [raw=<raw-value>] [enc=<enc-value>]  [fees_inputs=<utxo-1,..,utxo-n>] [fees_outputs=(<pay-addr-1>,<amount>,<extra>),..,(<pay-addr-n>,<amount>,<extra>)]
+ledger attrib did=<did-value> [hash=<hash-value>] [raw=<raw-value>] [enc=<enc-value>]  [fees_inputs=<source-1,..,source-n>] [fees_outputs=(<recipient-1>,<amount>,<extra>),..,(<recipient-n>,<amount>,<extra>)]
 ```
 
 #### GET_ATTRIB transaction
@@ -259,7 +259,7 @@ ledger get-attrib did=<did-value> [raw=<raw-value>] [hash=<hash-value>] [enc=<en
 #### SCHEMA transaction
 Send SCHEMA transaction
 ```
-ledger schema name=<name-value> version=<version-value> attr_names=<attr_names-value>  [fees_inputs=<utxo-1,..,utxo-n>] [fees_outputs=(<pay-addr-1>,<amount>,<extra>),..,(<pay-addr-n>,<amount>,<extra>)]
+ledger schema name=<name-value> version=<version-value> attr_names=<attr_names-value>  [fees_inputs=<source-1,..,source-n>] [fees_outputs=(<recipient-1>,<amount>,<extra>),..,(<recipient-n>,<amount>,<extra>)]
 ```
 
 #### GET_SCHEMA transaction
@@ -270,7 +270,7 @@ ledger get-schema did=<did-value> name=<name-value> version=<version-value>
 #### CRED_DEF transaction
 Send CRED_DEF transaction
 ```
-ledger cred-def schema_id=<schema_id-value> signature_type=<signature_type-value> [tag=<tag>] primary=<primary-value> [revocation=<revocation-value>]  [fees_inputs=<utxo-1,..,utxo-n>] [fees_outputs=(<pay-addr-1>,<amount>,<extra>),..,(<pay-addr-n>,<amount>,<extra>)]
+ledger cred-def schema_id=<schema_id-value> signature_type=<signature_type-value> [tag=<tag>] primary=<primary-value> [revocation=<revocation-value>]  [fees_inputs=<source-1,..,source-n>] [fees_outputs=(<recipient-1>,<amount>,<extra>),..,(<recipient-n>,<amount>,<extra>)]
 ```
 
 #### GET_CRED_DEF transaction
@@ -315,16 +315,16 @@ Send custom transaction with user defined json body and optional signature
 ledger custom [txn=]<txn-json-value> [sign=<true|false>]
 ```
 
-#### GET_UTXO transaction
-Send GET_UTXO transaction
+#### GET_SOURCES transaction
+Send GET_SOURCES transaction
 ```
-ledger get-utxo payment_address=<payment_address>
+ledger get-sources payment_address=<payment_address>
 ```
 
 #### PAYMENT transaction
 Send PAYMENT transaction
 ```
-ledger payment inputs=<utxo-1>,..,<utxo-n> outputs=(<pay-addr-1>,<amount>,<extra>),..,(<pay-addr-n>,<amount>,<extra>)
+ledger payment inputs=<source-1>,..,<source-n> outputs=(<recipient-1>,<amount>,<extra>),..,(<recipient-n>,<amount>,<extra>)
 ```
 
 #### GET_FEES transaction