stellar-sdk/com.soneso.stellar.sdk

Package-level declarations

Types

AbstractTransaction

abstract class AbstractTransaction(val network: Network)

Abstract base class for transaction classes.

Account

class Account : TransactionBuilderAccount

Represents an account in the Stellar network with its sequence number.

AccountMergeOperation

data class AccountMergeOperation(val destination: String) : Operation

Represents an AccountMerge operation.

Address

class Address(address: String)

Represents a single address in the Stellar network. An address can represent an account, contract, muxed account, claimable balance, or liquidity pool.

AllowTrustOperation

data class AllowTrustOperation(val trustor: String, val assetCode: String, val authorize: Int) : Operation

Represents an AllowTrust operation.

Asset

sealed class Asset : Comparable<Asset>

Base Asset class representing assets on the Stellar network.

AssetTypeCreditAlphaNum

sealed class AssetTypeCreditAlphaNum : Asset

Base class for issued assets (credit assets with an issuer).

AssetTypeCreditAlphaNum12

class AssetTypeCreditAlphaNum12(val code: String, val issuer: String) : AssetTypeCreditAlphaNum

Represents issued assets with codes 5-12 characters long.

AssetTypeCreditAlphaNum4

class AssetTypeCreditAlphaNum4(val code: String, val issuer: String) : AssetTypeCreditAlphaNum

Represents issued assets with codes 1-4 characters long.

AssetTypeNative

data object AssetTypeNative : Asset

Represents the native asset of the Stellar network (Lumens/XLM).

Auth

object Auth

Helper class for signing Soroban authorization entries.

BeginSponsoringFutureReservesOperation

data class BeginSponsoringFutureReservesOperation(val sponsoredId: String) : Operation

Represents a BeginSponsoringFutureReserves operation.

BumpSequenceOperation

data class BumpSequenceOperation(val bumpTo: Long) : Operation

Represents a BumpSequence operation.

ChangeTrustAsset

sealed class ChangeTrustAsset

Represents an asset in a change trust operation on the Stellar network.

ChangeTrustOperation

data class ChangeTrustOperation : Operation

Represents a ChangeTrust operation.

Claimant

data class Claimant(val destination: String, val predicate: ClaimPredicate)

Represents a claimant for a claimable balance.

ClaimClaimableBalanceOperation

data class ClaimClaimableBalanceOperation(val balanceId: String) : Operation

Represents a ClaimClaimableBalance operation.

ClaimPredicate

sealed class ClaimPredicate

Sealed class representing claim predicates for claimable balances.

ClawbackClaimableBalanceOperation

data class ClawbackClaimableBalanceOperation(val balanceId: String) : Operation

Represents a ClawbackClaimableBalance operation.

ClawbackOperation

data class ClawbackOperation(val from: String, val asset: Asset, val amount: String) : Operation

Represents a Clawback operation.

CreateAccountOperation

data class CreateAccountOperation(val destination: String, val startingBalance: String) : Operation

Represents a CreateAccount operation.

CreateClaimableBalanceOperation

data class CreateClaimableBalanceOperation(val asset: Asset, val amount: String, val claimants: List<Claimant>) : Operation

Represents a CreateClaimableBalance operation.

CreatePassiveSellOfferOperation

data class CreatePassiveSellOfferOperation(val selling: Asset, val buying: Asset, val amount: String, val price: Price) : Operation

Represents a CreatePassiveSellOffer operation.

DecoratedSignature

data class DecoratedSignature(val hint: ByteArray, val signature: ByteArray)

Represents a decorated signature on a Stellar transaction.

EndSponsoringFutureReservesOperation

class EndSponsoringFutureReservesOperation : Operation

Represents an EndSponsoringFutureReserves operation.

ExtendFootprintTTLOperation

data class ExtendFootprintTTLOperation(val extendTo: Int) : Operation

Represents an ExtendFootprintTTL operation.

FeeBumpTransaction

class FeeBumpTransaction : AbstractTransaction

Represents a Fee Bump Transaction in the Stellar network.

FeeBumpTransactionBuilder

class FeeBumpTransactionBuilder(innerTransaction: Transaction)

Builder for constructing FeeBumpTransaction instances.

FriendBot

object FriendBot

Helper object for funding test accounts using Stellar's FriendBot service.

InflationOperation

class InflationOperation : Operation

Represents an Inflation operation.

InvokeHostFunctionOperation

data class InvokeHostFunctionOperation(val hostFunction: HostFunctionXdr, val auth: List<SorobanAuthorizationEntryXdr> = emptyList()) : Operation

Represents an InvokeHostFunction operation.

KeyPair

class KeyPair

Holds a Stellar keypair consisting of a public key and optionally a private key (secret seed).

LedgerBounds

data class LedgerBounds(val minLedger: Int, val maxLedger: Int)

LedgerBounds are Preconditions of a transaction per CAP-21

LiquidityPool

data class LiquidityPool(val assetA: Asset, val assetB: Asset, val fee: Int = FEE)

Represents a Liquidity Pool Parameters object on the Stellar network.

LiquidityPoolDepositOperation

