Enumerations

Errors that can occur during Ed25519 cryptographic operations.

These errors indicate issues with key material, signatures, or cryptographic operations related to Ed25519 keypairs used in Stellar.

See more

public enum Ed25519Error : Error, Sendable

Errors that can occur when making requests to the Horizon API server.

See more

public enum HorizonRequestError : Error, Sendable

General errors that can occur during Stellar SDK operations.

See more

public enum StellarSDKError : Error, Sendable

Errors that can occur during base16 encoding or decoding.

See more

public enum Base16EncodingError : Error, Sendable

Errors that can occur during Stellar key decoding.

See more

public enum KeyUtilsError : Error, Sendable

Result enum for federation address resolution requests.

See more

public enum ResolveResponseEnum : Sendable

Result enum for federation server discovery requests.

See more

public enum FederationForDomainEnum : Sendable

Errors that can occur during SEP-0002 federation operations.

This enumeration represents all possible failure cases when resolving Stellar addresses, performing reverse lookups, or communicating with federation servers.

See more

public enum FederationError : Error, Sendable

Errors that occur when parsing TOML documents.

See more

public enum TomlError : Error, Sendable

Result enum for initializing interactive service from a domain.

See more

public enum InteractiveServiceForDomainEnum : Sendable

Result enum for SEP-24 info endpoint requests.

See more

public enum Sep24InfoResponseEnum : Sendable

Result enum for SEP-24 fee endpoint requests.

See more

public enum Sep24FeeResponseEnum : Sendable

Result enum for SEP-24 interactive deposit or withdrawal initiation.

See more

public enum Sep24InteractiveResponseEnum : Sendable

Result enum for SEP-24 transactions list endpoint requests.

See more

public enum Sep24TransactionsResponseEnum : Sendable

Result enum for SEP-24 single transaction status requests.

See more

public enum Sep24TransactionResponseEnum : Sendable

Errors that can occur when interacting with SEP-0024 interactive anchor services.

These errors represent various failure scenarios when communicating with anchors that implement the Hosted Deposit and Withdrawal protocol defined in SEP-0024.

See also:

• [InteractiveService] for the main interactive service implementation
• SEP-0024

See more

public enum InteractiveServiceError : Error, Sendable

Field keys for natural person KYC information as defined in SEP-0009. These keys are used to identify customer data fields in SEP-0012 KYC requests.

public enum KYCNaturalPersonFieldKey : Sendable

KYC field values for natural person customer information as defined in SEP-0009. This enum represents all standard fields that can be submitted in PUT /customer requests for individual customers. Each case contains the field value and converts it to the appropriate multipart/form-data format.

See more

public enum KYCNaturalPersonFieldsEnum : Sendable

Field keys for financial account information as defined in SEP-0009. These keys are used to identify banking and financial account data fields in SEP-0012 KYC requests.

public enum KYCFinancialAccountFieldKey : Sendable

KYC field values for financial account information as defined in SEP-0009. This enum represents banking and financial account fields that can be submitted in PUT /customer requests for receiving deposits or payments. Each case contains the field value and converts it to the appropriate format.

See more

public enum KYCFinancialAccountFieldsEnum : Sendable

Field keys for organization KYC information as defined in SEP-0009. These keys are used to identify corporate/business customer data fields in SEP-0012 KYC requests. All keys use the “organization.” prefix to distinguish them from natural person fields.

public enum KYCOrganizationFieldKey : Sendable

KYC field values for organization customer information as defined in SEP-0009. This enum represents corporate/business entity fields that can be submitted in PUT /customer requests for organizational customers. Each case contains the field value and converts it to the appropriate format.

See more

public enum KYCOrganizationFieldsEnum : Sendable

Field keys for payment card information as defined in SEP-0009. These keys are used to identify credit/debit card data fields in SEP-0012 KYC requests. All keys use the “card.” prefix to distinguish them from other field types.

public enum KYCCardFieldKey : Sendable

KYC field values for payment card information as defined in SEP-0009. This enum represents credit/debit card fields that can be submitted in PUT /customer requests for card-based payment methods. Each case contains the field value and converts it to the appropriate format.

See more

public enum KYCCardFieldsEnum : Sendable

Result enum for initializing KYC service from a domain.

See more

public enum KycServiceForDomainEnum : Sendable

Result enum for SEP-12 get customer info requests.

See more

public enum GetCustomerInfoResponseEnum : Sendable

Result enum for SEP-12 put customer info requests.

See more

public enum PutCustomerInfoResponseEnum : Sendable

Result enum for SEP-12 delete customer requests.

See more

public enum DeleteCustomerResponseEnum : Sendable

