`transaction.proto`

path sdk/transaction/transaction.proto

package m10.sdk.transaction

Messages

`Action`

Name	Type	Description
`tx_id`	`uint64`	Transaction ID of the action.
`name`	`string`	Name of the action.
`context_id`	`bytes`	[optional] unique Context ID, allowing linking of multiple requests
`from_account`	`bytes`	Invoking account ID.
`target`	`Target`	Target acount ID of the action.
`payload`	`bytes`	Action payload.

`Actions`

Name	Type	Description
`actions`	repeated `Action`	List of actions.

`CommitThreshold`

Amount-based commit threshold tier; applies when transfer amount >= min_amount.

Name	Type	Description
`min_amount`	`uint64`
`min_commits`	`uint32`

`CommitTransfer`

Name	Type	Description
`pending_tx_id`	`uint64`	Transaction ID of the pending transfer.
`new_state`	`CommitTransfer.TransferState`	New state of the transfer.

`CreateLedgerAccount`

Name	Type	Description
`parent_id`	`bytes`	Parent account ID.
`issuance`	`bool`	Whether this is an issuance account.
`frozen`	`bool`	Whether the account is initially frozen.
`instrument`	`Instrument`	Instrument associated with the account.
`balance_limit`	`uint64`	Balance limit for the account.
`issuance_limit`	`uint64`	Maximum issued balance for issuance accounts. 0 = unlimited.
`min_commits`	`uint32`	Minimum distinct ACCEPT commits to finalize a pending transfer from this account. 0 = 1 commit.
`commit_thresholds`	repeated `CommitThreshold`	Amount-based tiers; effective threshold is the highest applicable min_commits.

`CreateLedgerTransfer`

Name	Type	Description
`ledger_id`	`string`	Ledger identifier.
`nonce`	`uint64`	Nonce for replay protection.
`transfer`	`CreateTransfer`	Transfer details.

`CreateLedgerTransfers`

Name	Type	Description
`transfers`	repeated `CreateLedgerTransfer`	Ledger transfers
`valid_until`	`uint64`	UTC timestamp defining the end date of the contract Interpret as microseconds since the UNIX_EPOCH

`CreateLock`

Name	Type	Description
`lock_id`	`bytes`	Unique identifier for this lock (client-generated, e.g. UUID bytes).
`cycle_id`	`bytes`	The settlement cycle this lock belongs to.
`account_id`	`bytes`	The account whose balance is being locked.
`amount`	`uint64`	The amount to reserve.
`reason`	`string`	Human-readable reason. Defaults to "SETTLEMENT".
`settlement_batch_ref`	`bytes`	Optional reference to the settlement batch/cycle document.

`CreateToken`

Name	Type	Description
`address`	`bytes`	Address for the token.
`account_id`	`bytes`	Account ID associated with the token.
`value`	`uint64`	Value of the token.

`CreateTransfer`

Name	Type	Description
`transfer_steps`	repeated `TransferStep`	List of transfer steps.

`FinalizedTransfer`

Name	Type	Description
`tx_id`	`uint64`	Transaction ID of the finalized transfer.
`context_id`	`bytes`	Context ID associated with the transfer.
`transfer_steps`	repeated `TransferStep`	List of transfer steps.
`error`	`TransactionError`	Error information, if any.
`timestamp`	`fixed64`	Timestamp of the transfer.
`state`	`FinalizedTransfer.TransferState`	State of the transfer.

`FinalizedTransfers`

Name	Type	Description
`transfers`	repeated `FinalizedTransfer`	List of finalized transfers.

`GetAccountRequest`

Name	Type	Description
`id`	`bytes`	ID of the account to retrieve.

`GetActionRequest`

Name	Type	Description
`tx_id`	`uint64`	Transaction ID of the action to retrieve.

`GetTransferRequest`

Name	Type	Description
`tx_id`	`uint64`	Transaction ID of the transfer.

`IndexedAccount`

Name	Type	Description
`id`	`bytes`	Account ID.
`issuance`	`IndexedAccount.Issuance`	Issuance information.
`balance`	`uint64`	Account balance.
`frozen`	`bool`	Whether the account is frozen.
`instrument`	`Instrument`	Instrument associated with the account.
`balance_limit`	`uint64`	Balance limit of the account.
`locked_balance`	`uint64`	Sum of active settlement locks on the account.
`available_balance`	`uint64`	Spendable balance after lock reservation.
`display_code`	`string`	Display Code of the account
`min_commits`	`uint32`	Minimum distinct ACCEPT commits required to finalize a transfer. Always at least 1.
`commit_thresholds`	repeated `CommitThreshold`	Amount-based commit threshold tiers.

