M10Sdk class

M10Sdk provides access to the M10 platform's ledger service APIs.

Available extensions

• M10Actions

Constructors

M10Sdk({required Signing signer, required List<Ledger> ledgers, bool disableTls = false})

Creates a new M10Sdk instance.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

ledgers ← List<Ledger>

Updates the list of ledgers to connect to.

no getter

randomContextId → String

Generates a random context ID.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceClients → Map<String, ServiceClient>

Cached service clients for interacting with the gRPC API.

final

signer → Signing

The signer used to sign requests sent to the platform.

final

Methods

cancel({required String operator, required String fromAccountId, required String targetAccountId, required String contextId}) → Future<TransactionResponseDoc>

Available on M10Sdk, provided by the M10Actions extension

Cancels a payment request.

copyWithSigner(Signing signer) → M10Sdk

Creates a copy of the current M10Sdk instance with a new signer.

createAccount({required String parentId, required String operator, String? name, String? publicName, String? owner, String? profileImageUrl, int? balanceLimit, String? contextId}) → Future<String>

Creates a new account.

createContract() → ContractBuilder

Creates a new contract builder instance.

createEncodedTransferEnvelope({required String fromAccountId, required String toAccountId, required int amount, required String operator, String memo = '', List<Attachment> attachments = const [], Contract? contract, String? contextId, SelfTransfer? selfTransfer}) → Future<String>

Creates an encoded transfer envelope for an offline transfer.

createEncodedTransferEnvelopeFromCreateTransfer({required CreateTransfer createTransfer, String? contextId}) → Future<String>

Creates an encoded transfer envelope from a CreateTransfer object.

createLedgerAccount({required String parentId, required String operator, int? balanceLimit, String? contextId}) → Future<String>

Creates a new ledger account.

createRole({required String operator, required String name, String? id, String? owner, List<RuleDoc>? rules, String? contextId, IdType roleIdType = IdType.hex}) → Future<String?>

Creates a new role.

createRoleBinding({required String operator, required String role, required String name, String? id, List<String>? subjects, List<Expression>? expressions, String? contextId, IdType roleBindingIdType = IdType.hex}) → Future<String?>

Creates a new role binding.

createToken({required String accountId, required Int64 value, required String operator, String? address, String? contextId}) → Future<(TransactionResponse, OfflineToken)>

Creates a transferable offline token.

createTransfer({required String fromAccountId, required String toAccountId, required int amount, required String operator, String memo = '', List<Attachment> attachments = const [], Contract? contract, String? contextId, SelfTransfer? selfTransfer}) → Future<TransactionResponseDoc>

Creates a simplified transfer between accounts.

createUser({required String operator, String? contextId, String? id}) → Future<String>

Creates a new user account.

decline({required String operator, required String fromAccountId, required String targetAccountId, required String contextId}) → Future<TransactionResponseDoc>

Available on M10Sdk, provided by the M10Actions extension

Declines a payment request.

deleteRole({required String id, required String operator, String? contextId}) → Future

Deletes an existing role.

deleteUser({required String userId, required String operator, String? contextId}) → Future<String>

Deletes an existing user account.

enhance(TransferDoc transfer) → Future<List<EnhancedTransferStepDoc>>

Enhances transfer steps with additional account information.

enhanceTransferStep(String operator, TransferStep step) → Future<EnhancedTransferStepDoc>

Enhances a single transfer step with additional account information.

enhanceTransferSteps(List<TransferStep> steps, {required String operator}) → Future<List<EnhancedTransferStepDoc>>

Enhances a list of transfer steps with additional account information.

findAccountByName({required String name, required String operator}) → Future<List<AccountMetadataDoc>>

Finds accounts by name.

findAccountByOwner({required String owner, required String operator}) → Future<List<AccountMetadataDoc>>

Finds accounts owned by a specific public key.

getAccountInfo({required String id, required String operator}) → Future<AccountInfo>

Retrieves information about an existing account.

getAccountInfoCached({required String id, required String operator}) → Future<AccountInfo>

Retrieves information about an existing account, using cache if available.

getAccountMetadata({required String id, required String operator}) → Future<AccountMetadataDoc>

Retrieves metadata for an existing account.

getAction({required int txId, required String operator}) → Future<ActionDoc>

Retrieves information about an action.

getChainInfo({required String operator}) → Future<ChainInfo>

Available on M10Sdk, provided by the M10Actions extension

Retrieves a list of payment requests for a specific account.

getChannel(String operator) → ClientChannel

Retrieves a ClientChannel instance for a specific operator.

getRole({required String id, required String operator}) → Future<RoleDoc>

Retrieves information about a specific role.

getRoleBinding({required String id, required String operator}) → Future<RoleBindingDoc>

