package ic_ledger.pb.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: LedgerInit

• optional AccountIdentifier identifier = 1

• optional Tokens balance = 2

Get the balance of an account

• optional AccountIdentifier account = 1

• optional Tokens balance = 1

Used in: Account, AccountBalanceRequest, Burn, LedgerInit, Mint, Send, SendRequest, TransferFrom, ic_nns_governance.pb.v1.ManageNeuron.Disburse, ic_nns_governance.pb.v1.NodeProvider, ic_nns_governance.pb.v1.RewardNodeProvider.RewardToAccount, ic_nns_governance.pb.v1.UpdateNodeProvider

• bytes hash = 1

  Can contain either: * the 32 byte identifier (4 byte checksum + 28 byte hash) * the 28 byte hash

Used in: Send

• optional Tokens allowance = 1

• optional TimeStamp expires_at = 2

• optional Tokens expected_allowance = 3

Add blocks to the archive canister

• repeated Block blocks = 1

(message has no fields)

Used in: ArchiveIndexResponse

• uint64 height_from = 1

• uint64 height_to = 2

• optional ic_base_types.pb.v1.PrincipalId canister_id = 3

• repeated ArchiveIndexEntry entries = 1

* Archive canister * Init the archive canister

• uint32 node_max_memory_size_bytes = 1

• uint32 max_message_size_bytes = 2

This is the

Used in: ArchiveAddRequest

• optional Hash parent_hash = 1

• optional TimeStamp timestamp = 2

• optional Transaction transaction = 3

Used in: NotifyRequest, Refund, SendRequest, SendResponse, TipOfChainResponse, Transaction, TransactionNotificationRequest

• uint64 height = 1

Get a single block

• uint64 block_height = 1

• oneof block_content

  • EncodedBlock block = 1

  • ic_base_types.pb.v1.PrincipalId canister_id = 2

Used in: Transaction

• optional AccountIdentifier from = 1

• optional Tokens amount = 3

• optional AccountIdentifier spender = 4

Used in: TipOfChainResponse

• bytes certification = 1

• oneof response

  • ic_base_types.pb.v1.PrincipalId created_canister_id = 1

  • Refund refund = 2

  • ToppedUp topped_up = 3

Used in: BlockResponse, EncodedBlocks, IterBlocksResponse

• bytes block = 1

Used in: GetBlocksResponse

• repeated EncodedBlock blocks = 1

Get a set of blocks

• uint64 start = 1

• uint64 length = 2

• oneof get_blocks_content

  • EncodedBlocks blocks = 1

  • string error = 2

Fetch a list of all of the archive nodes

(message has no fields)

• repeated ic_base_types.pb.v1.PrincipalId nodes = 1

Used in: Block

• bytes hash = 1

Used in: Transaction

• bytes memo = 1

Iterate through blocks

• uint64 start = 1

• uint64 length = 2

• repeated EncodedBlock blocks = 1

Archive any blocks older than this

• optional TimeStamp timestamp = 1

Initialise the ledger canister

• optional AccountIdentifier minting_account = 1

• repeated Account initial_values = 2

• optional ic_base_types.pb.v1.PrincipalId archive_canister = 3

• uint32 max_message_size_bytes = 4

The format of values serialized to/from the stable memory during and upgrade

(message has no fields)

Used in: SendRequest, Transaction, TransactionNotificationRequest

• uint64 memo = 1

Used in: Transaction

• optional AccountIdentifier to = 2

• optional Tokens amount = 3

Notify a canister that it has received a payment

• optional BlockIndex block_height = 1

• optional Tokens max_fee = 2

• optional Subaccount from_subaccount = 3

• optional ic_base_types.pb.v1.PrincipalId to_canister = 4

• optional Subaccount to_subaccount = 5

(message has no fields)

Used in: SendRequest

• optional Tokens receiver_gets = 1

Used in: CyclesNotificationResponse

• optional BlockIndex refund = 2

• string error = 3

Used in: Transaction

• optional AccountIdentifier from = 1

  The meaning of the [from] field depends on the transaction type: - Transfer: [from] is the source account. - TransferFrom: [from] is the approver. - Approve: [from] is the approver.

• optional AccountIdentifier to = 2

  The meaning of the [to] field depends on the transaction type: - Transfer: [to] is the destination account. - TransferFrom: [to] is the destination account. - Approve: [to] is the default account id of the approved principal.

• optional Tokens amount = 3

  If the transaction type is Approve, the amount must be zero.

• optional Tokens max_fee = 4

• oneof extension

  We represent metadata of new operation types as submessages for backward compatibility with old clients.

  • Approve approve = 5

  • TransferFrom transfer_from = 6

Make a payment

• optional Memo memo = 1

• optional Payment payment = 2

• optional Tokens max_fee = 3

• optional Subaccount from_subaccount = 4

• optional AccountIdentifier to = 5

• optional BlockIndex created_at = 6

• optional TimeStamp created_at_time = 7

• optional BlockIndex resulting_height = 1

Used in: NotifyRequest, SendRequest, TransactionNotificationRequest

• bytes sub_account = 1

Used in: Approve, Block, LedgerArchiveRequest, SendRequest, Transaction

• uint64 timestamp_nanos = 1

Get the length of the chain with a certification

(message has no fields)

• optional Certification certification = 1

• optional BlockIndex chain_length = 2

** BASIC TYPES **

Used in: Account, AccountBalanceResponse, Approve, Burn, Mint, NotifyRequest, Payment, Send, SendRequest, TotalSupplyResponse, TransactionNotificationRequest, TransferFeeResponse

• uint64 e8s = 1

Used in: CyclesNotificationResponse

(message has no fields)

How many Tokens are there not in the minting account

(message has no fields)

• optional Tokens total_supply = 1

Used in: Block

• oneof transfer

  • Burn burn = 1

  • Mint mint = 2

  • Send send = 3

• optional Memo memo = 4

• optional Icrc1Memo icrc1_memo = 7

• optional BlockIndex created_at = 5

  obsolete

• optional TimeStamp created_at_time = 6

• optional ic_base_types.pb.v1.PrincipalId from = 1

• optional Subaccount from_subaccount = 2

• optional ic_base_types.pb.v1.PrincipalId to = 3

• optional Subaccount to_subaccount = 4

• optional BlockIndex block_height = 5

• optional Tokens amount = 6

• optional Memo memo = 7

• bytes response = 1

(message has no fields)

• optional Tokens transfer_fee = 1

Used in: Send

• optional AccountIdentifier spender = 1

  The default account id of the principal who sent the transaction.