TransferServerSEP24Service class

Implements SEP-0024 - Hosted Deposit and Withdrawal. See <https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md" target="_blank">Hosted Deposit and Withdrawal

Constructors

TransferServerSEP24Service(String _transferServiceAddress, {Client? httpClient})

Properties

hashCode → int
The hash code for this object.
no setterinherited
httpClient ↔ Client
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deposit(SEP24DepositRequest request) → Future<SEP24InteractiveResponse>
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. The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. It also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit.
fee(SEP24FeeRequest request) → Future<SEP24FeeResponse>
Get the anchor's to reported fee that would be charged for a given deposit or withdraw operation. This is important to allow an anchor to accurately report fees to a user even when the fee schedule is complex. If a fee can be fully expressed with the fee_fixed, fee_percent or fee_minimum fields in the /info response, then an anchor will not implement this endpoint.
info([String? lang]) → Future<SEP24InfoResponse>
Get the anchors basic info about what their TRANSFER_SERVER_SEP0024 support to wallets and clients. lang Language code specified using ISO 639-1. description fields in the response should be in this language. Defaults to en.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
transaction(SEP24TransactionRequest request) → Future<SEP24TransactionResponse>
The transaction endpoint enables clients to query/validate a specific transaction at an anchor. Anchors must ensure that the SEP-10 JWT included in the request contains the Stellar account and optional memo value used when making the original deposit or withdraw request that resulted in the transaction requested using this endpoint. Throws a RequestErrorException if the server responds with an error and corresponding error message. Throws a SEP24AuthenticationRequiredException if the server responds with an authentication_required error. Throws a SEP24TransactionNotFoundException if the server could not find the transaction.
transactions(SEP24TransactionsRequest request) → Future<SEP24TransactionsResponse>
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. It returns a list of transactions from the account encoded in the authenticated JWT.
withdraw(SEP24WithdrawRequest request) → Future<SEP24InteractiveResponse>
This operation allows a user to redeem an asset currently on the Stellar network for the real asset (BTC, USD, stock, etc...) via the anchor of the Stellar asset. The withdraw endpoint allows a wallet to get withdrawal information from an anchor, so a user has all the information needed to initiate a withdrawal. It also lets the anchor specify the url for the interactive webapp to continue with the anchor's side of the withdraw.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromDomain(String domain, {Client? httpClient}) → Future<TransferServerSEP24Service>
Creates an instance of this class by loading the transfer server sep 24 url from the given domain stellar toml file.