API Reference Elixir Stellar Base v0.8.1

Modules

Allows encoding and decoding signatures used in the Stellar network.

Handle exceptions that may arise from the StellarBase.StrKey implementation.

Representation of Stellar Account type.

Representation of Stellar's ledger AccountEntry

Representation of Stellar AccountEntryExt type.

Representation of Stellar's ledger AccountEntryExtensionV1

Representation of Stellar AccountEntryExtensionV1Ext type.

Representation of Stellar's ledger AccountEntryExtensionV2

Representation of Stellar AccountEntryExtensionV2Ext type.

Representation of Stellar's ledger AccountEntryExtensionV3

Representation of Stellar AccountFlags type.

Representation of Stellar AccountID type.

Representation of a Stellar AccountID list.

Representation of Stellar AlphaNum12 type.

Representation of Stellar AlphaNum4 type.

Representation of Stellar Asset type.

Representation of Stellar AssetCode type.

Representation of Stellar AssetCode12 type.

Module to handle exceptions that may arise from the StellarBase.XDR.AssetCode12 implementation.

Representation of Stellar AssetCode4 type.

Module to handle exceptions that may arise from the StellarBase.XDR.AssetCode4 implementation.

Representation of Stellar AssetType type.

Representation of a Stellar Assets list.

Representation of Stellar ChangeTrustAsset type.

Representation of Stellar ClaimAtom type.

Representation of a Stellar ClaimAtomList list.

Representation of Stellar ClaimAtomType type.

Representation of Stellar ClaimLiquidityAtom type.

Representation of Stellar ClaimOfferAtom type.

Representation of Stellar ClaimOfferAtomV0 type.

Representation of Stellar ClaimPredicate type.

Representation of Stellar ClaimPredicateType type.

Representation of a Stellar Predicates list.

Representation of Stellar ClaimableBalance type.

Representation of Stellar ClaimableBalanceEntry type.

Representation of Stellar ClaimableBalanceEntryExt type.

Representation of Stellar ClaimableBalanceEntryExtV1 type.

Representation of Stellar ClaimableBalanceFlags type.

Representation of Stellar ClaimableBalanceID type.

Representation of Stellar ClaimableBalanceIDType type.

Representation of Stellar PublicKey type.

Representation of Stellar ClaimantType type.

Representation of Stellar ClaimantV0 type.

Representation of a Stellar Claimants list.

Representation of Stellar CryptoKeyType type.

Representation of Stellar Data type.

Representation of Stellar DataEntry type.

Representation of Stellar DataValue type.

Representation of Stellar DecoratedSignature type.

Representation of a Stellar DecoratedSignatures list.

Representation of Stellar Duration type.

Representation of Stellar EnvelopeType type.

Representation of Stellar Ext type.

Representation of Stellar ExtensionPoint type.

Representation of Stellar FeeBumpInnerTx type.

Representation of Stellar FeeBumpTransaction type.

Representation of Stellar FeeBumpTransactionEnvelope type.

Representation of Stellar Hash type.

Representation of Stellar HashIDPreimage type.

Representation of Stellar InflationPayout type.

Representation of a Stellar InflationPayoutList list.

Representation of Stellar InnerTransactionResult type. InnerTransactionResult must be binary compatible with TransactionResult.

Representation of Stellar InnerTransactionResultPair type.

Representation of Stellar Int32 type.

Representation of Stellar Int64 type.

Representation of Stellar LedgerBounds type.

Representation of Stellar's ledger LedgerEntryExtensionV1

Representation of Stellar LedgerEntryType type.

Representation of Stellar LedgerEntry type.

Representation of Stellar Liabilities type.

Representation of Stellar LiquidityPool type.

Representation of Stellar LiquidityPoolConstantProductParameters type.

Representation of Stellar LiquidityPoolParameters type.

Representation of Stellar LiquidityPoolType type.

Representation of Stellar Memo type.

