catalyst-vote.support.md

Catalyst Vote registration

Construction api

In the request for /construction/preprocess and /construction/payloads endpoints, in addition to the current operations, a new operation 'voteRegistration' has been added

Vote Registration operation

Vote registration operations need, in addition, a metadata containing voteRegistrationMetadata which are the parameters needed to register a Catalyst Vote and are obtained mostly outside Rosetta.

The operation may look like this:

{
  "network_identifier": {
    "blockchain": "cardano",
    "network": "mainnet"
  },
  "operations": [
    // other operations before
    {
      "operation_identifier": {
        "index": 1
      },
      "status": "success",
      "type": "voteRegistration",
      "metadata": {
        "voteRegistrationMetadata": {
          "rewardAddress": "addr1q9nr7yuhzsmmdchsjacuqef5cnlajk2s4j2rjre5uzgmtw5vcjwuayent36vkw403c8hat9csyawfgg88qlwweyeshnqsh9r5q",
          "stakeKey": {
            "curve_type": "edwards25519",
            "hex_bytes": "56f29f391a3bb5ff90637b2d2d0a32590214871284b0577e4671b0c1a83f79ba"
          },
          "votingKey": {
            "curve_type": "edwards25519",
            "hex_bytes": "8bcec4282239b2cc1a7d8bb294c154c849fc200c7ebd27ef45e610d849bc302a"
          },
          "votingNonce": 26912766,
          "votingSignature": "f75f7a54a79352f9d0e2c4de4e8ded8ae9304fa0f3b021754f8d149c90c7b01e1c6bbfdd623c294d82f5e5cbbfc0bd6fd1c674780db4025446e2eafc87f61b0a"
        }
      }
    }
    // other operations after
  ],
  "metadata": {
    "ttl": "1000"
  }
}

• rewardAddress Staking address which will receive voting rewards
• stakeKey Public key of the corresponding staking account passed as hex string
• votingKey Catalyst voting public key
• votingNonce Current slot number
• votingSignature Previously vote data signed with the staking private key passed as hex string

All of these values will be included in the transaction metadata with the following structure:

{
  "61284": {
    // voting_key - CBOR byte array
    "1": "0xa6a3c0447aeb9cc54cf6422ba32b294e5e1c3ef6d782f2acff4a70694c4d1663",
    // stake_pub - CBOR byte array
    "2": "0xad4b948699193634a39dd56f779a2951a24779ad52aa7916f6912b8ec4702cee",
    // reward_address - CBOR byte array
    "3": "0x00588e8e1d18cba576a4d35758069fe94e53f638b6faf7c07b8abd2bc5c5cdee47b60edc7772855324c85033c638364214cbfc6627889f81c4",
    // nonce
    "4": 5479467
  },
  "61285": {
    // signature - ED25119 signature CBOR byte array
    "1": "0x8b508822ac89bacb1f9c3a3ef0dc62fd72a0bd3849e2381b17272b68a8f52ea8240dcc855f2264db29a8512bfcd522ab69b982cb011e5f43d0154e72f505f007"
  }
}

Voting Signature

This value is obtained by signing the voting data("61284" field) blake2b-256 hashed with the staking private key.

For more information about where these values come from you can check this useful link

Data api

Vote registration operations are also returned in /block and /block/transaction endpoints if corresponds to. Since a vote is included in the transaction metadata, every metadata that follows the mentioned structure will be traited as a vote operation.

Request example

In this example we are using /block/transaction endpoint with the specified transaction and block.

{
  "network_identifier": { "blockchain": "cardano", "network": "mainnet" },
  "block_identifier": {
    "index": 5593749,
    "hash": "1c42fd317888b2aafe9f84787fdd3b90b95be06687a217cf4e6ca95130157eb5"
  },
  "transaction_identifier": {
    "hash": "adeb7b6845f3f4b0e74275588412cf00912b615e4bbf76d111326ce899260c59"
  }
}

Response example with a vote operatoin operation

{
  "transaction_identifier": {
    "hash": "adeb7b6845f3f4b0e74275588412cf00912b615e4bbf76d111326ce899260c59"
  },
  "operations": [
    // other operations
    {
      "operation_identifier": {
        "index": 1
      },
      "status": "success",
      "type": "voteRegistration",
      "metadata": {
        "voteRegistrationMetadata": {
          "rewardAddress": "addr1q9nr7yuhzsmmdchsjacuqef5cnlajk2s4j2rjre5uzgmtw5vcjwuayent36vkw403c8hat9csyawfgg88qlwweyeshnqsh9r5q",
          "stakeKey": {
            "curve_type": "edwards25519",
            "hex_bytes": "56f29f391a3bb5ff90637b2d2d0a32590214871284b0577e4671b0c1a83f79ba"
          },
          "votingKey": {
            "curve_type": "edwards25519",
            "hex_bytes": "8bcec4282239b2cc1a7d8bb294c154c849fc200c7ebd27ef45e610d849bc302a"
          },
          "votingNonce": 26912766,
          "votingSignature": "f75f7a54a79352f9d0e2c4de4e8ded8ae9304fa0f3b021754f8d149c90c7b01e1c6bbfdd623c294d82f5e5cbbfc0bd6fd1c674780db4025446e2eafc87f61b0a"
        }
      }
    }
    // other operations here
  ]
}