`IndexedAccount.Issuance`

Name	Type	Description
`issued_balance`	`uint64`	Issued balance of the account.
`non_leaf_children`	`uint64`	Number of non-leaf child accounts.
`leaf_children`	`uint64`	Number of leaf child accounts.
`issuance_limit`	`uint64`	Maximum allowed issued balance. 0 = unlimited.

`Instrument`

Name	Type	Description
`code`	`string`	Instrument code (e.g., currency code).
`decimal_places`	`uint32`	Number of decimal places for the instrument.
`description`	`string`	Description of the instrument.
`display_code`	`string`	Unique display code for the instrument. Equals `code` if not set.

`InvokeAction`

Invokes a registered action by sending an opaque payload to a Target

Name	Type	Description
`name`	`string`	Unique name of the action to invoke
`from_account`	`bytes`	Invoking account ID
`target`	`Target`	Specifies the identity/identities who have permission to see & be notified of the invoked action
`payload`	`bytes`	Opaque payload

`ListActionsRequest`

Name	Type	Description
`name`	`string`	Name of the action to filter by.
`account_id`	`bytes`	Account ID to filter by.
`context_id`	`bytes`	Context ID to filter by.
`limit`	`uint64`	Maximum number of actions to return.
`min_tx_id`	`uint64`	Minimum transaction ID to include.
`max_tx_id`	`uint64`	default = maximum possible tx id / Maximum transaction ID to include.

`ListTransferRequest`

Transfers are returned in descending order from max_tx_id to min_tx_id

Name	Type	Description
`account_id`	`bytes`	Account ID to filter transfers by.
`context_id`	`bytes`	Context ID to filter transfers by.
`limit`	`uint64`	Maximum number of transfers to return.
`include_child_accounts`	`bool`	Whether to include transfers from child accounts.
`min_tx_id`	`uint64`	Minimum transaction ID to include.
`max_tx_id`	`uint64`	default = maximum possible tx id / Maximum transaction ID to include.
`state`	`FinalizedTransfer.TransferState`	State of the transfer.

`LockDocument`

Name	Type	Description
`lock_id`	`bytes`
`cycle_id`	`bytes`
`account_id`	`bytes`
`amount`	`uint64`
`status`	`LockStatus`
`created_at`	`uint64`
`created_by`	`bytes`
`reason`	`string`
`settlement_batch_ref`	`bytes`
`redemption_tx_ref`	`bytes`
`release_tx_ref`	`bytes`

`OfflineToken`

Name	Type	Description
`data`	`OfflineToken.Data`	Token data.
`signature`	`Signature`	Signature for the token.

`OfflineToken.Data`

Name	Type	Description
`id`	`uint64`	Token ID.
`address`	`bytes`	Token address.
`account_id`	`bytes`	Account ID associated with the token.
`value`	`uint64`	Token value.
`currency`	`string`	Currency of the token.

`RedeemLocksForCycle`

Name	Type	Description
`cycle_id`	`bytes`	The settlement cycle being redeemed.
`redemption_tx_ref`	`bytes`	Reference to the confirmed Fedwire settlement transaction.
`steps`	repeated `RedemptionStep`	One entry per lock. All steps are applied atomically.

`RedeemToken`

Name	Type	Description
`token`	`RedeemableToken`	Redeemable token.
`account_id`	`bytes`	Account ID for redemption.

`RedeemableToken`

Name	Type	Description
`data`	`RedeemableToken.Data`	Token data.
`signature`	`Signature`	Signature for the token.

`RedeemableToken.Data`

Name	Type	Description
`id`	`bytes`	Token ID.
`address`	`bytes`	Token address.
`inputs`	repeated `RedeemableToken.TokenInput`	List of token inputs.
`currency`	`string`	Token currency.

`RedeemableToken.TokenInput`

Name	Type	Description
`input`	`uint64`	Input value.
`value`	`uint64`	Value associated with the input.

`RedemptionStep`

