metadata.proto
path sdk/metadata.proto
package m10.sdk.metadata
Messages
AccountCurrency
AccountCurrency represents a currency and amount associated with a specific account.
| Name | Type | Description |
|---|---|---|
operator | string | The operator of the account. |
currency | string | The currency code (e.g., USD, EUR). |
account_id | bytes | The ledger account ID. |
amount | uint64 | The amount of the currency. |
Attachment
Attachment represents a file or object linked to a transaction.
| Name | Type | Description |
|---|---|---|
object_id | string | ID of the attached object. |
type | Attachment.AttachmentType | Type of the attachment. |
Contract
Contract represents metadata for a smart contract.
| Name | Type | Description |
|---|---|---|
transactions | bytes | Ledger transactions to be processed, serialized as `CreateLedgerTransfers`. |
endorsements | repeated Endorsement | Endorsements of the contract by authorized parties. Can be signed by multiple parties. |
Deposit
Metadata for a deposit (issue) transaction.
| Name | Type | Description |
|---|---|---|
bank_account_id | string | The bank account the deposit is from. |
Endorsement
Approval of a contract by a ledger.
| Name | Type | Description |
|---|---|---|
ledger_id | string | The ID of the endorsing ledger. |
signature | m10.sdk.transaction.Signature | The signature of the endorsement. |
Fee
Fee is a placeholder for future fee-related metadata. Currently unused.
| Name | Type | Description |
|---|
Memo
Memo contains a plaintext message associated with a transaction.
| Name | Type | Description |
|---|---|---|
plaintext | string | The plaintext message. |
OfflineTransfer
Metadata for an offline transfer.
| Name | Type | Description |
|---|---|---|
input | uint64 | Input value for the offline transfer. |
PaymentRequest
Metadata for a payment request.
| Name | Type | Description |
|---|---|---|
transfer | m10.sdk.transaction.CreateTransfer | The transfer details of a payment request. |
status | PaymentRequest.PaymentRequestStatus | The current status of the payment request. |
QuoteEvent
QuoteEvent represents an event related to a foreign exchange quote.
| Name | Type | Description |
|---|---|---|
request | QuoteRequest | A quote request event. |
proposal | Contract | A quote proposal event. |
QuoteRequest
QuoteRequest represents a request for a foreign exchange quote. Amount should be provided exclusively for either `base` or `target`.
| Name | Type | Description |
|---|---|---|
base | AccountCurrency | The base currency and amount for the quote. |
target | AccountCurrency | The target currency for the quote. |
memo | string | An optional memo associated with the quote request. |
RebalanceTransfer
Metadata for a rebalance transfer.
| Name | Type | Description |
|---|
SelfTransfer
SelfTransfer represents a transfer between accounts owned by the same user.
| Name | Type | Description |
|---|---|---|
from_account_name | string | The source account. |
to_account_name | string | The destination account. |
TokenWithdraw
Metadata for a token withdrawal.
| Name | Type | Description |
|---|
Withdraw
Metadata for a withdraw (redeem) transaction.
| Name | Type | Description |
|---|---|---|
bank_account_id | string | The bank account the withdrawal is to. |
Enums
Attachment.AttachmentType
Enumerates the possible types of attachments.
| Name | Number | Description |
|---|---|---|
OBJECT | 0 | Generic object attachment. |
IMAGE | 1 | Image attachment. |
PaymentRequest.PaymentRequestStatus
Enumerates the possible statuses of a payment request.
| Name | Number | Description |
|---|---|---|
PENDING | 0 | The request is pending |
DECLINED | 1 | The request has been declined |
CANCELED | 2 | The request has been canceled |
IN_PROGRESS | 3 | The request is currently being processed |