Sign & verify data with a Cardano Secret/Public-Key
Sign & verify CIP-8, CIP-30 & CIP-36 data (Catalyst)
Generate Cardano-Keys from Mnemonics and Derivation-Paths
Canonize, Hash & Sign Governance Metadata CIP-100/108/119
Â
- Sign any hexdata, textdata or binaryfile with a provided normal or extended secret key. The key can be provided in hex, bech or file format. The signing output is a signature in hex- or json-format, also the public key of the provided secret key for verification. With the enabled
--jcliflag the generated signature and public key will be return in a jcli compatible bech format. Cardano-signer can be used instead of jcli for signing. - Sign payloads in CIP-8 / CIP-30 mode, hashed or not hashed, with or without a payload in the output. The signing output is a COSE_Sign1 signature in hex format and also the public key of the provided secret key for verification. The output can also be set to be in json format which will also show additional data (--json-extended).
- Generate and sign Catalyst registration/delegation/deregistration metadata in CIP-36 mode. This also includes relatively weighted voting power delegation. The output is the registration/delegation or deregistraton data in json or cborHex-format and/or a binary cbor file, which can be transmitted on chain as it is.
- Generate Cardano Keys like .skey/.vkey files and hex-keys from derivation paths, with or without mnemonic words.
- Generate conway dRep Keys, Constitutional Commitee Member Cold/Hot Keys with or without mnemonic words.
- Canonized & Hash CIP-100/108/119 governance metadata jsonld data
- Sign CIP-100/108/119 governacne metadata by adding an authors signature to the document
- Generate CIP-36 voting-keys.
- A given address will automatically be checked against the used publicKey.
- Verify a signature for any hexdata, textdata or binaryfile together with a provided public key. Also an optional address can be verified against the given public key. The key can be provided in hex, bech or file format. The verification output is true(exitcode=0) or false(exitcode=1) as a console output or in json-format.
- The signature can be provided in hex format or also in bech encoded
ed25519_sigformat. Cardano-signer can be used instead of jcli for verification. - Verify CIP-8 / CIP-30 COSE_Sign1/COSE_Key data. With hashed or non-hashed payloads. There is also a detailed check on the COSE_Sign1 and COSE_Key data structure included. Verification can be done on the COSE_Sign1 + COSE_Key, or COSE_Sign1 + COSE_Key + payload and/or address.
- Verify CIP-100/108/119 metadata JSONLD files
Â
- Default mode: Sign and verify data with ed25519(cardano) keys
- CIP-8 / CIP-30 mode: COSE_Sign1 signature & COSE_Key publicKey generation/verification
- CIP-36 mode: Generate Catalyst metadata for registration/delegation and also deregistration
- KeyGeneration mode: Generate Cardano keys from mnemonics and derivation-paths
- CIP-100 / CIP-108 / CIP-119 mode: Sign, Verify and Canonize governance metadata Â
$ cardano-signer help
cardano-signer 1.19.0
Sign a hex/text-string or a binary-file:
Syntax: cardano-signer sign
Params: --data-hex "<hex>" | --data "<text>" | --data-file "<path_to_file>"
data/payload/file to sign in hex-, text- or binary-file-format
--secret-key "<path_to_file>|<hex>|<bech>" path to a signing-key-file or a direct signing hex/bech-key string
[--address "<path_to_file>|<hex>|<bech>"] optional address check against the signing-key (address-file or a direct bech/hex format)
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--jcli | --bech] optional flag to generate signature & publicKey in jcli compatible bech-format
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "signature + publicKey" or JSON-Format default: hex-format
Sign a payload in CIP-8 / CIP-30 mode: (COSE_Sign1 only currently)
Syntax: cardano-signer sign --cip8
cardano-signer sign --cip30
Params: --data-hex "<hex>" | --data "<text>" | --data-file "<path_to_file>"
data/payload/file to sign in hex-, text- or binary-file-format
--secret-key "<path_to_file>|<hex>|<bech>" path to a signing-key-file or a direct signing hex/bech-key string
--address "<path_to_file>|<hex>|<bech>" path to an address-file or a direct bech/hex format 'stake1..., stake_test1..., addr1...'
[--nohashcheck] optional flag to not perform a check that the public-key belongs to the address/hash
[--hashed] optional flag to hash the payload given via the 'data' parameters
[--nopayload] optional flag to exclude the payload from the COSE_Sign1 signature, default: included
[--testnet-magic [xxx]] optional flag to switch the address check to testnet-addresses, default: mainnet
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "COSE_Sign1 + COSE_Key" or JSON-Format
Sign a catalyst registration/delegation or deregistration in CIP-36 mode:
Syntax: cardano-signer sign --cip36
Params: [--vote-public-key "<path_to_file>|<hex>|<bech>" public-key-file(s) or public hex/bech-key string(s) to delegate the votingpower to (single or multiple)
--vote-weight <unsigned_int>] relative weight of each delegated votingpower, default: 100% for a single delegation
--secret-key "<path_to_file>|<hex>|<bech>" signing-key-file or a direct signing hex/bech-key string of the stake key (votingpower)
--payment-address "<path_to_file>|<hex>|<bech>" rewards payout address (address-file or a direct bech/hex format 'addr1..., addr_test1...')
[--nonce <unsigned_int>] optional nonce value, if not provided the mainnet-slotHeight calculated from current machine-time will be used
[--vote-purpose <unsigned_int>] optional parameter (unsigned int), default: 0 (catalyst)
[--deregister] optional flag to generate a deregistration (no --vote-public-key/--vote-weight/--payment-address needed
[--testnet-magic [xxx]] optional flag to switch the address check to testnet-addresses, default: mainnet
[--json | --json-extended] optional flag to generate output in json/json-extended format, default: cborHex(text)
[--out-file "<path_to_file>"] path to an output file, default: standard-output
[--out-cbor "<path_to_file>"] path to write a binary metadata.cbor file to
Output: Registration-Metadata in JSON-, cborHex-, cborBinary-Format
Sign a governance JSON-LD metadata file with a Secret-Key (add authors):
Syntax: cardano-signer sign --cip100
Params: --data "<jsonld-text>" | --data-file "<path_to_jsonld_file>"
data or file in jsonld format to verify
--secret-key "<path_to_file>|<hex>|<bech>" path to a signing-key-file or a direct signing hex/bech-key string
--author-name "<name-of-signing-author>" name of the signing author f.e. "John Doe"
[--replace] optional flag to replace the authors entry with the same public-key
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "Signed JSON-LD Content" or "JSON-HashInfo if --out-file is used"
Verify a hex/text-string or a binary-file via signature + publicKey:
Syntax: cardano-signer verify
Params: --data-hex "<hex>" | --data "<text>" | --data-file "<path_to_file>"
data/payload/file to verify in hex-, text- or binary-file-format
--signature "<hex>|<bech>" signature in hex- or bech-format
--public-key "<path_to_file>|<hex>|<bech>" path to a public-key-file or a direct public hex/bech-key string
[--address "<path_to_file>|<hex>|<bech>"] optional address check against the public-key (address-file or a direct bech/hex format)
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "true/false" (exitcode 0/1) or JSON-Format
Verify a CIP-8 / CIP-30 payload: (COSE_Sign1 only currently)
Syntax: cardano-signer verify --cip8
cardano-signer verify --cip30
Params: --cose-sign1 "<hex>" COSE_Sign1 signature in cbor-hex-format
--cose-key "<hex>" COSE_Key containing the public-key in cbor-hex-format
[--data-hex "<hex>" | --data "<text>" | --data-file "<path_to_file>"]
optional data/payload/file if not present in the COSE_Sign1 signature
[--address "<path_to_file>|<hex>|<bech>"] optional signing-address to do the verification with
[--nohashcheck] optional flag to not perform a check that the public-key belongs to the address/hash
[--hashed] optional flag to hash the payload given via the 'data' parameters
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "true/false" (exitcode 0/1) or JSON-Format
Verify Signatures in CIP-100 governance JSON-LD metadata:
Syntax: cardano-signer verify --cip100
Params: --data "<jsonld-text>" | --data-file "<path_to_jsonld_file>"
data or file in jsonld format to verify
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "true/false" or JSON-Format
Generate Cardano ed25519/ed25519-extended keys:
Syntax: cardano-signer keygen
Params: [--path "<derivationpath>"] optional derivation path in the format like "1852H/1815H/0H/0/0" or "1852'/1815'/0'/0/0"
or predefined names: --path payment, --path stake, --path cip36, --path drep, --path cc-cold, --path cc-hot
[--mnemonics "word1 word2 ... word24"] optional mnemonic words to derive the key from (separate via space)
[--cip36] optional flag to generate CIP36 conform vote keys (also using path 1694H/1815H/0H/0/0)
[--vote-purpose <unsigned_int>] optional vote-purpose (unsigned int) together with --cip36 flag, default: 0 (Catalyst)
[--vkey-extended] optional flag to generate a 64byte publicKey with chain code
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--out-file "<path_to_file>"] path to an output file, default: standard-output
[--out-skey "<path_to_skey_file>"] path to an output skey-file
[--out-vkey "<path_to_vkey_file>"] path to an output vkey-file
Output: "secretKey + publicKey" or JSON-Format default: hex-format
Canonize&Hash the governance JSON-LD body metadata for author-signatures: (CIP-100)
Syntax: cardano-signer canonize --cip100
Params: --data "<jsonld-text>" | --data-file "<path_to_jsonld_file>"
data or file in jsonld format to canonize and hash
[--json | --json-extended] optional flag to generate output in json/json-extended format
[--out-canonized "<path_to_file>"] path to an output file for the canonized data
[--out-file "<path_to_file>"] path to an output file, default: standard-output
Output: "HASH of canonized body" or JSON-Format NOTE: This is NOT the anchor-url-hash!!!
cardano-signer sign --data "this is a test payload :-)" \
--secret-key test.skeyOutput - Signature & publicKey (hex) :
8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08 57758911253f6b31df2a87c10eb08a2c9b8450768cb8dd0d378d93f7c2e220f0
You can generate a nice json output via the --json flag
cardano-signer sign --data "this is a test payload :-)" \
--secret-key test.skey \
--json{
"signature": "8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08",
"publicKey": "57758911253f6b31df2a87c10eb08a2c9b8450768cb8dd0d378d93f7c2e220f0"
}You can generate a more detailed json output via the --json-extended flag
cardano-signer sign --data "this is a test payload :-)" \
--secret-key test.skey \
--json-extended{
"workMode": "sign",
"signDataHex": "7468697320697320612074657374207061796c6f6164203a2d29",
"signature": "8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08",
"secretKey": "e8ddb1cfc09e163915e6c28fcb5fbb563bfef57201857e15288b67abbd91e4441e5fa179a8f90da1684ba5aa310da521651d2ce20443f149f8ca9e333a96dabc",
"publicKey": "57758911253f6b31df2a87c10eb08a2c9b8450768cb8dd0d378d93f7c2e220f0"
}You can also do an optional address check, if the address belongs to the key.
cardano-signer sign --data "this is a test payload :-)" \
--secret-key dummy.skey \
--json-extended \
--address "addr1v9ux8dwy800s5pnq327g9uzh8f2fw98ldytxqaxumh3e8kqumfr6d"If the address is wrong you will get an error like:
Error: The address 'addr1v9ux8dwy800s5pnq327g9uzh8f2fw98ldytxqaxumh3e8kqumfr6d' does not belong to the provided secret key.
If the address is correct, cardano-signer outputs like normal. In case of the detailed json output it also includes the address infos.
{
"workMode": "sign",
"signDataHex": "7468697320697320612074657374207061796c6f6164203a2d29",
"addressHex": "617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8",
"addressType": "payment enterprise",
"addressNetwork": "mainnet",
"signature": "c60aae4701b49d0b5276b703e72b1a310d6df45b6671bcc08eb06ae9640584577d5d7bb14429bbc855a6382a40412a27f8d5c794220e26cea7404f1cfb0e5d0b",
"secretKey": "16275bd6647f94a53e9fe1c71439a258a03c13cadf32935ed5388972ebd7e53f",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9"
}đź’ˇ For verification, check out the Examples below too!
cardano-signer sign \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--secret-key "c14ef0cc5e352446d6243976f51e8ffb2ae257f2a547c4fba170964a76501e7a"Output - Signature & publicKey (hex) :
ca3ddc10f845dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03 9be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27
You can also write out to a file of course.
cardano-signer sign \
--out-file mySignature.txt \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--secret-key "c14ef0cc5e352446d6243976f51e8ffb2ae257f2a547c4fba170964a76501e7a"No visible output was generated to the stdout, but Signature+publicKey was written to the file mySignature.txt
Here are two examples for invalid input secret keys:
cardano-signer sign \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--secret-key "c14ef0cc5e352446d6243976f51e8ffb2ae257f2a547c4fba170964a"Error: Invalid normal secret key
cardano-signer sign \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--secret-key "c14ef0cc5e352446d6243976f51e8ffb2ae257f2a547c4fba170964a76501e7a88afe88fa8f888544e6f5a5f555e5faf6f6f"Error: Invalid extended secret key
cardano-signer sign \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--secret-key owner.staking.skeyOutput - Signature & publicKey (hex) :
ca3ddc10f845dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03 9be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27
cardano-signer sign \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--secret-key owner.staking.vkey
Error: The file 'owner.staking.vkey' is not a signing/secret key jsoncardano-signer sign --data-file test.txt --secret-key test.skeyOutput - Signature & publicKey (hex) :
caacb18c46319f55b932efa77357f14b66b27aa908750df2c91800dc59711015ea2e568974ac0bcabf9b1c4708b877c2b94a7658c2dcad78b108049062572e09 57758911253f6b31df2a87c10eb08a2c9b8450768cb8dd0d378d93f7c2e220f0
cardano-signer verify --data "this is a test payload :-)" \
--public-key test.vkey \
--signature "8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08"The output is plaintext (without any flag) and will be simply true if there is a match, or false if there is a mismatch. Cardano-signer also exits with an exitcode=0 (no error) in case of a match, or with exitcode=1 in case any error or mismatch occured.
true
You can generate a json output via the --json flag too.
cardano-signer verify --data "this is a test payload :-)" \
--public-key test.vkey \
--signature "8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08" \
--json{
"result": "true"
}Or a more detailed json output via the --json-extended flag.
cardano-signer verify --data "this is a test payload :-)" \
--public-key test.vkey \
--signature "8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08" \
--json-extended{
"workMode": "verify",
"result": "true",
"verifyDataHex": "7468697320697320612074657374207061796c6f6164203a2d29",
"signature": "8a5fd6602094407b7e5923aa0f2694f8cb5cf39f317a61059fdc572e24fc1c7660d23c04d46355aed78b5ec35ae8cad1433e7367bb874390dfe46ed155727a08",
"publicKey": "57758911253f6b31df2a87c10eb08a2c9b8450768cb8dd0d378d93f7c2e220f0"
}You can also do an optional address check, if the address belongs to the provided public key by adding the address with parameter --address:
cardano-signer verify --data "this is a test payload :-)" \
--public-key dummy.vkey \
--signature "c60aae4701b49d0b5276b703e72b1a310d6df45b6671bcc08eb06ae9640584577d5d7bb14429bbc855a6382a40412a27f8d5c794220e26cea7404f1cfb0e5d0b" \
--address "addr1v9ux8dwy800s5pnq327g9uzh8f2fw98ldytxqaxumh3e8kqumfr6d"Error: The address 'addr1v9ux8dwy800s5pnq327g9uzh8f2fw98ldytxqaxumh3e8kqumfr6d' does not belong to the provided public key.
And if the address matched, cardano-signer will just generate a normal output. If you have set it to --json-extended it also includes the address infos like:
{
"workMode": "verify",
"result": "true",
"verifyDataHex": "7468697320697320612074657374207061796c6f6164203a2d29",
"addressHex": "617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8",
"addressType": "payment enterprise",
"addressNetwork": "mainnet",
"signature": "c60aae4701b49d0b5276b703e72b1a310d6df45b6671bcc08eb06ae9640584577d5d7bb14429bbc855a6382a40412a27f8d5c794220e26cea7404f1cfb0e5d0b",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9"
}cardano-signer verify \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--signature "ca3ddc10f845dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03" \
--public-key "9be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27"The output is plaintext and will be simply true if there is a match, or false if there is a mismatch. Cardano-signer also exits with an exitcode=0 (no error) in case of a match, or with exitcode=1 in case any error or mismatch occured.
true
cardano-signer verify \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--signature "ca3ddc10f845dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03" \
--public-key "aaaaaaaaaab3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27"false
cardano-signer verify \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--signature "aaaaaaaaaa45dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03" \
--public-key "9be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27" \
--json{
"result": "false"
}cardano-signer verify \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--signature "ca3ddc10f845dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03" \
--public-key owner.staking.vkeytrue
cardano-signer verify \
--data-hex "8f21b675423a65244483506122492f5720d7bd35d70616348089678ed4eb07a9" \
--signature "ca3ddc10f845dbe0c22875aaf91f66323d3f28e265696dcd3c56b91a8e675c9e30fd86ba69b9d1cf271a12f7710c9f3385c78cbf016e17e1df339bea8bd2db03" \
--public-key owner.staking.skeyYou will also get errors if the provided key is not a public-key for example
Error: The file 'owner.staking.skey' is not a verification/public key json
cardano-signer verify --data-file test.txt --public-key test.vkey \
--signature "caacb18c46319f55b932efa77357f14b66b27aa908750df2c91800dc59711015ea2e568974ac0bcabf9b1c4708b877c2b94a7658c2dcad78b108049062572e09"true
Â
Â
cardano-signer sign --cip8 \
--data "Hello world" \
--secret-key dummy.skey \
--address dummy.addrOutput - COSE_Sign1 Signature & COSE_Key publicKey (hex):
84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001 a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9
Or with the more detailed json output which includes many useful and extra information like the signedMessage string:
cardano-signer sign --cip8 \
--data "Hello world" \
--secret-key dummy.skey \
--address dummy.addr \
--json-extended{
"workMode": "sign-cip8",
"addressHex": "617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8",
"addressType": "payment enterprise",
"addressNetwork": "mainnet",
"inputDataHex": "48656c6c6f20776f726c64",
"isHashed": "false",
"signDataHex": "846a5369676e617475726531582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8404b48656c6c6f20776f726c64",
"signature": "fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001",
"secretKey": "16275bd6647f94a53e9fe1c71439a258a03c13cadf32935ed5388972ebd7e53f",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9",
"output": {
"signedMessage": "cms_hFgqogEnZ2FkZHJlc3NYHWF4Y7XEO98KBmCKvILwVzpUlxT_aRZgdNzd45PYoWZoYXNoZWT0S0hlbGxvIHdvcmxkWED8WBVfDO4FvADnKZrx3x8VmsgqRqBVeGsllleTTv80buyBNJ1GeM6rx58hPGaivb_U6l2evcYwvuWsnM51z8ABZWrr1w",
"COSE_Sign1_hex": "84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001",
"COSE_Key_hex": "a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9"
}
}If you wanna hash the payload, add the --hashed flag:
cardano-signer sign --cip8 \
--data "Hello world" \
--secret-key dummy.skey \
--address dummy.addr \
--hashed \
--json-extendedIf you wanna exclude the payload itself from the COSE_Sign1 output, add the --nopayload flag:
cardano-signer sign --cip8 \
--data "Hello world" \
--secret-key dummy.skey \
--address dummy.addr \
--nopayload \
--json-extendedThis will not include the payload in the COSE_Sign1 signature, useful if all involved entities know the payload.
COSE_Sign1 cbor:
84 # array(4)
58 2a # bytes(42)
a201276761646472657373581d617863 # "\xa2\x01\'gaddressX\x1daxc"
b5c43bdf0a06608abc82f0573a549714 # "\xb5\xc4;\xdf\n\x06`\x8a\xbc\x82\xf0W:T\x97\x14"
ff69166074dcdde393d8 # "\xffi\x16`t\xdc\xdd\xe3\x93\xd8"
a1 # map(1)
66 # text(6)
686173686564 # "hashed"
f4 # false, simple(20)
f6 # null, simple(22)
58 40 # bytes(64)
fc58155f0cee05bc00e7299af1df1f15 # "\xfcX\x15_\x0c\xee\x05\xbc\x00\xe7)\x9a\xf1\xdf\x1f\x15"
9ac82a46a055786b259657934eff346e # "\x9a\xc8*F\xa0Uxk%\x96W\x93N\xff4n"
ec81349d4678ceabc79f213c66a2bdbf # "\xec\x814\x9dFx\xce\xab\xc7\x9f!<f\xa2\xbd\xbf"
d4ea5d9ebdc630bee5ac9cce75cfc001 # "\xd4\xea]\x9e\xbd\xc60\xbe\xe5\xac\x9c\xceu\xcf\xc0\x01"
cardano-signer sign --cip8 \
--address "stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p" \
--data-hex "7b2263686f696365223a22596573222c22636f6d6d656e74223a22222c226e6574776f726b223a2270726576696577222c2270726f706f73616c223a2232303338633431376431313265303035656636316339356437313065653632313834613663313737643138623264613839316639376365666165346638353335222c2270726f746f636f6c223a2253756e64616553776170222c227469746c65223a22546573742050726f706f73616c202d2054616d7065726564222c2276657273696f6e223a2231222c22766f7465644174223a2233313337323237222c22766f746572223a227374616b655f7465737431757174336e7161707a373939747670326c7438616474747432396b36786132786e6c7461686e363535747534736763366173617167227d" \
--secret-key staking.skey \
--testnet-magic 1 \
--jsonOutput - COSE_Sign1 Signature & COSE_Key publicKey (hex):
{
"COSE_Sign1_hex": "84582aa201276761646472657373581de0c13582aec9a44fcc6d984be003c5058c660e1d2ff1370fd8b49ba73fa166686173686564f45901277b2263686f696365223a22596573222c22636f6d6d656e74223a22222c226e6574776f726b223a2270726576696577222c2270726f706f73616c223a2232303338633431376431313265303035656636316339356437313065653632313834613663313737643138623264613839316639376365666165346638353335222c2270726f746f636f6c223a2253756e64616553776170222c227469746c65223a22546573742050726f706f73616c202d2054616d7065726564222c2276657273696f6e223a2231222c22766f7465644174223a2233313337323237222c22766f746572223a227374616b655f7465737431757174336e7161707a373939747670326c7438616474747432396b36786132786e6c7461686e363535747534736763366173617167227d5840c2ffc4650e21376297f42040028382406bf888c09f35a74324e80a531cc6359a6d2acc9a6e4c58c664463a25889de37d2f54422ae20a259db6fed37b86d05202",
"COSE_Key_hex": "a40101032720062158209be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27"
}
Lets use the signed data from the first signing example for the verification.
COSE_Sign1: 84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001
COSE_Key: a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9
To verify the COSE data with a detailed output run:
cardano-signer verify --cip8 \
--cose-sign1 84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001 \
--cose-key a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9 \
--json-extendedThis outputs the detailed json:
{
"workMode": "verify-cip8",
"result": "true",
"addressHex": "617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8",
"addressType": "payment enterprise",
"addressNetwork": "mainnet",
"payloadDataHex": "48656c6c6f20776f726c64",
"isHashed": "false",
"verifyDataHex": "846a5369676e617475726531582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8404b48656c6c6f20776f726c64",
"signature": "fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9"
}You see that the verification was successful, the used signing-address, and payload was not hashed.
If you wanna verify the COSE data against a given payload, simply add it as a --data parameter:
cardano-signer verify --cip8 \
--cose-sign1 84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001 \
--cose-key a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9 \
--data 'Not hello world' \
--json{
"result": "false"
}If you have a COSE_Sign1 without an included payload (like the signing example further above), you need to provide the payload data to do a successful verification. In the example the payload was 'Hello world' but was not included in the COSE_Sign1, so we add it.
cardano-signer verify --cip30 \
--cose-sign1 84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f4f65840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001 \
--cose-key a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9 \
--data 'Hello world' \
--json-extended{
"workMode": "verify-cip30",
"result": "true",
"addressHex": "617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8",
"addressType": "payment enterprise",
"addressNetwork": "mainnet",
"payloadDataHex": "48656c6c6f20776f726c64",
"isHashed": "false",
"verifyDataHex": "846a5369676e617475726531582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8404b48656c6c6f20776f726c64",
"signature": "fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9"
}The verification is successful.
To verify the address in the COSE data simply add the address via the --address parameter:
cardano-signer verify --cip8 \
--cose-sign1 84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001 \
--cose-key a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9 \
--address dummy.addr
--json{
"result": "true"
}If the address does not belong to the publicKey in the COSE_Key, there will be an error.
cardano-signer verify --cip8 \
--cose-sign1 84582aa201276761646472657373581d617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8a166686173686564f44b48656c6c6f20776f726c645840fc58155f0cee05bc00e7299af1df1f159ac82a46a055786b259657934eff346eec81349d4678ceabc79f213c66a2bdbfd4ea5d9ebdc630bee5ac9cce75cfc001 \
--cose-key a4010103272006215820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9 \
--address addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc
--jsonResults in an error:
Error: The given payment enterprise address 'addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc' does not belong to the public key in the COSE_Key.
Â
Â
cardano-signer sign --cip36 \
--payment-address "addr1v9ux8dwy800s5pnq327g9uzh8f2fw98ldytxqaxumh3e8kqumfr6d" \
--vote-public-key test.voting.vkey \
--secret-key myStakeKey.skey \
--jsonThe output in json format (Nonce automatically calculated from current machine time):
{
"61284": {
"1": [
[ "0x423fa841abf9f7fa8dfa10dacdb6737b27fdb0d9bcd9b95d48cabb53047ab769", 1 ]
],
"2": "0x9be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b27",
"3": "0x617863b5c43bdf0a06608abc82f0573a549714ff69166074dcdde393d8",
"4": 76763961,
"5": 0
},
"61285": {
"1": "0x9b3534eeedaea8300bad568be60363b9e2e829ab4249b0ba23f78738a7f952e84afd22a97b744a541c431cf8e9e0bb4a6f7431a2f752fa450b761bc0fa100b0a"
}
}If you write out the output to a file via the --out-file or --out-cbor parameter, you can directly attach it to a transaction as metadata to execute the registration/delegation on chain.
cardano-signer sign --cip36 \
--payment-address "addr1v9ux8dwy800s5pnq327g9uzh8f2fw98ldytxqaxumh3e8kqumfr6d" \
--vote-public-key test.voting.vkey \
--secret-key myStakeKey.skey \
--out-cbor myRegistration.cbor
#Sending example via the SPO-Scripts like:
01_sendLovelaces.sh wallet wallet min myRegistration.cborcardano-signer sign --cip36 \
--payment-address "addr_test1qrlvt2gzuvrhq7m2k00rsyzfrrqwx085cdqgum7w5nc2rxwpxkp2ajdyflxxmxztuqpu2pvvvc8p6tl3xu8a3dym5uls50mr97" \
--secret-key ../owner.staking.skey \
--vote-public-key somevote.vkey \
--nonce 71948552 \
--testnet-magic 1 \
--out-cbor catalyst-delegation.cborOutput (cbor-hex):
a219ef64a50181825820423fa841abf9f7fa8dfa10dacdb6737b27fdb0d9bcd9b95d48cabb53047ab769010258209be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b2703583900fec5a902e307707b6ab3de38104918c0e33cf4c3408e6fcea4f0a199c13582aec9a44fcc6d984be003c5058c660e1d2ff1370fd8b49ba73f041a0449d908050019ef65a101584000780582b60c651fa9d2cd3a8cb378561520e3c76ea398f1eb8f17b25084836488d1d75cf323a4b1fa7317099c2c87e411e8403a9f71349042b5723c7fbec807
cardano-signer sign --cip36 \
--payment-address "addr_test1qrlvt2gzuvrhq7m2k00rsyzfrrqwx085cdqgum7w5nc2rxwpxkp2ajdyflxxmxztuqpu2pvvvc8p6tl3xu8a3dym5uls50mr97" \
--secret-key ../owner.staking.skey \
--vote-public-key ../somevote.vkey \
--vote-weight 10 \
--vote-public-key "C2CD50D8A231FBC1444D65ABAB4F6BF74178E6DE64722558EEEF0B73DE293A8A" \
--vote-weight 20 \
--vote-public-key "ed25519_pk128c305nw9xh20kearuhcwj447kzlvxdfttkk6uwnrf6qfjm9276svd678w" \
--vote-weight 70 \
--nonce 71948552 \
--testnet-magic 1 \
--out-cbor catalyst-multidelegation.cborOutput (cbor-hex):
a219ef64a50183825820423fa841abf9f7fa8dfa10dacdb6737b27fdb0d9bcd9b95d48cabb53047ab7690a825820c2cd50d8a231fbc1444d65abab4f6bf74178e6de64722558eeef0b73de293a8a1482582051f117d26e29aea7db3d1f2f874ab5f585f619a95aed6d71d31a7404cb6557b518460258209be513df12b3fabe7c1b8c3f9fab0968eb2168d5689bf981c2f7c35b11718b2703583900fec5a902e307707b6ab3de38104918c0e33cf4c3408e6fcea4f0a199c13582aec9a44fcc6d984be003c5058c660e1d2ff1370fd8b49ba73f041a0449d908050019ef65a101584086600d0ebbf1e0f200fc9cc148464bcb2e55b893838d0f50b208148cf9d498523dd548423b25897e6e4ce9daa19a74766704a2581cea9441d92c9e25ea901208
Or with two voting-keys and votingpower 1 & 5 with a json-extended output
cardano-signer sign --cip36 \
--payment-address "addr_test1qrlvt2gzuvrhq7m2k00rsyzfrrqwx085cdqgum7w5nc2rxwpxkp2ajdyflxxmxztuqpu2pvvvc8p6tl3xu8a3dym5uls50mr97" \
--secret-key "f5beaeff7932a4164d270afde7716067582412e8977e67986cd9b456fc082e3a" \
--vote-public-key ../myvote.voting.pkey --vote-weight 1 \
--vote-public-key vote-test.vkey --vote-weight 5 \
--nonce 123456789 \
--testnet-magic 1 \
--json-extendedThe output is a way more detailed json format, it contains the raw cbor output in the .output.cbor key, and the human-readable format in the .output.json key:
{
"workMode": "sign-cip36",
"votePurpose": "Catalyst (0)",
"totalVoteWeight": 6,
"paymentAddressHex": "00fec5a902e307707b6ab3de38104918c0e33cf4c3408e6fcea4f0a199c13582aec9a44fcc6d984be003c5058c660e1d2ff1370fd8b49ba73f",
"paymentAddressType": "payment base",
"paymentAddressNetwork": "testnet",
"signDataHex": "1ebe4301d8db0af3c65682e8c9c70c0a22ecc474824d4688b6c24936b9d69fd4",
"signature": "c5e380e1282b54d6e2f9004e73c533c5e1b135b81076859ff606a16dde410f8375164fc4c4d6c11e43633228687580b5bab02b3181908715f74efdefd2e63902",
"secretKey": "f5beaeff7932a4164d270afde7716067582412e8977e67986cd9b456fc082e3a",
"publicKey": "86870efc99c453a873a16492ce87738ec79a0ebd064379a62e2c9cf4e119219e",
"output": {
"cbor": "a219ef64a5018282582051f117d26e29aea7db3d1f2f874ab5f585f619a95aed6d71d31a7404cb6557b501825820755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb90502582086870efc99c453a873a16492ce87738ec79a0ebd064379a62e2c9cf4e119219e03583900fec5a902e307707b6ab3de38104918c0e33cf4c3408e6fcea4f0a199c13582aec9a44fcc6d984be003c5058c660e1d2ff1370fd8b49ba73f041a075bcd15050019ef65a1015840c5e380e1282b54d6e2f9004e73c533c5e1b135b81076859ff606a16dde410f8375164fc4c4d6c11e43633228687580b5bab02b3181908715f74efdefd2e63902",
"json": {
"61284": {
"1": [
[
"0x51f117d26e29aea7db3d1f2f874ab5f585f619a95aed6d71d31a7404cb6557b5",
1
],
[
"0x755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9",
5
]
],
"2": "0x86870efc99c453a873a16492ce87738ec79a0ebd064379a62e2c9cf4e119219e",
"3": "0x00fec5a902e307707b6ab3de38104918c0e33cf4c3408e6fcea4f0a199c13582aec9a44fcc6d984be003c5058c660e1d2ff1370fd8b49ba73f",
"4": 123456789,
"5": 0
},
"61285": {
"1": "0xc5e380e1282b54d6e2f9004e73c533c5e1b135b81076859ff606a16dde410f8375164fc4c4d6c11e43633228687580b5bab02b3181908715f74efdefd2e63902"
}
}
}
}You can generate a deregistration metadata by using the --deregister flag. In that case no vote-key (vote-public-key) or rewards-address is needed as input. Just the secret-key and optionally a nonce and voting-chain-id.
cardano-signer sign --cip36 \
--deregister \
--secret-key myStakeKey.skey \
--jsonThe output is a human-readable json format, if you redirect it to a file via the --out-file parameter, you can directly use it as metadata in a transaction on the chain. Nonce (if not provided) its automatically calculated from current machine time.
{
"61286": {
"1": "0x57758911253f6b31df2a87c10eb08a2c9b8450768cb8dd0d378d93f7c2e220f0",
"2": 74858300,
"3": 0
},
"61285": {
"1": "0xc7bec561f2b80766f78c169ccb231865048e0ed7e9fb4f98f263d00e3e4a2e6126a18f70b303be63f8e01f46dd116be5c387495a7cec707d3ebc3e6be4d87008"
}
}Â
Â
cardano-signer keygenOutput - secretKey & publicKey (hex) :
1e0e5b1614ad54e170a43ce74fd53e29217ec4ba341d9ad52d97c30ba696bb9c 1d8f971d0b8553981c90e1b5d2884e8190b21f5547c2a784fc65c59cf022d4b2
You can generate a nice json output via the --json or --json-extended flag
cardano-signer keygen --json-extended{
"workMode": "keygen",
"secretKey": "629ebc4ca6ace67f7b427bf728b39aa5d7bb2f8851f88575d8cee8d112a0956c",
"publicKey": "f987631d2e136fc9905f8f7f27a8654a5f86834e118c2873d805f2573e41d0c2",
"output": {
"skey": {
"type": "PaymentSigningKeyShelley_ed25519",
"description": "Payment Signing Key",
"cborHex": "5820629ebc4ca6ace67f7b427bf728b39aa5d7bb2f8851f88575d8cee8d112a0956c"
},
"vkey": {
"type": "PaymentVerificationKeyShelley_ed25519",
"description": "Payment Verification Key",
"cborHex": "5820f987631d2e136fc9905f8f7f27a8654a5f86834e118c2873d805f2573e41d0c2"
}
}
}You can also directly generate .skey/.vkey files via the --out-skey & --out-vkey parameter
cardano-signer keygen --json-extended \
--out-skey test.skey \
--out-vkey test.vkeyThis generates the typical .skey/.vkey files with content like
{
"type": "PaymentSigningKeyShelley_ed25519",
"description": "Payment Signing Key",
"cborHex": "5820629ebc4ca6ace67f7b427bf728b39aa5d7bb2f8851f88575d8cee8d112a0956c"
}{
"type": "PaymentVerificationKeyShelley_ed25519",
"description": "Payment Verification Key",
"cborHex": "5820f987631d2e136fc9905f8f7f27a8654a5f86834e118c2873d805f2573e41d0c2"
}cardano-signer keygen \
--path 1852H/1815H/0H/0/0 \
--json-extendedOutput - JSON Format:
{
"workMode": "keygen",
"path": "1852H/1815H/0H/0/0",
"mnemonics": "snap siege fatal leopard label thunder rely trap robot identify someone exclude glance spring right rude tower pluck explain mouse scheme sister onion include",
"secretKey": "60f0a79e0776b4063d7bff8ada6a37b5fb79168d5e844b51e45fa5088eac6558f858251fdfd2fc55488fceb448c5d8f5d1c93cea5505df05efed86efd90ded6d4db6843876f0154e7d5ab14ddec3dacb353b44d38b9a5a03bde142b5cedf52479eeb435bd154d50e80b2980900ac2d8237408ae373daf68d19b6013f5fcd2ef2",
"publicKey": "4db6843876f0154e7d5ab14ddec3dacb353b44d38b9a5a03bde142b5cedf5247",
"XpubKeyHex": "f1d184dc020c90ed0ab318f98b2bbf0b215723d3e68121fba9b12bd5389fa9a3cb01f7d31f63fd73c7406a4381066c747b2cc6eafccbc1f85eb24f664238216a",
"XpubKeyBech": "xpub178gcfhqzpjgw6z4nrruck2alpvs4wg7nu6qjr7afky4a2wyl4x3ukq0h6v0k8ltncaqx5supqek8g7evcm40ej7plp0tynmxgguzz6sm2mv70",
"output": {
"skey": {
"type": "PaymentExtendedSigningKeyShelley_ed25519_bip32",
"description": "Payment Signing Key",
"cborHex": "588060f0a79e0776b4063d7bff8ada6a37b5fb79168d5e844b51e45fa5088eac6558f858251fdfd2fc55488fceb448c5d8f5d1c93cea5505df05efed86efd90ded6d4db6843876f0154e7d5ab14ddec3dacb353b44d38b9a5a03bde142b5cedf52479eeb435bd154d50e80b2980900ac2d8237408ae373daf68d19b6013f5fcd2ef2"
},
"vkey": {
"type": "PaymentVerificationKeyShelley_ed25519",
"description": "Payment Verification Key",
"cborHex": "58204db6843876f0154e7d5ab14ddec3dacb353b44d38b9a5a03bde142b5cedf5247"
}
}
}As you can see, this generates a new keypair with random mnemonics for the given derivation path 1852H/1815H/0H/0/0. You can also use the format "1852'/1815'/0'/0/0" for the path, just make sure you put the whole path in doublequotes.
This generated mnemonics are in the Shelley(Icarus) standard BIP39 format and will work with all major wallets like Eternl, Typhoon, etc.
Also a Xpub... key was generated, which can be used to view wallet data in external tracking apps.
Like with the normal ed25519 keys, use the --out-skey & --out-vkey parameters to directly write out .skey/.vkey files.
cardano-signer keygen \
--path 1852H/1815H/0H/2/0 \
--json-extended \
--out-skey stake.skey \
--out-vkey stake.vkeyThis generates the typical .skey/.vkey files with content like
{
"type": "StakeExtendedSigningKeyShelley_ed25519_bip32",
"description": "Stake Signing Key",
"cborHex": "5880f0e78e6c657812e10359bce03c14dda79cd27748571e153f477f0eeca741f049022fe2e261bbda8bcedb96b3ec82eb994b80a739ad0e06fe560f59ae8df50bbea74b785851b0d36b8add6dc24d94112fe18e9fa4e60cc0e420002f77b5ce81482632a8abbe24b57b25912eea26ba686786ea45d4c08d67a8c1207ac219467a82"
}{
"type": "StakeVerificationKeyShelley_ed25519",
"description": "Stake Verification Key",
"cborHex": "5820a74b785851b0d36b8add6dc24d94112fe18e9fa4e60cc0e420002f77b5ce8148"
}cardano-signer keygen \
--cip36 \
--json-extendedOutput - JSON Format:
{
"workMode": "keygen-cip36",
"path": "1694H/1815H/0H/0/0",
"votePurpose": "Catalyst (0)",
"mnemonics": "sudden release husband tone know ladder couple timber another human horn humble exit gift depth green aspect annual crawl final garage innocent cluster aisle",
"secretKey": "38483eb792e0e4daa12a317ffdeaddd72b3dfde549ee174ecaabf14173bb315dbe3f42605e7400f1616a73a4c08b7f6a89d3e3da87adab9c5e8571bc58bf32d336fdc791592d144da05165c89323c98078d4a888bf4d6e4e146192493d23a065e31ab5741b2180735bd168d2d1a0911e874beb32651f7519733444f3df8bc956",
"publicKey": "36fdc791592d144da05165c89323c98078d4a888bf4d6e4e146192493d23a065",
"XpubKeyHex": "792ca6f66a4a37769e24de762b4a79a1b4340c5f5388b9e9fc3ad16f63a1188f766b14cd0d5d5bcd2f8c7bdaef983b7539b24911d92c136ef54d78aa61b564c8",
"XpubKeyBech": "xpub10yk2dan2fgmhd83ymemzkjne5x6rgrzl2wytn60u8tgk7caprz8hv6c5e5x46k7d97x8hkh0nqah2wdjfygajtqndm656792vx6kfjqr7hegx",
"secretKeyBech": "cvote_sk18pyradujurjd4gf2x9llm6ka6u4nml09f8hpwnk240c5zuamx9wmu06zvp08gq83v9488fxq3dlk4zwnu0dg0tdtn30g2udutzln95eklhrezkfdz3x6q5t9ezfj8jvq0r223z9lf4hyu9rpjfyn6gaqvh334dt5rvscqu6m695d95dqjy0gwjltxfj37agewv6yfu7l30y4v0wn82x",
"publicKeyBech": "cvote_vk1xm7u0y2e952ymgz3vhyfxg7fspudf2yghaxkuns5vxfyj0fr5pjss26uda",
"output": {
"skey": {
"type": "CIP36VoteExtendedSigningKey_ed25519",
"description": "undefined Vote Signing Key",
"cborHex": "588038483eb792e0e4daa12a317ffdeaddd72b3dfde549ee174ecaabf14173bb315dbe3f42605e7400f1616a73a4c08b7f6a89d3e3da87adab9c5e8571bc58bf32d336fdc791592d144da05165c89323c98078d4a888bf4d6e4e146192493d23a065e31ab5741b2180735bd168d2d1a0911e874beb32651f7519733444f3df8bc956"
},
"vkey": {
"type": "CIP36VoteVerificationKey_ed25519",
"description": "undefined Vote Verification Key",
"cborHex": "582036fdc791592d144da05165c89323c98078d4a888bf4d6e4e146192493d23a065"
}
}
}Providing the --cip36 flag sets the parameters to generate CIP36 conform voting key.
You can achieve the same result by setting --path 1694H/1815H/0H/0/0 or using the shortcut --path cip36.
Like with the examples before, you can write out .skey/.vkey files if needed.
Such a generated voting key can be used to be included in the CIP36(Catalyst) registration metadata, which can also be generated & signed by cardano-signer. You can delegate Voting-Power to such a voting key. Later on you can restore a Wallet in a dApp enabled LightWallet like Eternl with the generated mnemonics to do the Voting via the VotingCenter.
cardano-signer keygen \
--path 1694H/1815H/0H/0/0 \
--mnemonics "noise dad blood spell fiber valley pact dial nest arrow umbrella addict skill excuse duty hover lyrics enrich now zebra draft sample city hair" \
--json-extendedOutput - JSON Format:
{
"workMode": "keygen",
"path": "1694H/1815H/0H/0/0",
"votePurpose": "Catalyst (0)",
"mnemonics": "noise dad blood spell fiber valley pact dial nest arrow umbrella addict skill excuse duty hover lyrics enrich now zebra draft sample city hair",
"secretKey": "106c158474bf7cc634bd4368c69d83a0d9930fbb8036f4905beec7b5f82e6547ad08887117afa7c7fb452e831c1c157d53168b5ccf2a349964485be877d69cf88f1c138a9a1d9c54c38881cdd46aeaf7b409c2dab30d168344934d34299a6dea5744838cd3d3916f0cda808bb91f512162cc58be3ca9b87cb4b69db7e5558861",
"publicKey": "8f1c138a9a1d9c54c38881cdd46aeaf7b409c2dab30d168344934d34299a6dea",
"XpubKeyHex": "81d2f04ba976badf5f83711c904898f26f08c64de2185b3fb3c46fdb7f37bae4e093e35996924a30f98a169d862f57b248cb95eb77ba50ce4d24b76c1859e21a",
"XpubKeyBech": "xpub1s8f0qjafw6ad7hurwywfqjyc7fhs33jdugv9k0anc3haklehhtjwpylrtxtfyj3slx9pd8vx9atmyjxtjh4h0wjseexjfdmvrpv7yxsku9k6z",
"secretKeyBech": "cvote_sk1zpkptpr5ha7vvd9agd5vd8vr5rvexramsqm0fyzmamrmt7pwv4r66zygwyt6lf78ldzjaqcurs2h65ck3dwv7235n9jysklgwltfe7y0rsfc4xsan32v8zypeh2x46hhksyu9k4np5tgx3ynf56znxndaft5fquv60fezmcvm2qghwgl2ysk9nzchc72nwrukjmfmdl92kyxzczy5xl",
"publicKeyBech": "cvote_vk13uwp8z56rkw9fsugs8xag6h2776qnsk6kvx3dq6yjdxng2v6dh4qtskqms",
"output": {
"skey": {
"type": "CIP36VoteExtendedSigningKey_ed25519",
"description": "undefined Vote Signing Key",
"cborHex": "5880106c158474bf7cc634bd4368c69d83a0d9930fbb8036f4905beec7b5f82e6547ad08887117afa7c7fb452e831c1c157d53168b5ccf2a349964485be877d69cf88f1c138a9a1d9c54c38881cdd46aeaf7b409c2dab30d168344934d34299a6dea5744838cd3d3916f0cda808bb91f512162cc58be3ca9b87cb4b69db7e5558861"
},
"vkey": {
"type": "CIP36VoteVerificationKey_ed25519",
"description": "undefined Vote Verification Key",
"cborHex": "58208f1c138a9a1d9c54c38881cdd46aeaf7b409c2dab30d168344934d34299a6dea"
}
}
}If you provide mnemonics via the --mnemonics parameter, these mnemonics will be used to derive the keys from. So you can also for example convert your Daedalus Wallet into .skey/.vkey files.
cardano-signer keygen \
--path drep \
--json-extendedOutput - JSON Format:
{
"workMode": "keygen",
"path": "1852H/1815H/0H/3/0",
"mnemonics": "spirit poverty boring zero banner argue cream bag damage menu purity project scatter harsh moment exit tribe security autumn bar olive defy slight mirror",
"secretKey": "00ff6013126074c9cfa811c3b7fe02c92d90b7eab4917067043b83f11a9cff4aab46e483282e058b8626a21441c337b26124d2d6cdf9ad8cf90ed179a74c5381395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af9ee678410593fb9a10d10f21b18457502bfb578d168acfb9bf7418a662bf17bd",
"publicKey": "395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af",
"XpubKeyHex": "a91179e1ab2f8b7866f27a298b8004aab4981739b106fbf96b877bde63a400fe02bb92856c70bffb4389b815e64cafda1a14b447489324153d1075fdd8ea051d",
"XpubKeyBech": "xpub14yghncdt979hsehj0g5chqqy426fs9eekyr0h7ttsaaaucayqrlq9wujs4k8p0lmgwyms90xfjha5xs5k3r53yeyz573qa0amr4q28g9pgywh",
"drepIdHex": "f05f78a15b2db995bee537ce2e8220c068c5be44422eed27e129ac71",
"drepIdBech": "drep17p0h3g2m9kuet0h9xl8zaq3qcp5vt0jygghw6flp9xk8z7cz8zm",
"secretKeyBech": "drep_sk1qrlkqycjvp6vnnagz8pm0lszeykepdl2kjghqecy8wplzx5ula92k3hysv5zupvtscn2y9zpcvmmycfy6ttvm7dd3nusa5te5ax98qfe2wf27gqq9txdz099unlpscyg96lz7lmndacqfcu4ztlty5jp470wv7zpqkflhxss6y8jrvvy2agzh76h35tg4naeha6p3fnzhutm6jmxnf3",
"publicKeyBech": "drep_vk189fe9teqqq4ve5fu5hj0uxrq3qhtutmlwdhhqp8rj5f0avjjgxhsu2h6h8",
"output": {
"skey": {
"type": "DRepExtendedSigningKey_ed25519_bip32",
"description": "Delegate Representative Signing Key",
"cborHex": "588000ff6013126074c9cfa811c3b7fe02c92d90b7eab4917067043b83f11a9cff4aab46e483282e058b8626a21441c337b26124d2d6cdf9ad8cf90ed179a74c5381395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af9ee678410593fb9a10d10f21b18457502bfb578d168acfb9bf7418a662bf17bd"
},
"vkey": {
"type": "DRepVerificationKey_ed25519",
"description": "Delegate Representative Verification Key",
"cborHex": "5820395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af"
}
}
}As you can see, the path is recognized as a dRep Signing/Verification key path.
You can achieve the same result by setting --path 1852H/1815H/0H/3/0.
Like with the examples before, you can write out .skey/.vkey files if needed.
Such a generated key can be used to register it on chain as your dRep key. You can also use the generated mnemonics to create a new wallet on a LightWallet like Eternl, if you like to have your keys synced.
cardano-signer keygen \
--path 1852H/1815H/0H/3/0 \
--mnemonics "spirit poverty boring zero banner argue cream bag damage menu purity project scatter harsh moment exit tribe security autumn bar olive defy slight mirror" \
--vkey-extended
--json-extendedOutput - JSON Format:
{
"workMode": "keygen",
"path": "1852H/1815H/0H/3/0",
"mnemonics": "spirit poverty boring zero banner argue cream bag damage menu purity project scatter harsh moment exit tribe security autumn bar olive defy slight mirror",
"secretKey": "00ff6013126074c9cfa811c3b7fe02c92d90b7eab4917067043b83f11a9cff4aab46e483282e058b8626a21441c337b26124d2d6cdf9ad8cf90ed179a74c5381395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af9ee678410593fb9a10d10f21b18457502bfb578d168acfb9bf7418a662bf17bd",
"publicKey": "395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af9ee678410593fb9a10d10f21b18457502bfb578d168acfb9bf7418a662bf17bd",
"XpubKeyHex": "a91179e1ab2f8b7866f27a298b8004aab4981739b106fbf96b877bde63a400fe02bb92856c70bffb4389b815e64cafda1a14b447489324153d1075fdd8ea051d",
"XpubKeyBech": "xpub14yghncdt979hsehj0g5chqqy426fs9eekyr0h7ttsaaaucayqrlq9wujs4k8p0lmgwyms90xfjha5xs5k3r53yeyz573qa0amr4q28g9pgywh",
"drepIdHex": "1d40bb22a16442babf911c345736c4d4e07fcc3b3444690785764141",
"drepIdBech": "drep1r4qtkg4pv3pt40u3rs69wdky6ns8lnpmx3zxjpu9weq5z68dgyg",
"secretKeyBech": "drep_sk1qrlkqycjvp6vnnagz8pm0lszeykepdl2kjghqecy8wplzx5ula92k3hysv5zupvtscn2y9zpcvmmycfy6ttvm7dd3nusa5te5ax98qfe2wf27gqq9txdz099unlpscyg96lz7lmndacqfcu4ztlty5jp470wv7zpqkflhxss6y8jrvvy2agzh76h35tg4naeha6p3fnzhutm6jmxnf3",
"publicKeyBech": "drep_vk189fe9teqqq4ve5fu5hj0uxrq3qhtutmlwdhhqp8rj5f0avjjgxheaencgyze87u6zrgs7gd3s3t4q2lm27x3dzk0hxlhgx9xv2l300gge7d87",
"output": {
"skey": {
"type": "DRepExtendedSigningKey_ed25519_bip32",
"description": "Delegate Representative Signing Key",
"cborHex": "588000ff6013126074c9cfa811c3b7fe02c92d90b7eab4917067043b83f11a9cff4aab46e483282e058b8626a21441c337b26124d2d6cdf9ad8cf90ed179a74c5381395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af9ee678410593fb9a10d10f21b18457502bfb578d168acfb9bf7418a662bf17bd"
},
"vkey": {
"type": "DRepExtendedVerificationKey_ed25519_bip32",
"description": "Delegate Representative Verification Key",
"cborHex": "5840395392af20002accd13ca5e4fe1860882ebe2f7f736f7004e39512feb25241af9ee678410593fb9a10d10f21b18457502bfb578d168acfb9bf7418a662bf17bd"
}
}
}If you provide mnemonics via the --mnemonics parameter, these mnemonics will be used to derive the keys from. So you can also for example convert your LightWallet (Eternl, Typhon, ...) into .skey/.vkey files.
cardano-signer keygen \
--path cc-cold \
--json-extendedOutput - JSON Format:
{
"workMode": "keygen",
"path": "1852H/1815H/0H/4/0",
"mnemonics": "cotton thunder useful social state soft engage member rent subject kite earn forget robot coral depart future betray seed bag acquire enlist time primary",
"secretKey": "f07d70ee6fe6319bc265256077570a59b715312cf3c268547b7c4da966bc9e5568a67ca09e0f2ccbbbdd4b7c8563bb2e51529da43f2b77fe6db02371aa6dfba168c0ddf7e28f4a1060db367e1b3ec8dc1fa2c6eee2c9e92a7a45f0f4d026b093addcc291d29055a5407e99dcfce83436cf9369a09919bf5e653c680b6b418159",
"publicKey": "68c0ddf7e28f4a1060db367e1b3ec8dc1fa2c6eee2c9e92a7a45f0f4d026b093",
"XpubKeyHex": "6a86bb2d7eed40af0fc6bc96bb22cfdfac484570fbf20720e9af467418c12e13abe8b00e84b388298548608477c6ab410ab98582e2457faaf9642e7edcb191fc",
"XpubKeyBech": "xpub1d2rtktt7a4q27r7xhjttkgk0m7kys3tsl0eqwg8f4ar8gxxp9cf6h69sp6zt8zpfs4yxpprhc645zz4eskpwy3tl4tukgtn7mjcerlq6h05gk",
"ccColdIdHex": "12de8a19ab0a95aafdb881bf4bdfb092207e89ec2fa0c43be73dbcf1",
"ccColdIdBech": "cc_cold1zt0g5xdtp2264ldcsxl5hhasjgs8az0v97svgwl88k70zezc2s3",
"secretKeyBech": "cc_cold_xsk17p7hpmn0uccehsn9y4s8w4c2txm32vfv70pxs4rm03x6je4une2k3fnu5z0q7txth0w5kly9vwaju52jnkjr72mhlekmqgm34fklhgtgcrwl0c50fggxpkek0cdnajxur73vdmhze85j57j97r6dqf4sjwkaes5362g9tf2q06vael8gxsmvlymf5zv3n067v57xszmtgxq4j9q305j",
"publicKeyBech": "cc_cold_vk1drqdmalz3a9pqcxmxelpk0kgms0693hwuty7j2n6ghc0f5pxkzfsul89qx",
"output": {
"skey": {
"type": "ConstitutionalCommitteeColdExtendedSigningKey_ed25519_bip32",
"description": "Constitutional Committee Cold Extended Signing Key",
"cborHex": "5880f07d70ee6fe6319bc265256077570a59b715312cf3c268547b7c4da966bc9e5568a67ca09e0f2ccbbbdd4b7c8563bb2e51529da43f2b77fe6db02371aa6dfba168c0ddf7e28f4a1060db367e1b3ec8dc1fa2c6eee2c9e92a7a45f0f4d026b093addcc291d29055a5407e99dcfce83436cf9369a09919bf5e653c680b6b418159"
},
"vkey": {
"type": "ConstitutionalCommitteeColdVerificationKey_ed25519",
"description": "Constitutional Committee Cold Verification Key",
"cborHex": "582068c0ddf7e28f4a1060db367e1b3ec8dc1fa2c6eee2c9e92a7a45f0f4d026b093"
}
}
}As you can see, the path is recognized as a CC-Cold Signing/Verification key path.
You can achieve the same result by setting --path 1852H/1815H/0H/4/0.
Like with the examples before, you can directly also write out .skey/.vkey files if needed.
If you wanna use your own mnemonics, just provide them via the --mnemonics parameter!
cardano-signer keygen \
--path cc-hot \
--json-extendedOutput - JSON Format:
{
"workMode": "keygen",
"path": "1852H/1815H/0H/5/0",
"mnemonics": "knock advance olympic table pride melody cause kick govern pass manual liberty warfare zero now meat confirm chronic amount powder three limb patient ball",
"secretKey": "401299d0380dec82d938092673de937c634338976bd246b86b9ddcd69838b654b87c0afa9d08df7bbfec137e8b2f98e48de0c01225f7b278b37efad1dfbbaefc344ece677d4931d596210917c7ba6125b6253dd4431a0c886369555235f385a093bca3010d9dadba7489f0f5ec9a7a43239b06326e9fbb3d7685ecf719b90738",
"publicKey": "344ece677d4931d596210917c7ba6125b6253dd4431a0c886369555235f385a0",
"XpubKeyHex": "7da8b212c1a0364f2fd08707f8e132a07d67c3e86e50e8f243ba8688403011bd3adfe9de3beed77354ca01887337a3779783250e20d2705a40d930d45220f6cb",
"XpubKeyBech": "xpub10k5tyykp5qmy7t7ssurl3cfj5p7k0slgdegw3ujrh2rgsspszx7n4hlfmca7a4mn2n9qrzrnx73h09ury58zp5nstfqdjvx52gs0djcpqjpv0",
"ccHotIdHex": "644d25e82ba444e6bc4f6141968f5f626ac26669d9952f682cdbc90f",
"ccHotIdBech": "cc_hot1v3xjt6pt53zwd0z0v9qedr6lvf4vyenfmx2j76pvm0ys7qcljwa",
"secretKeyBech": "cc_hot_xsk1gqffn5pcphkg9kfcpyn88h5n0335xwyhd0fydwrtnhwddxpcke2tslq2l2ws3hmmhlkpxl5t97vwfr0qcqfztaaj0zeha7k3m7a6alp5fm8xwl2fx82evggfzlrm5cf9kcjnm4zrrgxgscmf24frtuu95zfmegcppkw6mwn538c0tmy60fpj8xcxxfhflweaw6z7eacehyrnsf69qu2",
"publicKeyBech": "cc_hot_vk1x38vuemafycat93ppytu0wnpykmz20w5gvdqezrrd924yd0nsksqah2clh",
"output": {
"skey": {
"type": "ConstitutionalCommitteeHotExtendedSigningKey_ed25519_bip32",
"description": "Constitutional Committee Hot Extended Signing Key",
"cborHex": "5880401299d0380dec82d938092673de937c634338976bd246b86b9ddcd69838b654b87c0afa9d08df7bbfec137e8b2f98e48de0c01225f7b278b37efad1dfbbaefc344ece677d4931d596210917c7ba6125b6253dd4431a0c886369555235f385a093bca3010d9dadba7489f0f5ec9a7a43239b06326e9fbb3d7685ecf719b90738"
},
"vkey": {
"type": "ConstitutionalCommitteeHotVerificationKey_ed25519",
"description": "Constitutional Committee Hot Verification Key",
"cborHex": "5820344ece677d4931d596210917c7ba6125b6253dd4431a0c886369555235f385a0"
}
}
}As you can see, the path is recognized as a CC-Hot Signing/Verification key path.
You can achieve the same result by setting --path 1852H/1815H/0H/5/0.
Like with the examples before, you can directly also write out .skey/.vkey files if needed.
If you wanna use your own mnemonics, just provide them via the --mnemonics parameter!
Â
Â
If you input a JSONLD governance file (context part not shown) like
{
...
"hashAlgorithm": "blake2b-256",
"body": {
"title": "Example CIP108(+CIP100) metadata",
"abstract": "This metadata was generated to test out db-sync, SPO-Scripts, Koios and other tools...",
"motivation": "This must work, should be motivation enough.",
"rationale": "Let's keep testing stuff",
"references": [
{
"@type": "Other",
"label": "SanchoNet",
"uri": "https://sancho.network"
}
],
"comment": "This is an example CIP-108 metadata-file... testing SPO-Scripts, Koios and Co.",
"externalUpdates": [
{
"title": "SPO Scripts",
"uri": "https://github.com/gitmachtl/scripts"
},
{
"title": "Koios",
"uri": "https://koios.rest"
}
]
}
}and running
cardano-signer.js sign --cip100 \
--data-file CIP108-example.json \
--secret-key dummy.skey \
--author-name "The great Name" \
--out-file CIP108-example-signed.jsongenerates you the governance metadata file with the added signature:
{
...
"hashAlgorithm": "blake2b-256",
"body": {
"title": "Example CIP108(+CIP100) metadata",
"abstract": "This metadata was generated to test out db-sync, SPO-Scripts, Koios and other tools...",
"motivation": "This must work, should be motivation enough.",
"rationale": "Let's keep testing stuff",
"references": [
{
"@type": "Other",
"label": "SanchoNet",
"uri": "https://sancho.network"
}
],
"comment": "This is an example CIP-108 metadata-file... testing SPO-Scripts, Koios and Co.",
"externalUpdates": [
{
"title": "SPO Scripts",
"uri": "https://github.com/gitmachtl/scripts"
},
{
"title": "Koios",
"uri": "https://koios.rest"
}
]
},
"authors": [
{
"name": "The great Name",
"witness": {
"witnessAlgorithm": "ed25519",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9",
"signature": "8b579ba2cb9bcb2355e550a67865d56017d4696a4a48f8db5218a92a7f85bb3ddcde13500b89531c68a3f52deb83ca45f1987ea048500e11feee26847cb6b900"
}
}
]
}Cardano-Signer is doing the following steps to sign the document:
- check that the provided input data is a valid JSON file
- canonize the
@contextandbodypart via URDNA2015 method and hash it via black2b-256 method - check that the
hashAlgorithmisblack2b-256 - check any preexisting
authorsarray entry to be valid - check that there is no duplicated public-key entry
- sign the canonized hash with the provided secret-key and author-name
Additional authors can be added by simply running the same command multiple times!
Also, if you write out the new file directly via the --out-file parameter, the output of cardano-signer becomes a json with the basic infos of the new file, including the anchorHash. Ready do be used with governance on Cardano.
{
"workMode": "sign-cip100",
"outFile": "CIP108-example-signed.json",
"anchorHash": "8723898521770d095f522a3976f8318128f97ae10b8cd97da0f66dd29f849f80"
}
As we already learned, you can use cardano-signer to sign a governance metadata file with author signatures. This function is doing the verification of such documents.
Lets use the same document that we generated above:
cardano-signer verify --cip100 \
--data-file CIP108-example-signed.json \
--json-extendedThis gives us the following result:
{
"workMode": "verify-cip100",
"result": true,
"errorMsg": "",
"authors": [
{
"name": "The great Name",
"publicKey": "755b017578b701dc9ddd4eaee67015b4ca8baf66293b7b1d204df426c0ceccb9",
"signature": "8b579ba2cb9bcb2355e550a67865d56017d4696a4a48f8db5218a92a7f85bb3ddcde13500b89531c68a3f52deb83ca45f1987ea048500e11feee26847cb6b900",
"valid": true
}
],
"canonizedHash": "8b5db60af5d673fcff7c352db569bff595c3279d3db23f2b607607bd694496d1",
"body": {
"title": "Example CIP108(+CIP100) metadata",
"abstract": "This metadata was generated to test out db-sync, SPO-Scripts, Koios and other tools...",
"motivation": "This must work, should be motivation enough.",
"rationale": "Let's keep testing stuff",
"references": [
{
"@type": "Other",
"label": "SanchoNet",
"uri": "https://sancho.network"
}
],
"comment": "This is an example CIP-108 metadata-file... testing SPO-Scripts, Koios and Co.",
"externalUpdates": [
{
"title": "SPO Scripts",
"uri": "https://github.com/gitmachtl/scripts"
},
{
"title": "Koios",
"uri": "https://koios.rest"
}
]
},
"canonizedBody": [
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#comment> \"This is an example CIP-108 metadata-file... testing SPO-Scripts, Koios and Co.\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#externalUpdates> _:c14n1 .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#externalUpdates> _:c14n3 .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#abstract> \"This metadata was generated to test out db-sync, SPO-Scripts, Koios and other tools...\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#motivation> \"This must work, should be motivation enough.\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#rationale> \"Let's keep testing stuff\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#references> _:c14n2 .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#title> \"Example CIP108(+CIP100) metadata\"@en-us .",
"_:c14n1 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-title> \"SPO Scripts\"@en-us .",
"_:c14n1 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-uri> \"https://github.com/gitmachtl/scripts\"@en-us .",
"_:c14n2 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#OtherReference> .",
"_:c14n2 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#reference-label> \"SanchoNet\"@en-us .",
"_:c14n2 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#reference-uri> \"https://sancho.network\"@en-us .",
"_:c14n3 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-title> \"Koios\"@en-us .",
"_:c14n3 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-uri> \"https://koios.rest\"@en-us .",
"_:c14n4 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#body> _:c14n0 ."
]
}There are some interesting fields to notice:
result: will betrueorfalse-> this is an overall check resulterrorMsg: this is a freeform text, describing any found issues in the documentauthors: this is an array of all authors in the document and the signature verification result in thevalidfieldcanonizedHash: this holds the hash of the canonized bodycanonizedBody: this outputs the canonized body in case you wanna use it for debugging. the next functioncanonizebelow can also directly write out that canonized body for further usage.
In this mode you can provide a governance metadata json/jsonld file to cardano-signer to canonize and hash the @context+body content. The hash is needed for verification and signing of the document authors.
cardano-signer canonize --cip100 --data-file CIP108-example.jsonOutput - Hash of the canonized body content(hex) :
8b5db60af5d673fcff7c352db569bff595c3279d3db23f2b607607bd694496d1
You can also generate a nice json output via the --json or --json-extended flag
cardano-signer canonize --cip100 \
--data-file CIP108-example.json \
--json-extended{
"workMode": "hash-cip100",
"canonizedHash": "8b5db60af5d673fcff7c352db569bff595c3279d3db23f2b607607bd694496d1",
"body": {
"title": "Example CIP108(+CIP100) metadata",
"abstract": "This metadata was generated to test out db-sync, SPO-Scripts, Koios and other tools...",
"motivation": "This must work, should be motivation enough.",
"rationale": "Let's keep testing stuff",
"references": [
{
"@type": "Other",
"label": "SanchoNet",
"uri": "https://sancho.network"
}
],
"comment": "This is an example CIP-108 metadata-file... testing SPO-Scripts, Koios and Co.",
"externalUpdates": [
{
"title": "SPO Scripts",
"uri": "https://github.com/gitmachtl/scripts"
},
{
"title": "Koios",
"uri": "https://koios.rest"
}
]
},
"canonizedBody": [
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#comment> \"This is an example CIP-108 metadata-file... testing SPO-Scripts, Koios and Co.\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#externalUpdates> _:c14n1 .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#externalUpdates> _:c14n3 .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#abstract> \"This metadata was generated to test out db-sync, SPO-Scripts, Koios and other tools...\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#motivation> \"This must work, should be motivation enough.\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#rationale> \"Let's keep testing stuff\"@en-us .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#references> _:c14n2 .",
"_:c14n0 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#title> \"Example CIP108(+CIP100) metadata\"@en-us .",
"_:c14n1 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-title> \"SPO Scripts\"@en-us .",
"_:c14n1 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-uri> \"https://github.com/gitmachtl/scripts\"@en-us .",
"_:c14n2 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#OtherReference> .",
"_:c14n2 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#reference-label> \"SanchoNet\"@en-us .",
"_:c14n2 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#reference-uri> \"https://sancho.network\"@en-us .",
"_:c14n3 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-title> \"Koios\"@en-us .",
"_:c14n3 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#update-uri> \"https://koios.rest\"@en-us .",
"_:c14n4 <https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#body> _:c14n0 ."
]
}If you're interested in the raw canonized data, that can be written out to an extra file using the --out-canonized parameter like:
cardano-signer canonize --cip100 \
--data-file CIP108-example.json \
--out-canonized CIP108-example.canonized \
--json-extendedAnd of course you can write out the plaintext or json output also directly to a file like with the other functions. This is simply done by using the --out-file parameter.
-
1.19.0
- A new function is now available via the 'sign --cip100' parameter. Its now possible to add authors entries (Name + Signature) with a single command using cardano-signer
- cardano-signer is now compatible with CIP129 standard for drep, committee-cold and committee-hot bech strings. this works now for all functions that allow a '--address' parameter.
- CIP 8/30 DataSign:
- you can now directly also use governance bech-ids for the '--address' parameter like 'drep1xxx'
- CIP 100 - Governance:
- the canonize&hash command 'hash' introduced in version 1.17 was renamed to 'canonize'. change was made to avoid confusion, because this command is to output the hash of the canonized body, not the file-hash.
- output fields of the 'canonize' and 'verify' function changed 'hash' is now 'canonizedHash', 'canonized' is now 'canonizedBody'
- in addition to the existing checks in the 'verify' function, cardano-signer now also checks for duplicated public-key entries in the authors array of the input jsonld file
-
1.18.0
- verify governance metadata following CIP-100, CIP-108, CIP-119 standard via the new
verify --cip100option
- verify governance metadata following CIP-100, CIP-108, CIP-119 standard via the new
-
1.17.0
- Now using NODE.JS v18
- Updated all dependencies to the latest versions
- canonize & hash governance metadata following CIP-100, CIP-108, CIP-119 standard via the new
canonize --cip100option
-
1.16.1
- Bugfix: The description field of the generated *.vkey file was corrected to be 'Catalyst Vote Verification Key'
-
1.16.0
- Added a new flag
--nohashcheckfor the signing and verification in CIP030/008 format. Using this flag will tell cardano-signer to not perform a check of the hash in the address-field against the public-key during the verification process. And additionally it can disable the address/hash check in the signing process too.
- Added a new flag
-
1.15.1
- small bugfix, parameters
help,usage,versionthrowing an "unknown" error
- small bugfix, parameters
-
1.15.0
- generate conway cc-cold keys via the path
--path cc-coldor - generate conway cc-cold keys from the derivation path "1852'/1815'/acc'/4/idx'
- generate conway cc-cold keys from mnemonics or let cardano-signer generate new mnemonics for you
- generate conway cc-hot keys via the path
--path cc-hotor - generate conway cc-hot keys from the derivation path "1852'/1815'/acc'/5/idx'
- generate conway cc-hot keys from mnemonics or let cardano-signer generate new mnemonics for you
- some corrections on extended verification key outputs
- an unknown parameter now throws an error. before, optional parameters with a typo were simply ignored
- general code cleanup, typos, etc.
- generate conway cc-cold keys via the path
-
1.14.0
- generate conway dRep keys via the path
--path drepor - generate conway dRep keys from the derivation path
1852'/1815'/acc'/3/idx' - generate conway dRep keys from mnemonics or let cardano-signer generate new mnemonics for you
- the flag
with-chain-codehas been replaced by the new flagvkey-extended. this makes it easier for the users to understand the meaning - per default the public keys are now always generated as non-extended keys, the secret keys are always extended ones if derived from a path
- code cleanup
- generate conway dRep keys via the path
-
1.13.0
- generate normal ed25519 keys
- generate extended ed25519 keys from a derivation path like "1852H/1815H/0H/0/0"
- generate keys from mnemonics or let cardano-signer generate new mnemonics for you
- generate CIP36 conform vote keys incl. bech
cvote_vkdata and an optional vote_purpose - generate keys with or without chaincode attached
- directly write out
.skey/.vkeyfiles (like cardano-cli) - extended information like an
Xpub...key is available via the--json-extendedflag - shortcuts for paths can be used like
--path payment,--path stake,--path cip36
-
1.12.1
- Changed the
--rewards-addressparameter to--payment-addressparameter. This reflects the latest changes in CIP-36 - Also the keys for
rewardsAddressHex,rewardsAddressTypeandrewardsAddressNetworkin the--json-extendedoutput are not renamed topaymentAddressHex,paymentAddressType,paymentAddressNetwork
- Changed the
-
1.12.0
- The output via
--json-extendedis now showing more details about the address (hex, type, network) - The help description can now be displayed for each sub command like:
cardano-signer sign --cip8 --help - Addresses provided via the
--addressparameter can now be a bech-address, hex-string or the path to a file containing the bech-address (typical mywallet.addr) files
- Completely reworked CIP-8/CIP-30 code. Flags
--cip8&--cip30will currently do the same, because CIP-30 uses CIP-8 signing. - Signing a payload now generates a full COSE_Sign1 signature together with the COSE_Key publicKey
- The payload can be set to hashed via the new flag
--hashed - The payload can be excluded from the COSE_Sign1 signature with the new flag
--nopayload - The signing address will be automatically checked against the publicKey (signing and verification)
- Extended data structure check of the given COSE_Sign1 & COSE_Key
- Verification can be done against the COSE_Sign1 & COSE_Key, and optionally also against a given payload and address
- The output via
--json-extendedshows additional information if the payload is hashed, address infos, etc.
- The output via
-
1.11.0
- Added an optional flag
--bech(also--jcliworks), to output the signature and public key in jcli compatible bech format with prefixesed25519_siganded25519_pk. This is available in the normal signing mode. - The verify function now also accepts bech encoded signatures
ed25519_sigin addition to hex strings. - With this update the sign/verify functions in cardano-signer can substitute jcli for sign/verify.
- Added an optional flag
-
1.10.1
- Starting with Fund10, the rewards address for the voting rewards must be a regular payment address (enterprise or base address), not a stake address like before.
-
1.10.0
- Added an optional address check for the normal sign/verify functions via the
--addressparameter. If provided, cardano-signer checks that the address belongs to the provided signing/public key.
- Added an optional address check for the normal sign/verify functions via the
-
1.9.0
- Added the new deregistration metadata format in CIP-36 mode, which is using key 61286 for the deregistration data.
- Changed the output of
--json-extendedin CIP-36 mode to output the cbor and json content below the "output" key example
- Using the general bech32 lib to decode public/private keys, so any bech32 string can be used. Before it was limited to
ed25519_pkanded25519_skprefixes. - Defining command-line argument types to avoid parsing arguments like
--data-hex="000000"as a number. Must be parsed as a string of course. - Added command-line aliases so you can also use:
--signing-keyor--secret-key,--verification-keyor--public-key, etc.
-
1.8.0
- Allow duplicated voting_key entries
- New check to avoid using a wrong vote-public-key or a wrong stake secret-key. Because the public-key of the signing secret-key must be different than the entries in the delegations array.
- New check that the total-vote-weight is not zero
- Added the fields
votePurposeandtotalVoteWeightto the--json-extendedoutput-mode - Syntax Update: Added flag
--deregisterto generate an empty delegation array, no voting_keys or rewards address is needed using that flag - Syntax Update: If no
--nonceparameter is provided, cardano-signer automatically calculates the Mainnet slotHeight from the current machine time and uses it as the nonce
- Syntax Update: Added parameter
--testnet-magic [xxx]to CIP-8 and CIP-36 mode to allow an additional check about the right bech-address format. (Default = mainnet)
-
1.7.0
- Added JSON and JSON-Extended output format: Default output format is plaintext, using the
--jsonflag generates a JSON output. Using the--json-extendedflag generates a JSON output with much more information. - In CIP-36 mode, using the new
--jsonflag together with the--out-fileparameter generates directly a JSON Format which is compatible to be used as a registration.json metadata with cardano-cli.--out-cboralways generates a binary registration.cbor metadata file, also compatible to be used with cardano-cli. - Usage/Help context is now colored for better readability
- Added JSON and JSON-Extended output format: Default output format is plaintext, using the
-
1.6.1
- Added new check in CIP-36 mode to avoid duplicated voting_key entries in the delegations. Exits with an error if duplicates are found.
-
1.6.0
- New Syntax - Now you can use the parameter
--data-fileto use any binary file as the data source to sign. - Added the function to directly use bech encoded secret and public keys for the signing/verification. You can mix the formats.
- New Syntax - Now you can use the parameter
-
1.5.0
- New CIP-36 mode via parameter
--cip36. This enables the new catalyst/governance registration and votingpower (multi-)delegation mode. Output generates a signed cbor file or hex_string.
- New CIP-36 mode via parameter
-
1.4.0
- New CIP-8 mode via parameter
--cip8. This enables CIP-8 conform payload signing. - New Syntax - Now you can use the parameter
--datafor pure text payloads, and--data-hexfor hex-encoded payloads.
- New CIP-8 mode via parameter
-
1.3.0
- Now supporting true parameter/flag names.
- Added new optional
--out-fileoption, which would write the signature+publicKey to a file and not to the standard output.
-
1.2.0
- Added support to use Cardano-Key-Files in addition to a direct Key-Hexstring. Supports standard sKey/vKey JSON files and also files with a Bech32-Key in it, like the ones generated via jcli
-
1.1.0
- Added functionality to do also a Verification of the Signature together with the data and the Public Key.
-
1.0.0
- Initial version, supports signing of a Data-Hexstring string with a Key-Hexstring.
- Telegram - @atada_stakepool
- Twitter - @ATADA_Stakepool
- Discord - MartinLang [ATADA, SPO Scripts]#5306
- Email - stakepool@stakepool.at
- Homepage - https://stakepool.at