Stellar PHP SDK API Documentation

StellarSDK

Table of Contents

Packages

Crypto
Exceptions
Requests
Responses
SEP
Soroban
Util

Interfaces

TransactionBuilderAccount
Interface for accounts used in transaction building.

Classes

AbstractOperation
Base class for all Stellar operations.
AbstractTransaction
Abstract base class for all Stellar transaction types
Account
Represents a Stellar account with sequence number management
AccountFlag
Account flags control authorization and trust settings for Stellar accounts.
AccountMergeOperation
Represents an account merge operation.
AccountMergeOperationBuilder
Builder for creating AccountMerge operations.
AllowTrustOperation
Represents an allow trust operation.
AllowTrustOperationBuilder
Builder for creating AllowTrust operations.
Asset
Base class representing an asset on the Stellar network
AssetTypeCreditAlphanum
Base class for alphanumeric credit assets issued on the Stellar network
AssetTypeCreditAlphanum12
Represents an issued asset with a 5-12 character alphanumeric code
AssetTypeCreditAlphanum4
Represents an issued asset with a 1-4 character alphanumeric code
AssetTypeNative
Represents the native XLM asset on the Stellar network
AssetTypePoolShare
Represents a liquidity pool share asset in the Stellar network.
BeginSponsoringFutureReservesOperation
Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.
BeginSponsoringFutureReservesOperationBuilder
Builder for creating BeginSponsoringFutureReserves operations.
BumpSequenceOperation
Represents a bump sequence operation.
BumpSequenceOperationBuilder
Builder for creating BumpSequence operations.
ChangeTrustOperation
Represents a change trust operation.
ChangeTrustOperationBuilder
Builder for creating ChangeTrust operations.
Claimant
Represents a claimant for claimable balances
ClaimClaimableBalanceOperation
Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.
ClaimClaimableBalanceOperationBuilder
Builder for creating ClaimClaimableBalance operations.
ClawbackClaimableBalanceOperation
Represents clawback claimable balance operation.
ClawbackClaimableBalanceOperationBuilder
Builder for creating ClawbackClaimableBalance operations.
ClawbackOperation
Represents clawback operation.
ClawbackOperationBuilder
Builder for creating Clawback operations.
CryptoConstants
Cryptographic Constants for Stellar StrKey Encoding
NetworkConstants
HTTP Status Code Constants
StellarConstants
Stellar Protocol Constants
CreateAccountOperation
Represents a create account operation.
CreateAccountOperationBuilder
Builder for creating CreateAccount operations.
CreateClaimableBalanceOperation
Represents a create claimable balance operation.
CreateClaimableBalanceOperationBuilder
Builder for creating CreateClaimableBalance operations.
CreateContractHostFunction
Represents a Soroban host function for creating smart contracts
CreateContractWithConstructorHostFunction
Represents a Soroban host function for creating contracts with constructor arguments
CreatePassiveSellOfferOperation
Represents a create passive sell offer operation.
CreatePassiveSellOfferOperationBuilder
Builder for creating CreatePassiveSellOffer operations.
DeploySACWithAssetHostFunction
Represents a Soroban host function for deploying a Stellar Asset Contract (SAC)
DeploySACWithSourceAccountHostFunction
Represents a Soroban host function for deploying a Stellar Asset Contract from a source account
EndSponsoringFutureReservesOperation
Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.
EndSponsoringFutureReservesOperationBuilder
Builder for creating EndSponsoringFutureReserves operations.
ExtendFootprintTTLOperation
Represents an extend footprint TTL operation.
ExtendFootprintTTLOperationBuilder
Builder for creating ExtendFootprintTTL operations.
FeeBumpTransaction
Represents a fee bump transaction
FeeBumpTransactionBuilder
Builder for creating fee bump transactions.
HostFunction
Abstract base class for Soroban smart contract host functions
InvokeContractHostFunction
Represents a Soroban smart contract invocation host function
InvokeHostFunctionOperation
Represents an invoke host function operation.
InvokeHostFunctionOperationBuilder
Builder for creating InvokeHostFunction operations.
LedgerBounds
Represents ledger number bounds as transaction preconditions
LiquidityPoolDepositOperation
Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.
LiquidityPoolDepositOperationBuilder
Builder for creating LiquidityPoolDeposit operations.
LiquidityPoolWithdrawOperation
Represents a Liquidity Pool Withdraw operation.
LiquidityPoolWithdrawOperationBuilder
Builder for creating LiquidityPoolWithdraw operations.
ManageBuyOfferOperation
Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.
ManageBuyOfferOperationBuilder
Builder for creating ManageBuyOffer operations.
ManageDataOperation
Represents ManageData operation.
ManageDataOperationBuilder
Builder for creating ManageData operations.
ManageSellOfferOperation
Represents a Manage Sell Offer operation.
ManageSellOfferOperationBuilder
Builder for creating ManageSellOffer operations.
Memo
Represents a transaction memo in the Stellar network
MuxedAccount
Represents a multiplexed Stellar account
Network
Represents a Stellar network with its unique passphrase
PathPaymentStrictReceiveOperation
Represents Path Payment Strict Receive operation.
PathPaymentStrictReceiveOperationBuilder
Builder for creating PathPaymentStrictReceive operations.
PathPaymentStrictSendOperation
Represents a Path Payment Strict Send operation.
PathPaymentStrictSendOperationBuilder
Builder for creating PathPaymentStrictSend operations.
PaymentOperation
Represents a Payment operation.
PaymentOperationBuilder
Builder for creating Payment operations.
Price
Represents a price as a rational number (fraction) in the Stellar network
RestoreFootprintOperation
Represents a Restore Footprint operation.
RestoreFootprintOperationBuilder
Builder for creating RestoreFootprint operations.
RevokeSponsorshipOperation
Represents a Revoke Sponsorship operation.
RevokeSponsorshipOperationBuilder
Builder for creating RevokeSponsorship operations.
CrossBorderPaymentsService
Implements SEP-0031 - Cross-Border Payments API (for sending anchors).
AnchorTransactionRequestBuilder
Base class for all Horizon API request builders
AnchorTransactionsRequestBuilder
Base class for all Horizon API request builders
FeeRequestBuilder
Base class for all Horizon API request builders
InfoRequestBuilder
Base class for all Horizon API request builders
InteractiveService
Implements SEP-0024 - Hosted Deposit and Withdrawal.
SEP24FeeRequest
SEP24FeeResponse
Base class for all Horizon API response objects
SEP24TransactionsResponse
Base class for all Horizon API response objects
QuoteService
Implements SEP-0038 - Anchor RFQ API v2.5.0.
Currencies
Collection of Currency objects from the stellar.toml file.
Currency
Currency documentation from the stellar.toml [[CURRENCIES]] list.
Documentation
Organization documentation from the stellar.toml DOCUMENTATION table.
GeneralInformation
General information from the stellar.toml file.
PointOfContact
Point of contact documentation from the stellar.toml [[PRINCIPALS]] list.
Principals
Collection of PointOfContact objects from the stellar.toml file.
StellarToml
Represents a parsed stellar.toml file according to SEP-1 specification.
Validator
Validator information from the stellar.toml [[VALIDATORS]] list.
Validators
Collection of Validator objects from the stellar.toml file.
TxRep
SetOptionsOperation
Represents a Set Options operation.
SetOptionsOperationBuilder
Builder for creating SetOptions operations.
SetTrustLineFlagsOperation
Represents a Set Trustline Flags operation.
SetTrustLineFlagsOperationBuilder
Builder for creating SetTrustLineFlags operations.
SignedPayloadSigner
Data model for the <a href="https://github.com/stellar/stellar-protocol/blob/master/core/cap-0040.md#xdr-changes">signed payload signer </a>
Signer
Helper class for creating signer keys used in multi-signature accounts
SorobanContractInfo
Stores information parsed from a soroban contract byte code such as Environment Meta, Contract Spec Entries and Contract Meta Entries.
StellarSDK
Main entry point for interacting with Stellar Horizon servers
TimeBounds
Represents the time validity bounds for a transaction
Transaction
Represents a Stellar transaction that contains a set of operations to be executed atomically
TransactionBuilder
Builds a new Transaction object using the builder pattern
TransactionPreconditions
Transaction preconditions define validation rules for transaction execution.
UploadContractWasmHostFunction
Represents a Soroban host function for uploading contract WASM code
XdrAccountEntry
XdrAccountEntryExt
XdrAccountEntryV1
XdrAccountEntryV1Ext
XdrAccountEntryV2
XdrAccountEntryV2Ext
XdrAccountEntryV3
XdrAccountID
XdrAccountMergeOperation
XdrAccountMergeResult
XdrAccountMergeResultCode
XdrAllowTrustOperation
XdrAllowTrustOperationAsset
XdrAllowTrustResult
XdrAllowTrustResultCode
XdrAsset
XdrAssetAlphaNum12
XdrAssetAlphaNum4
XdrAssetType
XdrBeginSponsoringFutureReservesOperation
XdrBeginSponsoringFutureReservesResult
XdrBeginSponsoringFutureReservesResultCode
XdrBuffer
Enables easy iteration through a blob of XDR data
XdrBumpSequenceOperation
XdrBumpSequenceResult
XdrBumpSequenceResultCode
XdrChangeTrustAsset
XdrChangeTrustOperation
XdrChangeTrustResult
XdrChangeTrustResultCode
XdrClaimableBalanceEntry
XdrClaimableBalanceEntryExt
XdrClaimableBalanceEntryExtV1
XdrClaimableBalanceID
XdrClaimableBalanceIDType
XdrClaimant
XdrClaimantType
XdrClaimantV0
XdrClaimAtom
XdrClaimAtomType
XdrClaimClaimableBalanceOperation
XdrClaimClaimableBalanceResult
XdrClaimClaimableBalanceResultCode
XdrClaimLiquidityAtom
XdrClaimOfferAtom
XdrClaimOfferAtomV0
XdrClaimPredicate
XdrClaimPredicateType
XdrClawbackClaimableBalanceOperation
XdrClawbackClaimableBalanceResult
XdrClawbackClaimableBalanceResultCode
XdrClawbackOperation
XdrClawbackResult
XdrClawbackResultCode
XdrConfigSettingContractBandwidthV0
XdrConfigSettingContractComputeV0
"Compute" settings for contracts (instructions and memory).
XdrConfigSettingContractEventsV0
Contract event-related settings.
XdrConfigSettingContractExecutionLanesV0
XdrConfigSettingContractHistoricalDataV0
XdrConfigSettingContractLedgerCostExtV0
Ledger access settings for contracts.
XdrConfigSettingContractLedgerCostV0
XdrConfigSettingContractParallelComputeV0
Settings for running the contract transactions in parallel.
XdrConfigSettingEntry
XdrConfigSettingID
XdrConfigSettingSCPTiming
XdrConfigUpgradeSetKey
XdrConstantProduct
XdrContractCodeCostInputs
XdrContractCodeEntry
XdrContractCodeEntryExt
XdrContractCodeEntryExtV1
XdrContractCostParamEntry
XdrContractCostParams
XdrContractCostType
XdrContractDataDurability
XdrContractDataEntry
XdrContractEvent
XdrContractEventBody
XdrContractEventBodyV0
XdrContractEventType
XdrContractExecutable
XdrContractExecutableType
XdrContractIDPreimage
XdrContractIDPreimageType
XdrCreateAccountOperation
XdrCreateAccountResult
XdrCreateAccountResultCode
XdrCreateClaimableBalanceOperation
XdrCreateClaimableBalanceResult
XdrCreateClaimableBalanceResultCode
XdrCreateContractArgs
XdrCreateContractArgsV2
XdrCreatePassiveSellOfferOperation
XdrDataEntry
XdrDataEntryExt
XdrDataValue
XdrDataValueMandatory
XdrDecoder
XdrDecoratedSignature
XdrDiagnosticEvent
XdrEncoder
See: https://tools.ietf.org/html/rfc4506
XdrEndSponsoringFutureReservesResult
XdrEndSponsoringFutureReservesResultCode
XdrEnvelopeType
XdrEvictionIterator
XdrExtendFootprintTTLOp
XdrExtendFootprintTTLResult
XdrExtendFootprintTTLResultCode
XdrExtensionPoint
XdrFeeBumpTransaction
XdrFeeBumpTransactionEnvelope
XdrFeeBumpTransactionExt
XdrFeeBumpTransactionInnerTx
XdrHashIDPreimage
XdrHashIDPreimageContractID
XdrHashIDPreimageOperationID
XdrHashIDPreimageRevokeID
XdrHashIDPreimageSorobanAuthorization
XdrHostFunction
XdrHostFunctionType
XdrInflationPayout
XdrInflationResult
XdrInflationResultCode
XdrInnerTransactionResult
XdrInnerTransactionResultPair
XdrInnerTransactionResultResult
XdrInt128Parts
XdrInt256Parts
XdrInvokeContractArgs
XdrInvokeHostFunctionOp
XdrInvokeHostFunctionResult
XdrInvokeHostFunctionResultCode
XdrInvokeHostFunctionSuccessPreImage
XdrLedgerBounds
XdrLedgerEntry
XdrLedgerEntryChange
XdrLedgerEntryChangeType
XdrLedgerEntryData
XdrLedgerEntryExt
XdrLedgerEntryType
XdrLedgerEntryV1
XdrLedgerEntryV1Ext
XdrLedgerFootprint
XdrLedgerKey
XdrLedgerKeyAccount
XdrLedgerKeyContractCode
XdrLedgerKeyContractData
XdrLedgerKeyData
XdrLedgerKeyOffer
XdrLedgerKeyTrustLine
XdrLedgerKeyTTL
XdrLiabilities
XdrLiquidityPoolBody
XdrLiquidityPoolConstantProductParameters
XdrLiquidityPoolDepositOperation
XdrLiquidityPoolDepositResult
XdrLiquidityPoolDepositResultCode
XdrLiquidityPoolEntry
XdrLiquidityPoolParameters
XdrLiquidityPoolType
XdrLiquidityPoolWithdrawOperation
XdrLiquidityPoolWithdrawResult
XdrLiquidityPoolWithdrawResultCode
XdrManageBuyOfferOperation
XdrManageDataOperation
XdrManageDataResult
XdrManageDataResultCode
XdrManageOfferEffect
XdrManageOfferResult
XdrManageOfferResultCode
XdrManageOfferSuccessResult
XdrManageOfferSuccessResultOffer
XdrManageSellOfferOperation
XdrMemo
XdrMemoType
XdrMuxedAccount
XdrMuxedAccountMed25519
XdrOfferEntry
XdrOfferEntryExt
XdrOperation
XdrOperationBody
XdrOperationMeta
XdrOperationMetaV2
XdrOperationResult
XdrOperationResultCode
XdrOperationResultTr
XdrOperationType
XdrPathPaymentResultSuccess
XdrPathPaymentStrictReceiveOperation
XdrPathPaymentStrictReceiveResult
XdrPathPaymentStrictReceiveResultCode
XdrPathPaymentStrictSendOperation
XdrPathPaymentStrictSendResult
XdrPathPaymentStrictSendResultCode
XdrPaymentOperation
XdrPaymentResult
XdrPaymentResultCode
XdrPreconditions
XdrPreconditionsV2
XdrPreconditionType
XdrPrice
XdrRestoreFootprintOp
XdrRestoreFootprintResult
XdrRestoreFootprintResultCode
XdrRevokeSponsorshipOperation
XdrRevokeSponsorshipResult
XdrRevokeSponsorshipResultCode
XdrRevokeSponsorshipSigner
XdrRevokeSponsorshipType
XdrSCAddress
XdrSCAddressType
XdrSCContractInstance
XdrSCEnvMetaEntry
XdrSCEnvMetaKind
XdrSCError
XdrSCErrorCode
XdrSCErrorType
XdrSCMapEntry
XdrSCMetaEntry
XdrSCMetaKind
XdrSCMetaV0
XdrSCNonceKey
XdrSCSpecEntry
XdrSCSpecEntryKind
XdrSCSpecEventDataFormat
XdrSCSpecEventParamLocationV0
XdrSCSpecEventParamV0
XdrSCSpecEventV0
XdrSCSpecFunctionInputV0
XdrSCSpecFunctionV0
XdrSCSpecType
XdrSCSpecTypeBytesN
XdrSCSpecTypeDef
XdrSCSpecTypeMap
XdrSCSpecTypeOption
XdrSCSpecTypeResult
XdrSCSpecTypeTuple
XdrSCSpecTypeUDT
XdrSCSpecTypeVec
XdrSCSpecUDTEnumCaseV0
XdrSCSpecUDTEnumV0
XdrSCSpecUDTErrorEnumCaseV0
XdrSCSpecUDTErrorEnumV0
XdrSCSpecUDTStructFieldV0
XdrSCSpecUDTStructV0
XdrSCSpecUDTUnionCaseTupleV0
XdrSCSpecUDTUnionCaseV0
XdrSCSpecUDTUnionCaseV0Kind
XdrSCSpecUDTUnionCaseVoidV0
XdrSCSpecUDTUnionV0
XdrSCVal
XdrSCValType
XdrSequenceNumber
XdrSetOptionsOperation
XdrSetOptionsResult
XdrSetOptionsResultCode
XdrSetTrustLineFlagsOperation
XdrSetTrustLineFlagsResult
XdrSetTrustLineFlagsResultCode
XdrSignedPayload
XdrSigner
XdrSignerKey
XdrSignerKeyType
XdrSimplePaymentResult
XdrSorobanAddressCredentials
XdrSorobanAuthorizationEntry
XdrSorobanAuthorizedFunction
XdrSorobanAuthorizedFunctionType
XdrSorobanAuthorizedInvocation
XdrSorobanCredentials
XdrSorobanCredentialsType
XdrSorobanResources
XdrSorobanResourcesExtV0
XdrSorobanTransactionData
XdrSorobanTransactionDataExt
XdrSorobanTransactionMeta
XdrSorobanTransactionMetaExt
XdrSorobanTransactionMetaExtV1
XdrSorobanTransactionMetaV2
XdrStateArchivalSettings
XdrTimeBounds
XdrTransaction
XdrTransactionEnvelope
XdrTransactionEvent
Represents a transaction-level event in metadata.
XdrTransactionEventStage
XdrTransactionExt
XdrTransactionMeta
XdrTransactionMetaV1
XdrTransactionMetaV2
XdrTransactionMetaV3
XdrTransactionMetaV4
XdrTransactionResult
XdrTransactionResultCode
XdrTransactionResultExt
XdrTransactionResultResult
XdrTransactionV0
XdrTransactionV0Envelope
XdrTransactionV0Ext
XdrTransactionV1Envelope
XdrTrustlineAsset
XdrTrustLineEntry
XdrTrustLineEntryExt
XdrTrustLineEntryExtensionV2
XdrTrustLineEntryV1
XdrTrustLineEntryV1Ext
XdrTrustLineFlags
XdrTTLEntry
XdrUInt128Parts
XdrUInt256Parts

        
On this page

Search results