Representation of Stellar MemoType type.

Representation of Stellar MuxedAccount type.

Representation of Stellar MuxedAccountMed25519 type.

Representation of Stellar Offer type.

Representation of Stellar OfferEntry type.

Representation of Stellar OfferEntryFlags type.

Representation of Stellar Opaque12 type.

Representation of Stellar Opaque32 type.

Representation of Stellar Opaque4 type.

Representation of Stellar Operation type.

Representation of Stellar OperationBody type.

Representation of Stellar OperationID type.

Representation of Stellar OperationInnerResult type.

Representation of Stellar OperationResult type.

Representation of Stellar OperationResultCode type.

Representation of a Stellar OperationResultList list.

Representation of Stellar OperationType type.

Representation of a Stellar Operation list.

Representation of Stellar AccountMerge type.

Representation of Stellar AccountMergeResult type.

Representation of Stellar AccountMergeResultCode type.

Representation of Stellar AllowTrust type.

Representation of Stellar AllowTrustResult type.

Representation of Stellar AllowTrustResultCode type.

Representation of Stellar BeginSponsoringFutureReserves type.

Representation of Stellar BeginSponsoringFutureReservesResult type.

Representation of Stellar BeginSponsoringFutureReservesResultCode type.

Representation of Stellar BumpSequence type.

Representation of Stellar BumpSequenceResult type.

Representation of Stellar BumpSequenceResultCode type.

Representation of Stellar ChangeTrust type.

Representation of Stellar ChangeTrustResult type.

Representation of Stellar ChangeTrustResultCode type.

Representation of Stellar ClaimClaimableBalance type.

Representation of Stellar ClaimClaimableBalanceResult type.

Representation of Stellar ClaimClaimableBalanceResultCode type.

Representation of Stellar Clawback type.

Representation of Stellar ClawbackClaimableBalance type.

Representation of Stellar ClawbackClaimableBalanceResult type.

Representation of Stellar ClawbackClaimableBalanceResultCode type.

Representation of Stellar ClawbackResult type.

Representation of Stellar ClawbackResultCode type.

Representation of Stellar CreateAccount type.

Representation of Stellar CreateAccountResult type.

Representation of Stellar CreateAccountResultCode type.

Representation of Stellar CreateClaimableBalance type.

Representation of Stellar CreateClaimableBalanceResult type.

Representation of Stellar CreateClaimableBalanceResultCode type.

Representation of Stellar CreatePassiveSellOffer type.

Representation of Stellar EndSponsoringFutureReservesResult type.

Representation of Stellar EndSponsoringFutureReservesResultCode type.

Representation of Stellar InflationResult type.

Representation of Stellar InflationResultCode type.

Representation of Stellar LiquidityPoolDeposit type.

Representation of Stellar LiquidityPoolDepositResult type.

Representation of Stellar LiquidityPoolDepositResultCode type.

Representation of Stellar LiquidityPoolWithdraw type.

Representation of Stellar LiquidityPoolWithdrawResult type.

Representation of Stellar LiquidityPoolWithdrawResultCode type.

Representation of Stellar ManageBuyOffer type.

Representation of Stellar ManageBuyOfferResult type.

Representation of Stellar ManageBuyOfferResultCode type.

Representation of Stellar ManageData type.

Representation of Stellar ManageDataResult type.

Representation of Stellar ManageDataResultCode type.

Representation of Stellar ManageOffer type.

Representation of Stellar ManageOfferEffect type.

Representation of Stellar ManageOfferSuccessResult type.

Representation of Stellar ManageSellOffer type.

Representation of Stellar ManageSellOfferResult type.

Representation of Stellar ManageSellOfferResultCode type.

Representation of Stellar PathPaymentStrictReceive type.

Representation of Stellar PathPaymentStrictReceiveResult type.

Representation of Stellar PathPaymentStrictReceiveResultCode type.

