`api.proto`

path sdk/api.proto

package m10.sdk

Messages

`BulkTransactions`

A batch of transactions to be created.

Name	Type	Description
`transactions`	repeated `RequestEnvelope`	List of transaction requests.

`BulkTransactionsResponse`

Responses for a bulk transaction creation request.

Name	Type	Description
`responses`	repeated `transaction.TransactionResponse`	List of transaction responses.

`ChainInfo`

Information about the blockchain.

Name	Type	Description
`block_height`	`uint64`	Current block height.

`FinalizedTransaction`

A finalized transaction.

Name	Type	Description
`request`	`transaction.TransactionRequestPayload`	Transaction request.
`response`	`transaction.TransactionResponse`	Transaction response.

`FinalizedTransactions`

A list of finalized transactions.

Name	Type	Description
`transactions`	repeated `FinalizedTransaction`	List of finalized transactions.

`GetAccountSetRequest`

Retrieve a specific AccountSet.

Name	Type	Description
`id`	`bytes`	ID of the AccountSet.

`GetBankRequest`

Retrieve a specific bank.

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

`GetRoleBindingRequest`

The request message for retrieving a specific role binding.

Name	Type	Description
`id`	`bytes`	ID of the role binding.

`GetRoleRequest`

The request message for retrieving a specific role.

Name	Type	Description
`id`	`bytes`	ID of the role.

`GetTransactionRequest`

The request message for retrieving a specific transaction.

Name	Type	Description
`tx_id`	`uint64`	ID of the transaction.

`GroupTransactionsRequest`

The request message for grouping transactions by context ID.

Name	Type	Description
`account_id`	`bytes`	Account ID to filter by.
`limit_groups`	`uint64`	Maximum number of groups to return.
`min_tx_id`	`uint64`	Minimum transaction ID.
`max_tx_id`	`uint64`	Maximum transaction ID.

`GroupedFinalizedTransactions`

A list of grouped finalized transactions.

Name	Type	Description
`groups`	repeated `FinalizedTransactions`	List of grouped transactions.

`ListAccountMetadataRequest`

The request message for listing account metadata.

Name	Type	Description
`owner`	`bytes`	Filter by owner.
`name`	`string`	Filter by name.
`public_name`	`string`	Filter by public name.
`isin`	`string`	Filter by ISIN.
`dti`	`string`	Filter by DTI.
`issuer_bank_id`	`string`	Filter by Issuer Bank ID.
`page`	`Page`	Pagination options.

`ListAccountMetadataResponse`

The response message for listing account metadata.

Name	Type	Description
`accounts`	repeated `model.AccountMetadata`	List of account metadata.
`next_request`	`ListAccountMetadataRequest`	Request for the next page.

`ListAccountSetsRequest`

ListAccountSetsRequest is the request message for listing account sets.

Name	Type	Description
`owner`	`bytes`	Filter by owner.
`name`	`string`	Filter by name.
`page`	`Page`	Pagination options.

`ListAccountSetsResponse`

The response message for listing account sets.

Name	Type	Description
`account_sets`	repeated `model.AccountSet`	List of account sets.
`next_request`	`ListAccountSetsRequest`	Request for next page of results.

`ListBanksRequest`

Request list of banks.

Name	Type	Description
`page`	`Page`	Pagination options.

`ListBanksResponse`

Receive list of banks.

Name	Type	Description
`banks`	repeated `model.Bank`	List of banks.

`ListRoleBindingsRequest`

The request message for listing role bindings.

Name	Type	Description
`name`	`string`	Filter by name.
`subject`	`bytes`	Filter by subject (public key).
`description`	`string`	Filter by description.
`labels`	`MapWrapper`	Filter by labels.
`page`	`Page`	Pagination options.

`ListRoleBindingsResponse`

The response message for listing role bindings.

Name	Type	Description
`role_bindings`	repeated `RoleBinding`	List of role bindings.
`next_request`	`ListRoleBindingsRequest`	Request for next page of results.

`ListRolesRequest`

The request message for listing roles.

Name	Type	Description
`name`	`string`	Filter by name.
`instance_id`	`bytes`	Filter by instance id (bytes).
`description`	`string`	Filter by description.
`labels`	`MapWrapper`	Filter by labels.
`page`	`Page`	Pagination options.

`ListRolesResponse`

The response message for listing roles.

Name	Type	Description
`roles`	repeated `Role`	List of roles.
`next_request`	`ListRolesRequest`	Request for next page of results.

`ListTransactionsRequest`

The request message for listing transactions.