Result enum for SEP-12 put customer callback requests.

See more

public enum PutCustomerCallbackResponseEnum : Sendable

Result enum for SEP-12 post customer file requests.

See more

public enum PostCustomerFileResponseEnum : Sendable

Result enum for SEP-12 get customer files requests.

See more

public enum GetCustomerFilesResponseEnum : Sendable

Errors that can occur when interacting with SEP-0012 KYC service endpoints. These errors represent various failure conditions during KYC operations including service initialization, authentication, request validation, and data processing.

See more

public enum KycServiceError : Error, Sendable

Represents supported BIP-39 mnemonic word lists in different languages.

BIP-39 defines standardized word lists for generating mnemonic phrases in multiple languages. Each list contains exactly 2048 words carefully selected to be unambiguous and easy to write.

All supported languages produce compatible mnemonics that encode the same entropy, allowing users to choose their preferred language for mnemonic generation and recovery.

Supported languages:

• English (default and most widely used)
• Chinese (Simplified and Traditional)
• French
• Italian
• Japanese
• Korean
• Spanish

See also:

• BIP-39 Word Lists

See more

public enum WordList : Sendable

Result enum for SEP-38 info endpoint requests.

See more

public enum Sep38InfoResponseEnum : Sendable

Result enum for SEP-38 prices endpoint requests.

See more

public enum Sep38PricesResponseEnum : Sendable

Result enum for SEP-38 price endpoint requests.

See more

public enum Sep38PriceResponseEnum : Sendable

Result enum for SEP-38 quote requests (create and retrieve).

See more

public enum Sep38QuoteResponseEnum : Sendable

Errors that can occur when interacting with the Quote Service (SEP-38).

This enum represents all possible error conditions that may arise during quote service operations, including validation errors, HTTP errors, and response parsing failures.

See SEP-38: Quote Service

See more

public enum QuoteServiceError : Error, Sendable

Result enum for SEP-30 account operations (register, update, get, delete).

See more

public enum Sep30AccountResponseEnum : Sendable

Result enum for SEP-30 transaction signing requests.

See more

public enum Sep30SignatureResponseEnum : Sendable

Result enum for SEP-30 list accounts requests.

See more

public enum Sep30AccountsResponseEnum : Sendable

Errors that can occur when interacting with a SEP-30 account recovery service.

See more

public enum RecoveryServiceError : Error, Sendable

Response enum for creating a RegulatedAssetsService instance from a domain.

Returned by RegulatedAssetsService.forDomain() methods.

See more

public enum RegulatedAssetsServiceForDomainEnum : Sendable

Response enum for checking if an asset requires authorization.

Returned by RegulatedAssetsService.authorizationRequired() methods.

See more

public enum AuthorizationRequiredEnum : Sendable

Response enum for posting a transaction to a SEP-08 approval server.

Returned by RegulatedAssetsService.postTransaction() methods. Represents the various possible outcomes defined in SEP-08.

See more

public enum PostSep08TransactionEnum : Sendable

Response enum for posting action data to a SEP-08 action URL.

Returned by RegulatedAssetsService.postAction() methods when responding to an action_required status.

See more

public enum PostSep08ActionEnum : Sendable

Errors that can occur during regulated assets service operations.

See more

public enum RegulatedAssetsServiceError : Error, Sendable

Enumeration of all available effect types on the Stellar network. Effects represent specific changes that occur to the ledger as a result of operations in successfully submitted transactions. See Stellar developer docs

See more

public enum EffectType : Int, Sendable

Enumeration of all Stellar operation types. Each operation type corresponds to a specific action that can be performed on the Stellar network.

See more

public enum OperationType : Int32, Sendable

Errors that can occur when creating fee bump transactions.

See more

public enum FeeBumpTransactionError : Error, Sendable

The memo contains optional extra information. It is the responsibility of the client to interpret this value. See Stellar developer docs

Memos can be one of the following types:

• none: Empty memo.
• text: A string encoded using either ASCII or UTF-8, up to 28-bytes long.
• id: A 64 bit unsigned integer.
• hash: A 32 byte hash.
• returnHash: A 32 byte hash intended to be interpreted as the hash of the transaction the sender is refunding.

See more

public enum Memo : Sendable

extension Memo: MemoProtocol

extension Memo:MemoHashProtocol

extension Memo: Equatable

Represents a Stellar network and its network passphrase.

Each Stellar network (public, testnet, futurenet, or custom) has a unique network passphrase that is used to derive transaction IDs. The network passphrase is hashed together with the transaction envelope to ensure transactions created for one network cannot be replayed on another network.