Name	Type	Description
`lock_id`	`bytes`
`holder_account_id`	`bytes`
`issuance_account_id`	`bytes`
`amount`	`uint64`

`ReleaseLock`

Name	Type	Description
`lock_id`	`bytes`
`release_ref`	`bytes`	Reference to the release/abort transaction or reason document.

`SetBalanceLimit`

Name	Type	Description
`account_id`	`bytes`	Account ID to set the balance limit for.
`balance_limit`	`uint64`	New balance limit.

`SetDisplayCode`

Name	Type	Description
`account_id`	`bytes`	Account ID to set the display code for.
`display_code`	`string`	New display code

`SetFreezeState`

Name	Type	Description
`account_id`	`bytes`	Account ID to set freeze state for.
`frozen`	`bool`	Whether to freeze the account.

`SetInstrument`

Name	Type	Description
`account_id`	`bytes`	Account ID to set the instrument for.
`code`	`string`	Instrument code.
`decimal_places`	`uint32`	Number of decimal places.
`description`	`string`	Instrument description.
`display_code`	`string`	Unique display code for the instrument.

`SetIssuanceLimit`

Name	Type	Description
`account_id`	`bytes`	Account ID of the issuance account.
`issuance_limit`	`uint64`	New issuance limit. 0 = unlimited.

`SetMinCommits`

Name	Type	Description
`account_id`	`bytes`	Account ID to update.
`min_commits`	`uint32`	New baseline threshold. 0 = revert to default of 1.
`commit_thresholds`	repeated `CommitThreshold`	Replaces the account's commit_thresholds entirely. An empty list clears all tiers.

`SettlementCycle`

Name	Type	Description
`cycle_id`	`bytes`
`asset_id`	`bytes`
`status`	`SettlementCycleStatus`
`cutoff_at`	`uint64`
`settled_at`	`uint64`
`closed_at`	`uint64`
`created_by`	`bytes`
`operator_metadata`	`bytes`

`Signature`

Name	Type	Description
`public_key`	`bytes`	Public key used for the signature.
`signature`	`bytes`	Signature data.
`algorithm`	`Signature.Algorithm`	Signature algorithm.

`Target`

Name	Type	Description
`account_id`	`bytes`	Account ID
`any_account`	`google.protobuf.Empty`	Any Account

`TransactionData`

Name	Type	Description
`transfer`	`CreateTransfer`
`create_ledger_account`	`CreateLedgerAccount`
`set_freeze_state`	`SetFreezeState`
`document_operations`	`m10.sdk.DocumentOperations`
`invoke_action`	`InvokeAction`
`initiate_transfer`	`CreateTransfer`
`commit_transfer`	`CommitTransfer`
`set_instrument`	`SetInstrument`
`set_balance_limit`	`SetBalanceLimit`
`set_issuance_limit`	`SetIssuanceLimit`
`set_display_code`	`SetDisplayCode`
`set_min_commits`	`SetMinCommits`
`create_token`	`CreateToken`
`redeem_token`	`RedeemToken`
`create_lock`	`CreateLock`
`release_lock`	`ReleaseLock`
`redeem_locks_for_cycle`	`RedeemLocksForCycle`

`TransactionError`

Name	Type	Description
`code`	`TransactionError.Code`	Error code.
`message`	`string`	Error message.

`TransactionRequestPayload`

Decoded `LedgerRequest.payload` message data for requests related to transactions and ledger state.

Name	Type	Description
`nonce`	`uint64`	Replay protection
`timestamp`	`uint64`	UNIX timestamp in microseconds
`context_id`	`bytes`	[optional] unique Context ID, allowing linking of multiple requests
`data`	`TransactionData`	Request payload data.

`TransactionResponse`

Name	Type	Description
`tx_id`	`uint64`	Unique transaction ID.
`error`	`TransactionError`	Error information, if any.
`timestamp`	`fixed64`	Transaction timestamp.
`account_created`	`bytes`	Responses / account ID.
`transfer_committed`	`CreateTransfer`	Committed transfer details.
`token`	`OfflineToken`

`TransferStep`

Name	Type	Description
`from_account_id`	`bytes`	Source account ID.
`to_account_id`	`bytes`	Destination account ID.
`amount`	`uint64`	Amount to transfer.
`metadata`	repeated `google.protobuf.Any`	Metadata associated with the transfer step.

Enums

