package TW.Cardano.Proto

Get desktop application:
View/edit binary Protocol Buffers messages

Delegate funds in this account to a specified staking pool.

Used in: SigningInput

• string staking_address = 1

  Staking address (as string)

• bytes pool_id = 2

  PoolID of staking pool

• uint64 deposit_amount = 3

  Amount deposited in this TX. Should be 0. If not set correctly, TX will be rejected. See also RegisterStakingKey.deposit_amount.

Deregister staking key. can be done when staking is stopped completely. The Staking deposit is returned at this time.

Used in: SigningInput

• string staking_address = 1

  Staking address (as string)

• uint64 undeposit_amount = 2

  Amount undeposited in this TX. Should be 2 ADA (2000000). If not set correctly, TX will be rejected. See also RegisterStakingKey.deposit_amount.

A transaction output that can be used as input

Used in: TxInput

• bytes tx_hash = 1

  The transaction ID

• uint64 output_index = 2

  The index of this output within the transaction

Register a staking key for the account, prerequisite for Staking. Note: staking messages are typically used with a 1-output-to-self transaction.

Used in: SigningInput

• string staking_address = 1

  Staking address (as string)

• uint64 deposit_amount = 2

  Amount deposited in this TX. Should be 2 ADA (2000000). If not set correctly, TX will be rejected. See also Delegate.deposit_amount.

Input data necessary to create a signed transaction.

• repeated TxInput utxos = 1

  Available input UTXOs

• repeated bytes private_key = 2

  Available private keys (double extended keys); every input UTXO address should be covered In case of Plan only, keys should be present, in correct number

• optional Transfer transfer_message = 3

  Later this can be made oneof if more message types are supported

• optional RegisterStakingKey register_staking_key = 6

  Optional, used in case of Staking Key registration (prerequisite for Staking)

• optional Delegate delegate = 7

  Optional, used in case of (re)delegation

• optional Withdraw withdraw = 8

  Optional, used in case of withdraw

• optional DeregisterStakingKey deregister_staking_key = 9

  Optional

• uint64 ttl = 4

  Time-to-live time of the TX

• optional TransactionPlan plan = 5

  Optional plan, if missing it will be computed

Result containing the signed and encoded transaction.

• bytes encoded = 1

  Encoded transaction bytes

• bytes tx_id = 2

  TxID, derived from transaction data, also needed for submission

• Common.Proto.SigningError error = 3

  Optional error

Represents a token and an amount. Token is identified by PolicyID and name.

Used in: TokenBundle, TransactionPlan, TxInput, TxOutput

• string policy_id = 1

  Policy ID of the token, as hex string (28x2 digits)

• string asset_name = 2

  The name of the asset (within the policy)

• bytes amount = 3

  The amount (uint256, serialized little endian)

Collection of tokens with amount

Used in: Transfer

• repeated TokenAmount token = 1

Describes a preliminary transaction plan.

Used in: SigningInput

• uint64 available_amount = 1

  total coins in the utxos

• uint64 amount = 2

  coins in the output UTXO

• uint64 fee = 3

  coin amount deducted as fee

• uint64 change = 4

  coins in the change UTXO

• uint64 deposit = 10

  coins deposited (going to deposit) in this TX

• uint64 undeposit = 11

  coins undeposited (coming from deposit) in this TX

• repeated TokenAmount available_tokens = 5

  total tokens in the utxos (optional)

• repeated TokenAmount output_tokens = 6

  tokens in the output (optional)

• repeated TokenAmount change_tokens = 7

  tokens in the change (optional)

• repeated TxInput utxos = 8

  The selected UTXOs, subset ot the input UTXOs

• Common.Proto.SigningError error = 9

  Optional error

Message for simple Transfer tx

Used in: SigningInput

• string to_address = 1

  Destination address as string

• string change_address = 2

  Change address

• uint64 amount = 3

  Requested ADA amount to be transferred. Output can be different only in use_max_amount case. Note that Cardano has a minimum amount per UTXO, see TWCardanoMinAdaAmount.

• optional TokenBundle token_amount = 4

  Optional token(s) to be transferred Currently only one token type to be transferred per transaction is supported

• bool use_max_amount = 5

  Request max amount option. If set, tx will send all possible amounts from all inputs, including all tokens; there will be no change; requested amount and token_amount is disregarded in this case.

• uint64 force_fee = 6

  Optional fee overriding. If left to 0, optimal fee will be calculated. If set, exactly this value will be used as fee. Use it with care, it may result in underfunded or wasteful fee.

One input for a transaction

Used in: SigningInput, TransactionPlan

• optional OutPoint out_point = 1

  The UTXO

• string address = 2

  The owner address (string)

• uint64 amount = 3

  ADA amount in the UTXO

• repeated TokenAmount token_amount = 4

  optional token amounts in the UTXO

One output for a transaction

• string address = 1

  Destination address (string)

• uint64 amount = 2

  ADA amount

• repeated TokenAmount token_amount = 3

  optional token amounts

Withdraw earned staking reward.

Used in: SigningInput

• string staking_address = 1

  Staking address (as string)

• uint64 withdraw_amount = 2

  Withdrawal amount. Should match the real value of the earned reward.