stellar_dart library

Support for doing something awesome.

More dartdocs go here.

Classes

AccountEntry
AccountEntryExt
AccountEntryExtensionV1
AccountEntryExtensionV2
AccountEntryExtensionV2Ext
AccountEntryExtensionV3
AccountEntryExtensionV3Ext
AccountMergeOperation
AccountMerge Transfers native balance to destination account. Threshold: high Result : AccountMergeResult
AccountMergeResult
AccountMergeResultCode
AccountMergeResultSuccess
AccountMergeResultVoid
AllowTrustOperation
Updates the "authorized" flag of an existing trust line this is called by the issuer of the related asset.
AllowTrustResult
AllowTrustResultCode
AllowTrustResultVoid
AssetCode
AssetCode12
AssetCode4
AssetType
AsyncTransactionSubmissionResponse
AuthFlag
BeginSponsoringFutureReservesOperation
BeginSponsoringFutureReserves Establishes the is-sponsoring-future-reserves-for relationship between the source account and sponsoredID Threshold: med Result: BeginSponsoringFutureReservesResult
BeginSponsoringFutureReservesResult
BeginSponsoringFutureReservesResultCode
BeginSponsoringFutureReservesResultVoid
BumpSequenceOperation
Bump Sequence increases the sequence to a given level Threshold: low Result: BumpSequenceResult
BumpSequenceResult
BumpSequenceResultCode
BumpSequenceResultVoid
ChangeTrustOperation
Creates, updates or deletes a trust line Threshold: med Result: ChangeTrustResult
ChangeTrustResult
ChangeTrustResultCode
ChangeTrustResultVoid
ClaimableBalanceEntry
ClaimableBalanceEntryExt
ClaimableBalanceEntryExtensionV1
ClaimableBalanceId
ClaimableBalanceIdType
ClaimableBalanceIdV0
Claimant
ClaimantType
ClaimantV0
ClaimAtom
ClaimAtomType
ClaimClaimableBalanceOperation
Claims a claimable balance entry Threshold: low Result: ClaimClaimableBalanceResult
ClaimClaimableBalanceResult
ClaimClaimableBalanceResultCode
ClaimClaimableBalanceResultVoid
ClaimLiquidityAtom
ClaimOfferAtom
ClaimOfferAtomV0
ClaimPredicate
ClaimPredicateAnd
ClaimPredicateBeforeAbsoluteTime
ClaimPredicateBeforeRelativeTime
ClaimPredicateNot
ClaimPredicateOr
ClaimPredicateType
ClaimPredicateUnconditional
ClawbackClaimableBalanceOperation
Claws back a claimable balance Threshold: med Result: ClawbackClaimableBalanceResult
ClawbackClaimableBalanceResult
ClawbackClaimableBalanceResultCode
ClawbackClaimableBalanceResultVoid
ClawbackOperation
Claws back an amount of an asset from an account Threshold: med Result: ClawbackResult
ClawbackResult
ClawbackResultCode
ClawbackResultVoid
ConfigSetting
ConfigSettingBucketlistSizeWindow
ConfigSettingContractBandwidthV0
Bandwidth related data settings for contracts. We consider bandwidth to only be consumed by the transaction envelopes, hence this concerns only transaction sizes.
ConfigSettingContractComputeV0
ConfigSettingContractEventsV0
Contract event-related settings.
ConfigSettingContractExecutionLanesV0
General “Soroban execution lane” settings
ConfigSettingContractHistoricalDataV0
Historical data (pushed to core archives) settings for contracts.
ConfigSettingContractLedgerCostV0
Ledger access settings for contracts.
ConfigSettingContractStateArchivalSettings
ConfigSettingEntry
ConfigSettingEvictionIterator
ConfigSettingId
ConfingSettingContractCostParamsCpuInstructions
ConfingSettingContractCostParamsMemoryBytes
ConfingSettingContractDataEnterySizeBytes
ConfingSettingContractDataKeySizeBytes
ConfingSettingContractMaxSizeBytes
ContractCodeCostInputs
ContractCodeEntry
ContractCodeEntryExt
ContractCodeEntryV1
ContractCostParamEntry
ContractDataDurability
ContractDataEntry
ContractExecutable
ContractExecutableStellarAsset
ContractExecutableType
ContractExecutableWasmHash
ContractIdPreimage
ContractIdPreimageFromAddress
ContractIdPreimageFromAsset
ContractIdPreimageType
CreateAccountOperation
Creates and funds a new account with the specified starting balance. Threshold: med Result: CreateAccountResult
CreateAccountResult
CreateAccountResultCode
CreateAccountResultVoid
CreateClaimableBalanceOperation
Creates a claimable balance entry Threshold: med Result: CreateClaimableBalanceResult
CreateClaimableBalanceResult
CreateClaimableBalanceResultCode
CreateClaimableBalanceResultSuccess
CreateClaimableBalanceResultVoid
CreateContractArgs
CreatePassiveSellOfferOperation
Creates an offer that doesn't take offers of the same price Threshold: med Result: CreatePassiveSellOfferResult
CreatePassiveSellOfferResult
CreatePassiveSellOfferResultSuccess
CreatePassiveSellOfferResultVoid
CryptoKeyType
DataEntry
DecoratedSignature
EndSponsoringFutureReservesOperation
EndSponsoringFutureReservesResult
EndSponsoringFutureReservesResultCode
EndSponsoringFutureReservesResultVoid
Envelope<T extends StellarTransaction>
EnvelopeType
EvictionIterator
ExtendFootprintTTLOperation
Extend the TTL of the entries specified in the readOnly footprint so they will live at least extendTo ledgers from lcl. Threshold: low Result: ExtendFootprintTTLResult
ExtendFootprintTTLResult
ExtendFootprintTTLResultCode
ExtendFootprintTTLResultVoid
ExtensionPointType
ExtentionPointVoid
FeeBumpTransactionEnvelope
FeeStatsResponse
FlagsResponse
HorizonPaginationParams
HorizonPaymentPaginationParams
HorizonPostRequestParam<RESULT, RESPONSE>
HorizonProvider
Facilitates communication with the stellar horizon api by making requests using a provided HorizonProvider.
HorizonRequestAccount
The single account endpoint provides information on a specific account. The balances section in the response will also list all the trustlines this account has established, including trustlines that haven’t been authorized yet. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-an-account
HorizonRequestAccountData
This endpoint represents a single data for a given account. https://developers.stellar.org/docs/data/horizon/api-reference/get-data-by-account-id
HorizonRequestAccountEffects
This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/get-effects-by-account-id
HorizonRequestAccountOffers
This endpoint represents all offers a given account has currently open and can be used in streaming mode. Streaming mode allows you to listen for new offers for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/get-offers-by-account-id
HorizonRequestAccountOperations
This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/get-operations-by-account-id
HorizonRequestAccountPayments
https://developers.stellar.org/docs/data/horizon/api-reference/get-payments-by-account-id
HorizonRequestAccounts
This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-accounts
HorizonRequestAccountTrades
This endpoint represents all trades for a given account and can be used in streaming mode. Streaming mode allows you to listen for trades for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/get-trades-by-account-id
HorizonRequestAccountTransactions
This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/get-transactions-by-account-id
HorizonRequestAssets
This endpoint lists all assets. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-assets
HorizonRequestClaimableBalance
The single claimable balance endpoint provides information on a claimable balance. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-claimable-balance
HorizonRequestClaimableBalanceOperations
This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/cb-retrieve-related-operations
HorizonRequestClaimableBalances
This endpoint lists all available claimable balances. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-claimable-balances
HorizonRequestClaimableBalanceTransactions
This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/cb-retrieve-related-transactions
HorizonRequestDetails
HorizonRequestEffects
This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-effects
HorizonRequestFeeStats
The fee stats endpoint provides information about per-operation fee stats over the last 5 ledgers. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-fee-stats
HorizonRequestLedger
The single ledger endpoint provides information on a specific ledger. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-ledger
HorizonRequestLedgerEffects
This endpoint returns the effects of a specific ledger. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-ledgers-effects
HorizonRequestLedgerOperations
This endpoint returns successful operations in a specific ledger. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-ledgers-operations
HorizonRequestLedgerPayments
This endpoint returns all payment-related operations in a specific ledger. Operation types that can be returned by this endpoint include: create_account, payment, path_payment, and account_merge. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-ledgers-payments
HorizonRequestLedgers
This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-ledgers
HorizonRequestLedgerTransactions
This endpoint represents successful transactions in a given ledger. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-ledgers-transactions
HorizonRequestLiquidityPool
The single liquidity pool endpoint provides information on a liquidity pool. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-liquidity-pool
HorizonRequestLiquidityPoolEffects
This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-related-effects
HorizonRequestLiquidityPoolOperations
This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/lp-retrieve-related-operations
HorizonRequestLiquidityPools
This endpoint lists all available liquidity pools. https://developers.stellar.org/docs/data/horizon/api-reference/list-liquidity-pools
HorizonRequestLiquidityPoolTrades
This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trade created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-related-trades
HorizonRequestLiquidityPoolTransactions
This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/lp-retrieve-related-transactions
HorizonRequestOffer
The single offer endpoint provides information on a specific offer. https://developers.stellar.org/docs/data/horizon/api-reference/get-offer-by-offer-id
HorizonRequestOffers
This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset. https://developers.stellar.org/docs/data/horizon/api-reference/get-all-offers
HorizonRequestOfferTrades
This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/get-trades-by-offer-id
HorizonRequestOperation
The single operation endpoint provides information about a specific operation. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-an-operation
HorizonRequestOperationEffects
This endpoint returns the effects of a specific operation. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-an-operations-effects
HorizonRequestOperations
This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-operations
HorizonRequestOrderBook
The order book endpoint provides an order book's bids and asks and can be used in streaming mode. When filtering for a specific order book, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-an-order-book
HorizonRequestParam<RESULT, RESPONSE>
HorizonRequestParams
HorizonRequestPaymentPaths
The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the destination_amount are returned. https://developers.stellar.org/docs/data/horizon/api-reference/list-strict-receive-payment-paths
HorizonRequestPayments
This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge https://developers.stellar.org/docs/data/horizon/api-reference/list-all-payments
HorizonRequestSendPaymentPaths
The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. For this search, Horizon loads a list of assets that the recipient can receive (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned. https://developers.stellar.org/docs/data/horizon/api-reference/list-strict-send-payment-paths
HorizonRequestSubmitTransaction
This endpoint actually submits a transaction to the Stellar network. It only takes a single, required parameter: the signed transaction. Refer to the Transactions page for details on how to craft a proper one. If you submit a transaction that has already been included in a ledger, this endpoint will return the same response as would’ve been returned for the original transaction submission. This allows for safe resubmission of transactions in error scenarios, as highlighted in the error-handling guide. https://developers.stellar.org/docs/data/horizon/api-reference/submit-a-transaction
HorizonRequestSubmitTransactionAsynchronously
This endpoint submits transactions to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's GET transaction endpoint to wait for the transaction to be included in a ledger and ingested by Horizon. https://developers.stellar.org/docs/data/horizon/api-reference/submit-async-transaction
HorizonRequestTradeAggregations
This endpoint displays trade data based on filters set in the arguments. This is done by dividing a given time range into segments and aggregating statistics, for a given asset pair (base, counter) over each of these segments. The duration of the segments is specified with the resolution parameter. The start and end of the time range are given by startTime and endTime respectively, which are both rounded to the nearest multiple of resolution since epoch. The individual segments are also aligned with multiples of resolution since epoch. If you want to change this alignment, the segments can be offset by specifying the offset parameter.s https://developers.stellar.org/docs/data/horizon/api-reference/list-trade-aggregations
HorizonRequestTrades
This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer. https://developers.stellar.org/docs/data/horizon/api-reference/get-all-trades
HorizonRequestTransaction
The single transaction endpoint provides information on a specific transaction. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-transaction
HorizonRequestTransactionEffects
This endpoint returns the effects of a specific transaction. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-transactions-effects
HorizonRequestTransactionOperations
This endpoint returns Successful operations for a specific transaction. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-transactions-operations
HorizonRequestTransactionPayments
This endpoint returns the payments of a specific transaction. https://developers.stellar.org/docs/data/horizon/api-reference/retrieve-a-transactions-payments
HorizonRequestTransactions
This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time. https://developers.stellar.org/docs/data/horizon/api-reference/list-all-transactions
HorizonServiceResponse
HorizonTransactionPaginationParams
HostFunction
HostFunctionType
HostFunctionTypeCreateContract
HostFunctionTypeInvokeContract
HostFunctionTypeUploadContractWasm
InflationOperation
Inflation Runs inflation Threshold: low Result: InflationResult
InflationPayout
InflationResult
InflationResultCode
InflationResultSuccess
InflationResultVoid
InnerTransactionResultPair
Int128Parts
Int256Parts
InvokeContractArgs
InvokeHostFunctionOperation
Upload Wasm, create, and invoke contracts in Soroban. Threshold: med Result: InvokeHostFunctionResult
InvokeHostFunctionResult
InvokeHostFunctionResultCode
InvokeHostFunctionResultSuccess
InvokeHostFunctionResultVoid
LedgerBounds
LedgerboundsResponse
LedgerEntry
LedgerEntryData
LedgerEntryExt
LedgerEntryExtensionV1
LedgerEntryType
LedgerFootprint
LedgerKey
LedgerKeyAccount
LedgerKeyClaimableBalance
LedgerKeyConfigSetting
LedgerKeyContractCode
LedgerKeyContractData
LedgerKeyData
LedgerKeyLiquidityPool
LedgerKeyOffer
LedgerKeyTrustLine
LedgerKeyTTL
Liabilities
LiquidityPoolConstantProductParameters
LiquidityPoolDepositOperation
Deposit assets into a liquidity pool Threshold: med Result: LiquidityPoolDepositResult
LiquidityPoolDepositResult
LiquidityPoolDepositResultCode
LiquidityPoolDepositResultVoid
LiquidityPoolEntry
LiquidityPoolEntryBody
LiquidityPoolEntryConstantProduct
LiquidityPoolType
LiquidityPoolWithdrawOperation
Withdraw assets from a liquidity pool Threshold: med Result: LiquidityPoolWithdrawResult
LiquidityPoolWithdrawResult
LiquidityPoolWithdrawResultCode
LiquidityPoolWithdrawResultVoid
ManageBuyOfferOperation
Creates, updates or deletes an offer with amount in terms of buying asset Threshold: med Result: ManageBuyOfferResult
ManageBuyOfferResult
ManageBuyOfferResultCode
ManageBuyOfferResultSuccess
ManageBuyOfferResultVoid
ManageDataOperation
Adds, Updates, or Deletes a key value pair associated with a particular account. Threshold: med Result: ManageDataResult
ManageDataResult
ManageDataResultCode
ManageDataResultVoid
ManageOfferEffect
ManageOfferEffectCreated
ManageOfferEffectDeleted
ManageOfferEffectType
ManageOfferEffectUpdated
ManageOfferSuccessResult
ManageSellOfferOperation
Creates, updates or deletes an offer Threshold: med Result: ManageSellOfferResult
ManageSellOfferResult
ManageSellOfferResultCode
ManageSellOfferResultSuccess
ManageSellOfferResultVoid
MemoType
MuxedAccount
MuxedAccountEd25519
MuxedAccountMed25519
OfferEntry
OfferEntryResult
Operation<T extends OperationBody>
OperationBody
OperationInner
OperationLevel
OperationResult
OperationResultCode
OperationResultOpInner
OperationResultVoid
OperationType
PathPaymentStrictReceiveOperation
send an amount to a destination account through a path. Threshold: med Result: PathPaymentStrictReceiveResult
PathPaymentStrictReceiveResult
PathPaymentStrictReceiveResultCode
PathPaymentStrictReceiveResultNoIssuer
PathPaymentStrictReceiveResultSuccesss
PathPaymentStrictReceiveResultVoid
PathPaymentStrictSendOperation
send an amount to a destination account through a path. Threshold: med Result: PathPaymentStrictSendResult
PathPaymentStrictSendResult
PathPaymentStrictSendResultCode
PathPaymentStrictSendResultVoid
PaymentOperation
Send an amount in specified asset to a destination account. Threshold: med Result: PaymentResult
PaymentResult
PaymentResultCode
PaymentResultVoid
Preconditions
PreconditionsResponse
PreconditionsV2
PreconditionType
PrecondNone
PrecondTime
PrecondV2
RequestAssetType
RequestTradeType
RestoreFootprintOperation
Restore the archived entries specified in the readWrite footprint. Threshold: low Result: RestoreFootprintOp
RestoreFootprintResult
RestoreFootprintResultCode
RestoreFootprintResultVoid
RevokeSponsorship
RevokeSponsorshipLedgerKey
RevokeSponsorshipOperation
If source account is not sponsored or is sponsored by the owner of the specified entry or sub-entry, then attempt to revoke the sponsorship. If source account is sponsored, then attempt to transfer the sponsorship to the sponsor of source account. Threshold: med Result: RevokeSponsorshipResult
RevokeSponsorshipResult
RevokeSponsorshipResultCode
RevokeSponsorshipResultVoid
RevokeSponsorshipSigner
RevokeSponsorshipType
ScAddress
ScAddressAccountId
ScAddressContract
ScAddressType
ScContractInstance
ScError
ScErrorCode
ScErrorContract
ScErrorType
ScMapEntry<K extends ScVal, V extends ScVal>
ScNonceKey
ScVal<T>
ScValAddress
ScValBoolean
ScValBytes
ScValDuration
ScValError
ScValI128
ScValI256
ScValI32
ScValI64
ScValInstance
ScValKeyContractInstance
ScValMap
ScValNonceKey
ScValString
ScValSymbol
ScValTimePoint
ScValU128
ScValU256
ScValU32
ScValU64
ScValueType
ScValVec
ScValVoid
SetOptionsOperation
Set Account Options updates "AccountEntry" fields. note: updating thresholds or signers requires high threshold Threshold: med or high Result: SetOptionsResult
SetOptionsResult
SetOptionsResultCode
SetOptionsResultVoid
SetTrustLineFlagsOperation
SetTrustLineFlagsOp Updates the flags of an existing trust line. This is called by the issuer of the related asset. Threshold: low Result: SetTrustLineFlagsResult
SetTrustLineFlagsResult
SetTrustLineFlagsResultCode
SetTrustLineFlagsResultVoid
Signer
SignerKey
SignerKeyEd25519
SignerKeyEd25519SignedPayload
SignerKeyHashX
SignerKeyPreAuthTx
SignerKeyType
SignerResponse
SimplePaymentResult
SorobanAddressCredentials
SorobanAPIMethods
SorobanAuthorizationEntry
SorobanAuthorizedFunction
SorobanAuthorizedFunctionType
SorobanAuthorizedFunctionTypeContractFunction
SorobanAuthorizedFunctionTypeCreateContractHostFunction
SorobanAuthorizedInvocation
SorobanCredentials
SorobanCredentialsSourceAccount
SorobanCredentialsType
SorobanEvent
SorobanEventFilter
SorobanEventResponse
SorobanFeeStatsResponse
SorobanHealthResponse
SorobanLastLedgerResponse
SorobanLedgerEntriesResponse
SorobanLedgerEntry
SorobanNetworkResponse
SorobanPaginationParams
https://developers.stellar.org/docs/data/rpc/api-reference/pagination
SorobanRequestGetEvents
Clients can request a filtered list of events emitted by a given ledger range. Soroban-RPC will support querying within a maximum 24 hours of recent ledgers. Note, this could be used by the client to only prompt a refresh when there is a new ledger with relevant events. It should also be used by backend Dapp components to "ingest" events into their own database for querying and serving. If making multiple requests, clients should deduplicate any events received, based on the event's unique id field. This prevents double-processing in the case of duplicate events being received. By default soroban-rpc retains the most recent 24 hours of events. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents
SorobanRequestGetFeeStats
Statistics for charged inclusion fees. The inclusion fee statistics are calculated from the inclusion fees that were paid for the transactions to be included onto the ledger. For Soroban transactions and Stellar transactions, they each have their own inclusion fees and own surge pricing. Inclusion fees are used to prevent spam and prioritize transactions during network traffic surge. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getFeeStats
SorobanRequestGetHealth
General node health check. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getHealth
SorobanRequestGetLatestLedger
For finding out the current latest known ledger of this node. This is a subset of the ledger info from Horizon. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLatestLedger
SorobanRequestGetLedgerEntries
For reading the current value of ledger entries directly. This method enables the retrieval of various ledger states, such as accounts, trustlines, offers, data, claimable balances, and liquidity pools. It also provides direct access to inspect a contract's current state, its code, or any other ledger entry. This serves as a primary method to access your contract data which may not be available via events or simulateTransaction. To fetch contract wasm byte-code, use the ContractCode ledger entry key. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgerEntries
SorobanRequestGetNetwork
General information about the currently configured network. This response will contain all the information needed to successfully submit transactions to the network this node serves. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getNetwork
SorobanRequestGetTransaction
The getTransaction method provides details about the specified transaction. Clients are expected to periodically query this method to ascertain when a transaction has been successfully recorded on the blockchain. The soroban-rpc system maintains a restricted history of recently processed transactions, with the default retention window set at 1440 ledgers, approximately equivalent to a 2-hour timeframe. For private soroban-rpc instances, it is possible to modify the retention window value by adjusting the transaction-retention-window configuration setting. For comprehensive debugging needs that extend beyond the 2-hour timeframe, it is advisable to retrieve transaction information from Horizon, as it provides a lasting and persistent record. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransaction
SorobanRequestGetTransactions
The getTransactions method return a detailed list of transactions starting from the user specified starting point that you can paginate as long as the pages fall within the history retention of their corresponding RPC provider. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransactions
SorobanRequestGetVersionInfo
Version information about the RPC and Captive core. RPC manages its own, pared-down version of Stellar Core optimized for its own subset of needs. we'll refer to this as a "Captive Core" instance. https://developers.stellar.org/docs/data/rpc/api-reference/methods/getVersionInfo
SorobanRequestParam<RESULT, RESPONSE>
SorobanRequestSendTransaction
Submit a real transaction to the Stellar network. This is the only way to make changes on-chain. Unlike Horizon, this does not wait for transaction completion. It simply validates and enqueues the transaction. Clients should call getTransaction to learn about transaction success/failure. This supports all transactions, not only smart contract-related transactions. https://developers.stellar.org/docs/data/rpc/api-reference/methods/sendTransaction
SorobanRequestSimulateTransaction
Submit a trial contract invocation to simulate how it would be executed by the network. This endpoint calculates the effective transaction data, required authorizations, and minimal resource fee. It provides a way to test and analyze the potential outcomes of a transaction without actually submitting it to the network. https://developers.stellar.org/docs/data/rpc/api-reference/methods/simulateTransaction
SorobanResources
SorobanSendTransactionResponse
SorobanTransactionData
SorobanTransactionDataExt
SorobanTransactionResponse
SorobanTransactionsResponse
SorobanVersionInfoResponse
StateArchivalSettings
StellarAccountAddress
Represents a Stellar account address, which is based on an ED25519 public key. Extends StellarAddress and provides additional functionality specific to account addresses.
StellarAccountResponse
StellarAddress
StellarAllTransactionResponse
StellarAsset
StellarAssetBalanceResponse
StellarAssetCreditAlphanum12
StellarAssetCreditAlphanum4
StellarAssetNative
StellarAssetPoolShare
should not be used in some models
StellarAssetResponse
StellarContractAddress
Represents a Stellar contract address, which is based on a contract ID. Extends StellarAddress and provides additional functionality specific to contract addresses.
StellarFeeBumpTransaction
StellarFeeBumpTransactionResponse
StellarFeeStatsResponse
StellarHelper
StellarHorizonMethods
StellarInnerTransactionResponse
StellarLedgerResponse
StellarMemo
StellarMemoHash
StellarMemoID
StellarMemoNone
StellarMemoReturnHash
StellarMemoText
StellarMuxedAddress
Represents a Stellar muxed address, which is a multiplexed account with an account ID. Extends StellarAddress and includes functionality specific to muxed addresses.
StellarNativeBalanceResponse
StellarNetwork
StellarPrice
StellarPrivateKey
Represents a Stellar private key using the Ed25519 cryptographic system.
StellarPublicKey
Represents a Stellar public key using the Ed25519 cryptographic system. Extends XDRSerialization for XDR serialization/deserialization support.
StellarTransaction
StellarTransactionResponse
StellarTransactionV0
StellarTransactionV1
StellarTxStatus
ThresholdsReponse
TimeBounds
TimeboundsResponse
TransactionResult
TransactionResultCode
TransactionResultTxFailed
TransactionResultTxSuccess
TransactionResultType
TransactionResultVoid
TransactionSignaturePayload
TransactionV0Envelope
TransactionV1Envelope
TrustAuthFlag
TrustLineEntry
TrustLineEntryExt
TrustLineEntryExtensionV2
TrustLineEntryV1
TrustLineEntryV2Ext
TrustLineFlag
TTLEntery
UInt128Parts
UInt256Parts
XDRSerialization
XDRVariantDecodeResult
XDRVariantSerialization

Typedefs

ChangeTrustAsset = StellarAsset
with pool asset
TrustLineAsset = StellarAsset
accept poolId