`CommitTransfer.TransferState`

Name	Number	Description
`ACCEPTED`	`0`
`REJECTED`	`1`

`FinalizedTransfer.TransferState`

Name	Number	Description
`ACCEPTED`	`0`
`REJECTED`	`1`
`PENDING`	`2`
`EXPIRED`	`3`
`TRANSFER_STATE_UNSPECIFIED`	`4`	Sentinel value used only as a filter in requests; not stored on finalized transfers.

`LockStatus`

Name	Number	Description
`ACTIVE`	`0`
`REDEEMED`	`1`
`RELEASED`	`2`

`SettlementCycleStatus`

Name	Number	Description
`OPEN`	`0`
`LOCKED`	`1`
`CASH_SETTLED`	`2`
`CLOSED`	`3`
`ABORTED`	`4`

`Signature.Algorithm`

Name	Number	Description
`P256_SHA256_ASN1`	`0`
`ED25519`	`1`
`ED25519_PH_SHA_512`	`2`

`TransactionError.Code`

Name	Number	Description
`UNKNOWN`	`0`	Generic status codes
`UNIMPLEMENTED`	`1`
`NOT_FOUND`	`2`
`ALREADY_EXISTS`	`3`
`UNAUTHORIZED`	`4`
`INTERNAL`	`46`
`BAD_REQUEST`	`5`	Request is malformed
`INVALID_REQUEST_TYPE`	`6`	Invalid/unsupported transaction request type
`INVALID_ACCOUNT_ID`	`7`	Invalid account ID
`INVALID_TRANSFER`	`8`	Invalid transfer parameters (amount, accounts, etc)
`MESSAGE_TOO_LARGE`	`10`	The request message was too large to be processed.
`INVALID_SIGNATURE`	`11`	The request signature does not match the request payload
`VERIFICATION_FAILED`	`12`	Signature verification failed
`REPLAY_PROTECTION`	`20`	Replay protection was triggered, e.g. nonce reuse, bad block window
`INVALID_EXPRESSION`	`21`	Invalid expression used
`INCORRECT_TYPE`	`22`
`ACCOUNT_FROZEN`	`23`	Ledger-specific status codes
`UNMODIFIED_STATE`	`24`
`INSUFFICIENT_BALANCE`	`25`
`BALANCE_OVERFLOW`	`26`
`ACCOUNT_DEPTH_EXCEEDED`	`27`
`HOLDING_LIMIT_EXCEEDED`	`28`
`ISSUANCE_LIMIT_EXCEEDED`	`29`
`INVALID_TARGET`	`30`	Action specific status codes
`DISPLAY_CODE_CONFLICT`	`40`	Instrument specific status codes
`INVALID_DISPLAY_CODE`	`41`
`INSUFFICIENT_AVAILABLE_BALANCE`	`42`	Settlement lock specific status codes
`LOCK_NOT_FOUND`	`43`
`INVALID_LOCK_STATE`	`44`
`DUPLICATE_LOCK_ID`	`45`	next free is 47
`COMMIT_ALREADY_RECORDED`	`47`	Multi-commit threshold status codes

Messages​

Action​

Actions​

CommitThreshold​

CommitTransfer​

CreateLedgerAccount​

CreateLedgerTransfer​

CreateLedgerTransfers​

CreateLock​

CreateToken​

CreateTransfer​

FinalizedTransfer​

FinalizedTransfers​

GetAccountRequest​

GetActionRequest​

GetTransferRequest​

IndexedAccount​

IndexedAccount.Issuance​

Instrument​

InvokeAction​

ListActionsRequest​

ListTransferRequest​

LockDocument​

OfflineToken​

OfflineToken.Data​

RedeemLocksForCycle​

RedeemToken​

RedeemableToken​

RedeemableToken.Data​

RedeemableToken.TokenInput​

RedemptionStep​

ReleaseLock​

SetBalanceLimit​

SetDisplayCode​

SetFreezeState​

SetInstrument​

SetIssuanceLimit​

SetMinCommits​

SettlementCycle​

Signature​

Target​

TransactionData​

TransactionError​

TransactionRequestPayload​

TransactionResponse​

TransferStep​

Enums​

CommitTransfer.TransferState​

FinalizedTransfer.TransferState​

LockStatus​

SettlementCycleStatus​

Signature.Algorithm​

TransactionError.Code​