data class LiquidityPoolDepositOperation(val liquidityPoolId: String, val maxAmountA: String, val maxAmountB: String, val minPrice: Price, val maxPrice: Price) : Operation

Represents a LiquidityPoolDeposit operation.

LiquidityPoolWithdrawOperation

data class LiquidityPoolWithdrawOperation(val liquidityPoolId: String, val amount: String, val minAmountA: String, val minAmountB: String) : Operation

Represents a LiquidityPoolWithdraw operation.

ManageBuyOfferOperation

data class ManageBuyOfferOperation(val selling: Asset, val buying: Asset, val buyAmount: String, val price: Price, val offerId: Long = 0) : Operation

Represents a ManageBuyOffer operation.

ManageDataOperation

data class ManageDataOperation(val name: String, val value: ByteArray? = null) : Operation

Represents a ManageData operation.

ManageSellOfferOperation

data class ManageSellOfferOperation(val selling: Asset, val buying: Asset, val amount: String, val price: Price, val offerId: Long = 0) : Operation

Represents a ManageSellOffer operation.

Memo

sealed class Memo

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

MemoHash

class MemoHash : Memo

Represents MEMO_HASH - a 32-byte hash.

MemoId

data class MemoId(val id: ULong) : Memo

Represents MEMO_ID - a 64-bit unsigned integer.

MemoNone

data object MemoNone : Memo

Represents MEMO_NONE - an empty memo with no additional information.

MemoReturn

class MemoReturn : Memo

Represents MEMO_RETURN - a 32-byte hash intended to be interpreted as the hash of the transaction the sender is refunding.

MemoText

class MemoText : Memo

Represents MEMO_TEXT - a UTF-8 string up to 28 bytes long.

MuxedAccount

class MuxedAccount

Represents a multiplexed (muxed) account on Stellar's network.

Network

data class Network(val networkPassphrase: String)

Network class is used to specify which Stellar network you want to use. Each network has a networkPassphrase which is hashed to every transaction id.

Operation

sealed class Operation

Abstract base class for all Stellar operations.

PathPaymentStrictReceiveOperation

data class PathPaymentStrictReceiveOperation(val sendAsset: Asset, val sendMax: String, val destination: String, val destAsset: Asset, val destAmount: String, val path: List<Asset> = emptyList()) : Operation

Represents a PathPaymentStrictReceive operation.

PathPaymentStrictSendOperation

data class PathPaymentStrictSendOperation(val sendAsset: Asset, val sendAmount: String, val destination: String, val destAsset: Asset, val destMin: String, val path: List<Asset> = emptyList()) : Operation

Represents a PathPaymentStrictSend operation.

PaymentOperation

data class PaymentOperation(val destination: String, val asset: Asset, val amount: String) : Operation

Represents a Payment operation.

Price

data class Price(val numerator: Int, val denominator: Int)

Represents a price in Stellar, expressed as a fraction.

RestoreFootprintOperation

class RestoreFootprintOperation : Operation

Represents a RestoreFootprint operation.

RevokeSponsorshipOperation

data class RevokeSponsorshipOperation(val sponsorship: Sponsorship) : Operation

Represents a RevokeSponsorship operation.

SetOptionsOperation

data class SetOptionsOperation(val inflationDestination: String? = null, val clearFlags: Int? = null, val setFlags: Int? = null, val masterKeyWeight: Int? = null, val lowThreshold: Int? = null, val mediumThreshold: Int? = null, val highThreshold: Int? = null, val homeDomain: String? = null, val signer: SignerKey? = null, val signerWeight: Int? = null) : Operation

Represents a SetOptions operation.

SetTrustLineFlagsOperation

data class SetTrustLineFlagsOperation(val trustor: String, val asset: Asset, val clearFlags: Int? = null, val setFlags: Int? = null) : Operation

Represents a SetTrustLineFlags operation.

SignerKey

sealed class SignerKey

Represents a Stellar signer key used for transaction authorization.

Sponsorship

sealed class Sponsorship

Sealed class representing the different types of sponsorships that can be revoked.

StrKey

object StrKey

StrKey is a helper class for encoding and decoding Stellar keys to/from strings. Stellar uses a base32 encoding with checksums called "strkey" for human-readable keys.

TimeBounds

data class TimeBounds(val minTime: Long, val maxTime: Long)

TimeBounds represents the time interval that a transaction is valid.

Transaction

class Transaction : AbstractTransaction

Represents a transaction in the Stellar network.

TransactionBuilder

class TransactionBuilder(val sourceAccount: TransactionBuilderAccount, val network: Network)

Builds a new Transaction following the builder pattern.

TransactionBuilderAccount

interface TransactionBuilderAccount

Specifies interface for Account object used in Transaction building.

TransactionPreconditions

data class TransactionPreconditions(val timeBounds: TimeBounds? = null, val ledgerBounds: LedgerBounds? = null, val minSequenceNumber: Long? = null, val minSequenceAge: Long = 0, val minSequenceLedgerGap: Int = 0, val extraSigners: List<SignerKey> = emptyList())

Preconditions of a transaction per CAP-21

Util

object Util

Utility functions for the Stellar SDK.