Name	Type	Description
`context_id`	`bytes`	Context ID to filter by.
`limit`	`uint64`	Maximum number of transactions to return.
`min_tx_id`	`uint64`	Minimum transaction ID.
`max_tx_id`	`uint64`	Maximum transaction ID.
`tx_ids`	repeated `uint64`	Optional list of specific transaction IDs to filter by. Takes precedence over min_tx_id, / max_tx_id and context_id if provided.

`ObserveAccountsRequest`

The request message for observing account changes.

Name	Type	Description
`starting_from`	`TxId`	Starting transaction ID for observation.
`involved_accounts`	repeated `bytes`	Account IDs to observe.

`ObserveActionsRequest`

Request message to observe actions.

Name	Type	Description
`starting_from`	`TxId`	Starting transaction ID for observation.
`name`	`string`	Name of the action to observe.
`involves_accounts`	repeated `bytes`	Account IDs involved in the action.

`ObserveResourcesRequest`

ObserveResourcesRequest is the request message for observing resource changes.

Name	Type	Description
`expression`	`Exp`	Expression to filter resources.
`collection`	`string`	Collection to observe.
`starting_from`	`TxId`	Starting transaction ID for observation.

`OfflineKey`

Offline key.

Name	Type	Description
`offline_pk`	`bytes`	The offline public key.

`Page`

A page of results for paginated queries.

Name	Type	Description
`limit`	`uint32`	Limit of results per page.
`last_id`	`bytes`	Last ID from previous page.

`RequestEnvelope`

Wraps a payload with a signature for authentication and authorization.

Name	Type	Description
`payload`	`bytes`	Payload data.
`signature`	`transaction.Signature`	Signature for the payload.

`TransactionMetrics`

Transaction metrics.

Name	Type	Description
`transfer_volume`	`uint64`	Total transfer volume.
`transfer_count`	`uint64`	Number of transfers.
`transfer_errors`	`uint64`	Number of transfer errors.
`accounts_created`	`uint64`	Number of accounts created.

`TxId`

TxId represents a transaction ID.

Name	Type	Description
`tx_id`	`uint64`	ID of the transaction.

Services

`M10QueryService`

Service for querying the ledger.

`GetTransfer`

Method	`GetTransfer`
Request	`RequestEnvelope`
Response	`FinalizedTransfer`
Description	Transfers / Retrieves a specific transfer by ID.

`ListTransfers`

Method	`ListTransfers`
Request	`RequestEnvelope`
Response	`FinalizedTransfers`
Description	Retrieves a list of transfers.

`ObserveTransfers`

Method	`ObserveTransfers`
Request	`RequestEnvelope`
Response	`FinalizedTransactions` stream
Description	Observes transfers. / Param: RequestEnvelope should contain ObserveAccountsRequest

`GetIndexedAccount`

Method	`GetIndexedAccount`
Request	`RequestEnvelope`
Response	`IndexedAccount`
Description	Accounts / Retrieves an indexed account by ID.

`GetAccountMetadata`

Method	`GetAccountMetadata`
Request	`RequestEnvelope`
Response	`AccountMetadata`
Description	Retrieve account metadata.

`GetAccountInfo`

Method	`GetAccountInfo`
Request	`RequestEnvelope`
Response	`AccountInfo`
Description	Retrieve account information.

`ListAccountMetadata`

Method	`ListAccountMetadata`
Request	`RequestEnvelope`
Response	`ListAccountMetadataResponse`
Description	Lists AccountMetadata.

`ObserveAccounts`

Method	`ObserveAccounts`
Request	`RequestEnvelope`
Response	`FinalizedTransactions` stream
Description	Observes account changes. / Param: RequestEnvelope should contain ObserveAccountsRequest

`GetAction`

Method	`GetAction`
Request	`RequestEnvelope`
Response	`Action`
Description	Actions / Retrieves a specific action by ID.

`ListActions`

Method	`ListActions`
Request	`RequestEnvelope`
Response	`Actions`
Description	Retrieves a list of actions.

`ObserveActions`

Method	`ObserveActions`
Request	`RequestEnvelope`
Response	`FinalizedTransactions` stream
Description	Observe actions. / Param: RequestEnvelope should contain ObserveActionsRequest

`GetChainInfo`

Method	`GetChainInfo`
Request	`Empty`
Response	`ChainInfo`
Description	Retrieves chain information.

`GetTransaction`

Method	`GetTransaction`
Request	`RequestEnvelope`
Response	`FinalizedTransaction`
Description	Transactions / Request a specific transaction by ID / Param: RequestEnvelope should contain GetTransactionRequest