You must specify the correct network when building and submitting transactions. Using the wrong network passphrase will result in transaction rejection.

Example:

// Build transaction for public network
let transaction = try Transaction(
    sourceAccount: account,
    operations: [operation],
    memo: .none
)
try transaction.sign(keyPair: keyPair, network: .public)

// Build transaction for testnet
try transaction.sign(keyPair: keyPair, network: .testnet)

// Build transaction for custom network
try transaction.sign(keyPair: keyPair, network: .custom(passphrase: "My Custom Network"))

See also:

• Stellar developer docs

See more

public enum Network : Sendable

Result enum for account details requests.

See more

public enum AccountResponseEnum : Sendable

Result enum for account data field requests.

See more

public enum DataForAccountResponseEnum : Sendable

Result enum for test account creation requests.

See more

public enum CreateTestAccountResponseEnum : @unchecked Sendable

Result enum for claimable balance details requests.

See more

public enum ClaimableBalanceDetailsResponseEnum : Sendable

Defines effect stream filter options for real-time effect updates.

See more

public enum EffectsChange : Sendable

Result enum for fee statistics requests.

See more

public enum FeeStatsResponseEnum : Sendable

Result enum for health check requests.

See more

public enum HealthCheckResponseEnum : Sendable

Result enum for ledger details requests.

See more

public enum LedgerDetailsResponseEnum : Sendable

Defines ledger stream filter options for real-time ledger updates.

See more

public enum LedgersChange : Sendable

Result enum for liquidity pool details requests.

See more

public enum LiquidityPoolDetailsResponseEnum : Sendable

Result enum for liquidity pool trades requests.

See more

public enum LiquidityPoolTradesResponseEnum : Sendable

Defines offer stream filter options for real-time DEX offer updates.

See more

public enum OffersChange : Sendable

Result enum for offer details requests.

See more

public enum OfferResponseEnum : Sendable

Result enum for operation details requests.

See more

public enum OperationDetailsResponseEnum : Sendable

Defines operation stream filter options for real-time operation updates.

See more

public enum OperationsChange : Sendable

Result enum for orderbook requests.

See more

public enum OrderbookResponseEnum : Sendable

Configuration for orderbook streaming filters.

See more

public enum OrderbookChange : Sendable

Result enum for payment path finding requests.

See more

public enum PaymentPathsResponseEnum : Sendable

Defines payment stream filter options for real-time payment updates.

See more

public enum PaymentsChange : Sendable

Represents the possible responses from a Server-Sent Events (SSE) stream connection.

See more

public enum StreamResponseEnum<Data> : Sendable where Data : Decodable, Data : Sendable

Defines trade stream filter options for real-time DEX trade updates.

See more

public enum TradesChange : Sendable

Result enum for transaction details requests.

See more

public enum TransactionDetailsResponseEnum : Sendable

Result enum for transaction submission requests.

Includes a special case for SEP-29 compliance when a destination requires a memo.

See more

public enum TransactionPostResponseEnum : Sendable

Result enum for async transaction submission requests.

Async submission returns immediately after validation without waiting for ledger inclusion.

See more

public enum TransactionPostAsyncResponseEnum : Sendable

Result enum for SEP-29 memo requirement checks.

See more

public enum CheckMemoRequiredResponseEnum : Sendable

Defines transaction stream filter options for real-time transaction updates.

See more

public enum TransactionsChange : Sendable

Thrown if the SorobanContractParser failed parsing the given byte code.

See more

public enum SorobanContractParserError : Error, Sendable

Response enum for health check requests.

Represents the result of a Soroban RPC health check operation.

See more

public enum GetHealthResponseEnum : Sendable

Response enum for network information requests.

Returned when querying general information about the Soroban network configuration.

See more

public enum GetNetworkResponseEnum : Sendable

Response enum for fee statistics requests.

Contains inclusion fee statistics used for transaction prioritization and spam prevention.

See more

public enum GetFeeStatsResponseEnum : Sendable

Response enum for version information requests.

Returns RPC and Captive Core version information.

See more

public enum GetVersionInfoResponseEnum : Sendable

Response enum for ledger entries requests.

Used when reading the current value of ledger entries directly, including contract state.

See more

public enum GetLedgerEntriesResponseEnum : Sendable

Response enum for latest ledger requests.

Returns information about the most recent known ledger.

See more

public enum GetLatestLedgerResponseEnum : Sendable

Response enum for transaction simulation requests.

Contains simulation results including return values, resource costs, and ledger footprint for a contract invocation without submitting to the network.

See more

public enum SimulateTransactionResponseEnum : Sendable

Response enum for transaction submission requests.