Representation of Stellar PathPaymentStrictResultSuccess type.

Representation of Stellar PathPaymentStrictSend type.

Representation of Stellar PathPaymentStrictSendResult type.

Representation of Stellar PathPaymentStrictSendResultCode type.

Representation of Stellar Payment type.

Representation of Stellar PaymentResult type.

Representation of Stellar PaymentResultCode type.

Representation of Stellar RevokeSponsorship type.

Representation of Stellar RevokeSponsorshipResult type.

Representation of Stellar RevokeSponsorshipResultCode type.

Representation of Stellar SetOptions type.

Representation of Stellar SetOptionsResult type.

Representation of Stellar SetOptionsResultCode type.

Representation of Stellar SetTrustLineFlags type.

Representation of Stellar SetTrustLineFlagsResult type.

Representation of Stellar SetTrustLineFlagsResultCode type.

Representation of Stellar SimplePaymentResult type.

Representation of Stellar OptionalAccountID type.

Representation of Stellar OptionalClaimPredicate type.

Representation of Stellar OptionalDataValue type.

Representation of Stellar OptionalLedgerBounds type.

Representation of Stellar OptionalMuxedAccount type.

Representation of Stellar OptionalSequenceNumber type.

Representation of Stellar OptionalSigner type.

Representation of Stellar OptionalString32 type.

Representation of Stellar OptionalTimeBounds type.

Representation of Stellar OptionalUInt32 type.

Representation of Stellar PoolID type.

Representation of Stellar PreconditionType type.

Representation of Stellar Preconditions type.

Representation of Stellar PreconditionsV2 type.

Representation of Stellar Price type.

Representation of Stellar PublicKey type.

Representation of Stellar PublicKeyType type.

Representation of Stellar RevokeID type.

Representation of Stellar RevokeSponsorshipSigner type.

Representation of Stellar RevokeSponsorshipType type.

Representation of Stellar SequenceNumber type.

Representation of Stellar Signature type.

Representation of Stellar SignatureHint type.

Representation of Stellar Signer type.

Representation of Stellar SignerKey type.

Representation of Stellar Signer key ed25519 signed payload signer type.

Representation of a Stellar SignerKeyList list.

Representation of Stellar SignerKeyType type.

Representation of a Stellar Signers list.

Representation of Stellar SponsorshipDescriptor type.

Representation of a Stellar SponsorshipDescriptor list.

Representation of Stellar String28 type.

Representation of Stellar String32 type.

Representation of Stellar String64 type.

Representation of Stellar ThresholdIndexes type.

Representation of an AccountEntry's Thresholds. Thresholds stores unsigned bytes: [weight of master|low|med|high]

Representation of Stellar TimeBounds type.

Representation of Stellar TimePoint type.

Representation of Stellar Transaction type.

Representation of Stellar TransactionEnvelope type.

Representation of Stellar TransactionResult type.

Representation of Stellar TransactionResultCode type.

Representation of Stellar TransactionSignaturePayload type.

Representation of Stellar TransactionSignaturePayloadTaggedTransaction type.

Representation of Stellar TransactionV0 type.

Representation of Stellar TransactionV0Envelope type.

Representation of Stellar TransactionV1Envelope type.

Representation of Stellar TrustLine type.

Representation of Stellar TrustLineAsset type.

Representation of Stellar TrustLineEntry type.

Representation of Stellar TrustLineEntryExt type.

Representation of Stellar TrustLineEntryExtV1 type.

Representation of Stellar TrustLineEntryExtV1Ext type.

Representation of Stellar TrustLineEntryExtV2 type.

Representation of Stellar TrustLineFlags type.

Representation of Stellar TxResult type.

Representation of Stellar TxResultV0 type.

Representation of Stellar UInt256 type.

Representation of Stellar UInt32 type.

Representation of Stellar UInt64 type.

Representation of Stellar VariableOpaque64 type.

Representation of Stellar Void type.