TransferServerService class

Implements SEP-0006 - Deposit and Withdrawal API See Deposit and Withdrawal API

Constructors

TransferServerService(String _transferServiceAddress, {Client? httpClient})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

httpClient ↔ Client

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

deposit(DepositRequest request) → Future<DepositResponse>

A deposit is when a user sends an external token (BTC via Bitcoin, USD via bank transfer, etc...) to an address held by an anchor. In turn, the anchor sends an equal amount of tokens on the Stellar network (minus fees) to the user's Stellar account.

depositExchange(DepositExchangeRequest request) → Future<DepositResponse>

If the anchor supports SEP-38 quotes, it can provide a deposit that makes a bridge between non-equivalent tokens by receiving, for instance BRL via bank transfer and in return sending the equivalent value (minus fees) as USDC to the user's Stellar account.

fee(FeeRequest request) → Future<FeeResponse>

info({String? language, String? jwt}) → Future<InfoResponse>

Get basic info from the anchor about what their TRANSFER_SERVER supports. language (optional) Defaults to en if not specified or if the specified language is not supported. Language code specified using RFC 4646. Error fields and other human readable messages in the response should be in this language. jwt token previously received from the anchor via the SEP-10 authentication flow

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchTransaction(PatchTransactionRequest request) → Future<Response>

toString() → String

A string representation of this object.

inherited

transaction(AnchorTransactionRequest request) → Future<AnchorTransactionResponse>

The transaction endpoint enables clients to query/validate a specific transaction at an anchor.

transactions(AnchorTransactionsRequest request) → Future<AnchorTransactionsResponse>

The transaction history endpoint helps anchors enable a better experience for users using an external wallet. With it, wallets can display the status of deposits and withdrawals while they process and a history of past transactions with the anchor. It's only for transactions that are deposits to or withdrawals from the anchor.

withdraw(WithdrawRequest request) → Future<WithdrawResponse>

A withdraw is when a user redeems an asset currently on the Stellar network for its equivalent off-chain asset via the Anchor. For instance, a user redeeming their NGNT in exchange for fiat NGN.

withdrawExchange(WithdrawExchangeRequest request) → Future<WithdrawResponse>

If the anchor supports SEP-38 quotes, it can provide a withdraw that makes a bridge between non-equivalent tokens by receiving, for instance USDC from the Stellar network and in return sending the equivalent value (minus fees) as NGN to the user's bank account.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromDomain(String domain, {Client? httpClient}) → Future<TransferServerService>