Returned when submitting a transaction to the Soroban network. Note that submission does not wait for completion.

See more

public enum SendTransactionResponseEnum : Sendable

Response enum for transaction status requests.

Used to poll for transaction completion status after submission.

See more

public enum GetTransactionResponseEnum : Sendable

Response enum for transactions list requests.

Returns a paginated list of transactions starting from a specified ledger.

See more

public enum GetTransactionsResponseEnum : Sendable

Response enum for events query requests.

Returns contract events emitted within a specified ledger range.

See more

public enum GetEventsResponseEnum : Sendable

Response enum for account nonce requests.

Returns the current nonce for an account.

See more

public enum GetNonceResponseEnum : Sendable

Response enum for ledgers list requests.

Returns a paginated list of ledgers starting from a specified point.

See more

public enum GetLedgersResponseEnum : Sendable

Response enum for contract code requests.

Returns the WebAssembly bytecode for a deployed contract.

See more

public enum GetContractCodeResponseEnum : Sendable

Response enum for contract information requests.

Returns parsed contract metadata including spec entries, environment info, and contract metadata.

See more

public enum GetContractInfoEnum : Sendable

Response enum for account information requests.

Returns minimal account information needed for transaction construction.

See more

public enum GetAccountResponseEnum : Sendable

Response enum for contract data requests.

Returns the current value of contract storage entries.

See more

public enum GetContractDataResponseEnum : Sendable

Errors that occur during Soroban assembled transaction lifecycle operations.

See more

public enum AssembledTransactionError : Error, Sendable

Errors that occur when parsing, validating, or converting Soroban contract specifications.

See more

public enum ContractSpecError : Error, Sendable

Errors that can occur during high-level SorobanClient operations.

These errors represent failures in contract installation, deployment, and invocation operations performed through SorobanClient.

Error cases:

• deployFailed: Contract deployment failed
• installFailed: Contract installation (WASM upload) failed
• invokeFailed: Contract method invocation failed
• methodNotFound: Attempted to invoke a non-existent contract method

Example error handling:

do {
    let result = try await client.invokeMethod(
        name: "transfer",
        args: [from, to, amount]
    )
    print("Success: \(result)")
} catch SorobanClientError.invokeFailed(let message) {
    print("Invocation failed: \(message)")
} catch SorobanClientError.methodNotFound(let message) {
    print("Method not found: \(message)")
} catch {
    print("Other error: \(error)")
}

See also:

• [SorobanClient] for operations that may throw these errors

See more

public enum SorobanClientError : Error, Sendable

Errors that can occur during Soroban RPC requests.

These errors represent failures in communication with the Soroban RPC server or problems processing RPC responses.

Error cases:

• requestFailed: The HTTP request to the RPC server failed
• errorResponse: The RPC server returned an error response
• parsingResponseFailed: The response could not be parsed

Example error handling:

let response = await server.simulateTransaction(simulateTxRequest: request)
switch response {
case .success(let simulation):
    // Handle success
    break
case .failure(let error):
    switch error {
    case .requestFailed(let message):
        print("Request failed: \(message)")
    case .errorResponse(let error):
        print("RPC error: code=\(error.code), message=\(error.message ?? "none")")
    case .parsingResponseFailed(let message, _):
        print("Failed to parse response: \(message)")
    }
}

See also:

• [SorobanServer] for RPC operations that may throw these errors

See more

public enum SorobanRpcRequestError : Error, Sendable

Errors that can occur when loading a stellar.toml file from a domain.

See more

public enum TomlFileError : Error, Sendable

Errors that can occur when loading a linked currency TOML file from a URL.

Per SEP-0001, a stellar.toml can link to separate TOML files for individual currencies using toml=“https://DOMAIN/.well-known/CURRENCY.toml” as the currency’s only field.

See more

public enum TomlCurrencyLoadError : Error, Sendable

Result type for stellar.toml loading operations.

See more

public enum TomlForDomainEnum : Sendable

Result type for currency TOML loading operations.

See more

public enum TomlCurrencyFromUrlEnum : Sendable

Result enum for creating a TransferServerService instance from a domain’s stellar.toml file.

See more

public enum TransferServerServiceForDomainEnum : Sendable

Result enum for SEP-6 deposit requests.

See more

public enum DepositResponseEnum : Sendable

Result enum for SEP-6 withdrawal requests.

See more

public enum WithdrawResponseEnum : Sendable

Result enum for SEP-6 anchor information requests.

See more

public enum AnchorInfoResponseEnum : Sendable

Result enum for SEP-6 transaction history requests.

See more

public enum AnchorTransactionsResponseEnum : Sendable

