Skip to main content

Module api

Module api 

Source
Expand description

API interaction modules for the OneMoney SDK.

Re-exports§

pub use crate::client::Client;
pub use crate::client::ClientBuilder;
pub use crate::client::Network;

Modules§

accounts
Account-related API operations.
chains
Chain-related API operations.
checkpoints
Checkpoint-related API operations.
common
Common types used throughout the OneMoney SDK.
crypto
Cryptographic utilities for signing and address derivation.
governance
Governance and epoch-related API operations.
multisig
Multi-signature account API endpoints.
requests
API request type definitions.
responses
API response type definitions.
tokens
Token-related API operations.
transaction
transactions
Transaction-related API operations.

Structs§

AccountBBNonce
Account BB nonce information from API response. Matches the L1 server’s AccountInfo structure: { “bbnonce”: u64 }
AccountNonce
Account nonce information from API response. Matches the L1 server’s AccountInfo structure: { “nonce”: u64 }
AssociatedTokenAccount
Represents the token holdings and associated data for a specific address.
ChainIdResponse
Response type for chain ID endpoint
Checkpoint
A checkpoint includes header data and transactions. Header fields are flattened at the top level to match L1 server format.
CheckpointNumber
Checkpoint number response.
EpochResponse
Response containing epoch information and certificate data
FeeEstimate
Fee estimation result. Matches L1 server’s EstimateFee structure: { “fee”: String }
FeeEstimateRequest
Fee estimation request. Matches L1 server’s EstimateFeeRequest structure with string query parameters.
FinalizedTransaction
A finalized transaction with epoch confirmation and validator BLS signatures.
Hash
Represents a transaction hash returned by the API.
HashWithToken
Represents a transaction hash and the token that created by the transaction.
MetadataKVPair
The additional key-value properties for one token.
MintInfo
MintInfo is the struct for token contract. One mint account represents one token.
MinterAllowance
MultiSigSignatureEntry
Multi-signature entry containing both the signature and the signer’s public key
MultiSigSignerInfo
Multi-signature signer information for REST API
PaymentTransactionRequest
Payment transaction request.
RestBlsAggregateSignature
BLS aggregate signature representation for REST API. Contains the aggregated signature, signer bitmask, and validator public keys needed for verification.
RestSignature
ECDSA signature components.
TokenAuthorityRequest
Token authority management request.
TokenBlacklistRequest
Blacklist request for managing token blacklists
TokenBridgeAndMintRequest
Token bridge and mint request.
TokenBurnAndBridgeRequest
Token burn and bridge request.
TokenBurnRequest
Token burn request.
TokenClawbackQuery
Query parameters for token clawback operations.
TokenClawbackRequest
Request parameters for token clawback.
TokenIssueRequest
Request parameters for the token issue.
TokenMetadata
Token metadata for one token.
TokenMetadataUpdateRequest
Token metadata update request.
TokenMintRequest
Request parameters for the token mint.
TokenPauseRequest
Token pause request.
TokenWhitelistRequest
Whitelist request for managing token whitelists
Transaction
TransactionReceipt
Transaction receipt response. Matches L1 server’s TransactionReceipt structure with proper types.
TransactionResponse
Generic transaction response from API operations. All transaction operations return the same format: {“hash”: “string”} Used by payment transactions, token operations, etc.

Enums§

ActionType
Transaction action types.
CertificateData
The encoding format determines which variant is used:
CheckpointTransactions
Checkpoint transactions representation. This can be either transaction hashes or full transaction objects.
TransactionSignature
Transaction signature type - either single signature or multi-signature
TxPayload
Instructions supported by mint token

Type Aliases§

Nonce
Nonce type from L1 primitives