Retrieves information about a specific role binding.

getServiceClient(String operator) → ServiceClient

Retrieves a ServiceClient instance for a specific operator.

getTransaction({required String operator, required int txId}) → Future<TransactionDoc>

Retrieves information about a transaction.

getTransfer({required int txId, required String operator}) → Future<TransferDoc>

Retrieves information about a transfer.

getUser({required String userId, required String operator}) → Future<AccountSetDoc>

Retrieves information about an existing user account.

groupTransactions({required String operator, required String accountId, int minTxId = 0, int maxTxId = 0, int limitGroups = 10}) → Future<List<List<TransactionDoc>>>

Groups transactions for a specific account.

invokeAction({required String operator, required String name, required String fromAccountId, String? targetAccountId, bool targetAll = false, List<int> payload = const [], String? contextId}) → Future<TransactionResponseDoc>

Initiates or commits an action on an account.

issueToken({required String toAddress, required String currencyCode, required Int64 value, required List<RedeemableToken_TokenInput> tokenInputs}) → Future<RedeemableToken>

Issues a signed redeemable token.

listActions({required String operator, required String name, String? accountId, Uint8List? contextId, int minTxId = 0, int maxTxId = 0, int limit = 10}) → Future<List<ActionDoc>>

Retrieves a list of actions.

listRequests({required String operator, required String accountId, int minTxId = 0, int maxTxId = 0, int limit = 10}) → Future<List<PaymentRequestDoc>>

Available on M10Sdk, provided by the M10Actions extension

Retrieves a list of payment requests for a specific account.

listRole({required String name, required String operator}) → Future<List<RoleDoc>>

Retrieves a list of roles.

listRoleBindings({required String name, required String operator}) → Future<List<RoleBindingDoc>>

Retrieves a list of role bindings.

listTransactions({required String operator, required String contextId, int minTxId = 0, int maxTxId = 0, int limit = 10}) → Future<List<TransactionDoc>>

Retrieves a list of transactions for a specific context.

listTransfers({required String operator, String? accountId, String? contextId, int? maxTxId, int minTxId = 0, int limit = 10, bool includeChildAccounts = false}) → Future<List<TransferDoc>>

Retrieves a list of transfers.

listUsers({required String operator, required QueryFilter filter}) → Future<List<AccountSetDoc>>

Retrieves a list of existing users.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

observeActions({required String operator, required String name, required List<String> accounts, Int64? startingFrom}) → Future<Stream<List<ActionDoc>>>

Observes actions for a specific action name and accounts.

observeMetrics({required String operator, required List<String> accounts, Int64? startingFrom}) → Future<Stream<TransactionMetricsDoc>>

Observes transaction metrics for a list of accounts.

observeRequests({required String operator, required List<String> accounts, Int64? startingFrom}) → Future<Stream<List<PaymentRequestDoc>>>

Observes payment requests for a list of accounts.

observeResources({required String operator, required String expression, required String collection, Map<String, Value> variables = const {}, Int64? startingFrom}) → Future<Stream<List<ResourceResultDoc>>>

Observes resources based on a query expression.

observeTransfers({required String operator, required List<String> accounts, Int64? startingFrom}) → Future<Stream<List<TransferResultDoc>>>

Observes transfers for a list of accounts.

redeemToken({required RedeemableToken token, required String accountId, required String operator, String? contextId}) → Future<Int64>

Credits a redeemable offline token to a ledger account.

request({required String operator, required CreateTransfer transferRequest, String? contextId}) → Future<TransactionResponseDoc>

Available on M10Sdk, provided by the M10Actions extension

Initiates a payment request.

requestEnvelope({required GeneratedMessage request, List<int>? contextId}) → Future<RequestEnvelope>

Creates a RequestEnvelope containing a signed request message.

toString() → String

A string representation of this object.

inherited

transfer({required List<TransferStepDoc> steps, required String operator, String? contextId, bool commit = true}) → Future<TransactionResponseDoc>

Initiates or commits a transfer.

updateAccount({required String id, required String operator, String? name, String? publicName, String? profileImageUrl, String? contextId}) → Future<int>

Updates an existing account.

updateAccountStatus({required String id, required String operator, required bool frozen, String? contextId}) → Future<void>

Updates the status of a ledger account.

updateRole({required String id, required String operator, String? name, String? owner, List<RuleDoc>? rules, String? contextId}) → Future

Updates an existing role.

updateRoleBinding({required String id, required String operator, List<String>? subjects, String? contextId}) → Future

Updates an existing role binding.

updateUser({required String userId, required String operator, String? defaultCurrency, String? contextId, List<String> accounts = const []}) → Future<String>

Updates an existing user account.

Operators

operator ==(Object other) → bool

The equality operator.

inherited