Result enum for SEP-6 individual transaction requests.

See more

public enum AnchorTransactionResponseEnum : Sendable

Result enum for SEP-6 fee calculation requests (deprecated, use SEP-38 /price endpoint).

See more

public enum AnchorFeeResponseEnum : Sendable

Represents the type of customer information needed for a transfer operation.

This enum differentiates between non-interactive customer information requests and customer information status responses in SEP-6 transfer operations.

See also:

• SEP-0006 Specification

See more

public enum InformationNeededEnum : Sendable

Errors that can occur during SEP-6 transfer server operations.

This enum represents all possible error conditions when interacting with a transfer server for deposit and withdrawal operations according to SEP-6.

See also:

• SEP-0006 Specification
• [TransferServerService] for SEP-6 implementation

See more

public enum TransferServerError : Error, Sendable

The type of transaction.

Indicates whether the transaction is a deposit, withdrawal, or an exchange variant.

See SEP-6 Transaction

See more

public enum AnchorTransactionKind : String, Sendable

The processing status of a deposit or withdrawal transaction.

These statuses track the lifecycle of a transaction from initiation through completion, including various pending states that require action from different parties.

See SEP-6 Transaction Object

See more

public enum AnchorTransactionStatus : String, Sendable

Errors that can occur during TxRep parsing or generation.

See more

public enum TxRepError : Error, Sendable

An enum used to differentiate between a successful and a failed transaction setup.

See more

public enum SetupTransactionXDREnum : Sendable

An enum used to differentiate between a successful and a failed transaction submission.

See more

public enum SubmitTransactionEnum : Sendable

An enum used for the sign transaction parameters for URIScheme creation.

See more

public enum SignTransactionParams : Sendable

An enum used for the pay operation parameters for URIScheme creation.

See more

public enum PayOperationParams : Sendable

Errors thrown by the uri scheme

See more

public enum URISchemeErrors : Sendable

An enum used to differentiate between successful and failed URL signing operations.

See more

public enum SignURLEnum : Sendable

An enum used to differentiate between successful and failed URIScheme validity checks.

See more

public enum URISchemeIsValidEnum : Sendable

The connection state of an EventSource instance.

Tracks the lifecycle of the Server-Sent Events connection from initial connection through active streaming to final closure.

See more

public enum EventSourceState : Sendable

Sort order for Horizon API list requests.

Used when querying collections of resources (transactions, operations, etc.) to specify whether results should be returned in chronological or reverse chronological order.

Example:

// Get most recent transactions first
sdk.transactions.getTransactions(order: .descending) { response in
    // ...
}

See more

public enum Order : String, Sendable

Errors that occur during WebAuthenticator initialization.

See more

public enum WebAuthenticatorError : Error, Sendable

Challenge validation errors.

See more

public enum ChallengeValidationError : Error, Sendable

Possible errors received from a JWT token response.

See more

public enum GetJWTTokenError : Error, Sendable

Result enum for creating a WebAuthenticator instance from a domain’s stellar.toml file.

See more

public enum WebAuthenticatorForDomainEnum : Sendable

Result enum for SEP-10 challenge transaction requests.

See more

public enum ChallengeResponseEnum : Sendable

Result enum for submitting signed challenge transactions.

See more

public enum SendChallengeResponseEnum : Sendable

Result enum for complete SEP-10 authentication flow.

See more

public enum GetJWTTokenResponseEnum : Sendable

Result enum for challenge transaction validation.

See more

public enum ChallengeValidationResponseEnum : Sendable

Errors that occur during contract challenge validation for SEP-45 Web Authentication for Contracts. These errors represent validation failures when processing challenge authorization entries.

See more

public enum ContractChallengeValidationError : Error, Sendable

Errors that occur during WebAuthForContracts initialization and configuration. These errors represent failures when setting up the SEP-45 authentication service.

See more

public enum WebAuthForContractsError : Error, Sendable

Errors that occur during runtime SEP-45 authentication operations. These errors represent failures when executing the authentication flow to obtain a JWT token.

See more

public enum GetContractJWTTokenError : Error, Sendable

Result enum for creating a WebAuthForContracts instance from a domain’s stellar.toml file.

See more

public enum WebAuthForContractsForDomainEnum : Sendable

Result enum for complete SEP-45 authentication flow.

See more

public enum GetContractJWTTokenResponseEnum : Sendable

Result enum for SEP-45 contract challenge transaction requests.

See more

public enum GetContractChallengeResponseEnum : Sendable

Result enum for submitting signed contract challenge authorization entries.

See more

public enum SubmitContractChallengeResponseEnum : Sendable