`ListTransactions`

Method	`ListTransactions`
Request	`RequestEnvelope`
Response	`FinalizedTransactions`
Description	List transactions. Param: RequestEnvelope should contain ListTransactionsRequest

`GroupTransactions`

Method	`GroupTransactions`
Request	`RequestEnvelope`
Response	`GroupedFinalizedTransactions`
Description	Group transactions. / ID Param: RequestEnvelope should contain GroupTransactionsRequest

`GetAccountSet`

Method	`GetAccountSet`
Request	`RequestEnvelope`
Response	`AccountSet`
Description	AccountSet / Retrieve an AccountSet.

`ListAccountSets`

Method	`ListAccountSets`
Request	`RequestEnvelope`
Response	`ListAccountSetsResponse`
Description	List AccountSets.

`GetRoleBinding`

Method	`GetRoleBinding`
Request	`RequestEnvelope`
Response	`RoleBinding`
Description	RoleBinding / Retrieve role binding.

`ListRoleBindings`

Method	`ListRoleBindings`
Request	`RequestEnvelope`
Response	`ListRoleBindingsResponse`
Description	List role bindings.

`GetRole`

Method	`GetRole`
Request	`RequestEnvelope`
Response	`Role`
Description	RoleBinding / Retrieve a role.

`ListRoles`

Method	`ListRoles`
Request	`RequestEnvelope`
Response	`ListRolesResponse`
Description	List roles.

`ObserveResources`

Method	`ObserveResources`
Request	`RequestEnvelope`
Response	`FinalizedTransactions` stream
Description	Resources Request to observe all resources processed by the ledger / Observes resources. / Param: RequestEnvelope should contain ObserveResourcesRequest

`ObserveMetrics`

Method	`ObserveMetrics`
Request	`RequestEnvelope`
Response	`TransactionMetrics` stream
Description	Metrics Request to observe metrics data processed by the ledger / Observes metrics. / Param: RequestEnvelope should contain ObserveAccountsRequest

`ListBanks`

Method	`ListBanks`
Request	`RequestEnvelope`
Response	`ListBanksResponse`
Description	Banks / Lists banks. / Param: RequestEnvelope should contain ListBanksRequest

`GetBank`

Method	`GetBank`
Request	`RequestEnvelope`
Response	`Bank`
Description	Retrieves a bank. / Param: RequestEnvelope should contain Bank

`GetOfflineKey`

Method	`GetOfflineKey`
Request	`Empty`
Response	`OfflineKey`
Description	Offline / Retrieves an offline key.

`M10TxService`

Service for creating transactions.

`CreateTransaction`

Method	`CreateTransaction`
Request	`RequestEnvelope`
Response	`TransactionResponse`
Description	Create a single transaction.

`BulkCreateTransactions`

Method	`BulkCreateTransactions`
Request	`BulkTransactions`
Response	`BulkTransactionsResponse`
Description	Create multiple transactions.

Messages​

BulkTransactions​

BulkTransactionsResponse​

ChainInfo​

FinalizedTransaction​

FinalizedTransactions​

GetAccountSetRequest​

GetBankRequest​

GetRoleBindingRequest​

GetRoleRequest​

GetTransactionRequest​

GroupTransactionsRequest​

GroupedFinalizedTransactions​

ListAccountMetadataRequest​

ListAccountMetadataResponse​

ListAccountSetsRequest​

ListAccountSetsResponse​

ListBanksRequest​

ListBanksResponse​

ListRoleBindingsRequest​

ListRoleBindingsResponse​

ListRolesRequest​

ListRolesResponse​

ListTransactionsRequest​

ObserveAccountsRequest​

ObserveActionsRequest​

ObserveResourcesRequest​

OfflineKey​

Page​

RequestEnvelope​

TransactionMetrics​

TxId​

Services​

M10QueryService​

GetTransfer​

ListTransfers​

ObserveTransfers​

GetIndexedAccount​

GetAccountMetadata​

GetAccountInfo​

ListAccountMetadata​

ObserveAccounts​

GetAction​

ListActions​

ObserveActions​

GetChainInfo​

GetTransaction​

ListTransactions​

GroupTransactions​

GetAccountSet​

ListAccountSets​

GetRoleBinding​

ListRoleBindings​

GetRole​

ListRoles​

ObserveResources​

ObserveMetrics​

ListBanks​

GetBank​

GetOfflineKey​

M10TxService​

CreateTransaction​

BulkCreateTransactions​