Expand description
Library and CLI containing types and functionality for working with Stellar XDR.
Types are generated from XDR definitions hosted at stellar/stellar-xdr
using the Rust XDR generator in xdr-generator-rust/.
§Support
The most recent stellar-xdr major release is supported with critical security fixes. Critical security issues may be backported to earlier versions if practical, but not guaranteed. General bugs are only fixed on, and new features are only added to, the latest major release.
§Usage
§Library
To use the library, include in your toml:
stellar-xdr = { version = "...", default-features = true, features = [] }§Features
The crate has several features, tiers of functionality, and ancillary functionality.
Default features: std.
Tiers of functionality:
std– The std feature provides all functionality (types, encode, decode), and is the default feature set.alloc– The alloc feature usesBoxandVectypes for recursive references and arrays, and is automatically enabled if the std feature is enabled. The default global allocator is used. Support for a custom allocator will be added in #39. No encode or decode capability exists, only types. Encode and decode capability will be added in #46.- If std or alloc are not enabled recursive and array types requires static lifetime values. No encode or decode capability exists. Encode and decode capability will be added in #47.
Ancillary functionality:
type_enum– Enables the generated dynamicTypeandTypeVariantAPIs for runtime-selected XDR decoding, encoding, schema generation.base64– Enables support for base64 encoding and decoding.serde– Enables support for serializing and deserializing types with the serde crate.serde_json– Enables support for built-in functionality specifically for serde_json. Often not required to use the types with serde_json, and only necessary to use utility functions that depend on serde_json.arbitrary– Enables support for interop with the arbitrary crate.hex– Enables support for hex in string representations of some types. Automatically enabled when serde is enabled.schemars– Enables support for JSON Schema generation. (Experimental)
Features marked experimental may disappear at anytime, see breaking changes at anytime, or and may be minimal implementations instead of complete.
§CLI
To use the CLI:
cargo install --locked stellar-xdr --version ... --features cli§Examples
Parse a TransactionEnvelope:
stellar-xdr decode --type TransactionEnvelope << -
AAAAA...
-Parse a ScSpecEntry stream from a contract:
stellar-xdr decode --type ScSpecEntry --input stream-base64 --output json-formatted << -
AAAAA...
-Parse a BucketEntry framed stream from a bucket file:
stellar-xdr decode --type BucketEntry --input stream-framed --output json-formatted bucket.xdrModules§
- cli
cli - int128_
helpers - schemars
schemars
Structs§
- Account
Entry - AccountEntry is an XDR Struct defined as:
- Account
Entry Extension V1 - AccountEntryExtensionV1 is an XDR Struct defined as:
- Account
Entry Extension V2 - AccountEntryExtensionV2 is an XDR Struct defined as:
- Account
Entry Extension V3 - AccountEntryExtensionV3 is an XDR Struct defined as:
- Account
Id - AccountId is an XDR Typedef defined as:
- Allow
Trust Op - AllowTrustOp is an XDR Struct defined as:
- Alpha
Num4 - AlphaNum4 is an XDR Struct defined as:
- Alpha
Num12 - AlphaNum12 is an XDR Struct defined as:
- Asset
Code4 - AssetCode4 is an XDR Typedef defined as:
- Asset
Code12 - AssetCode12 is an XDR Typedef defined as:
- Auth
- Auth is an XDR Struct defined as:
- Auth
Cert - AuthCert is an XDR Struct defined as:
- Authenticated
Message V0 - AuthenticatedMessageV0 is an XDR NestedStruct defined as:
- Begin
Sponsoring Future Reserves Op - BeginSponsoringFutureReservesOp is an XDR Struct defined as:
- Bucket
Metadata - BucketMetadata is an XDR Struct defined as:
- Bump
Sequence Op - BumpSequenceOp is an XDR Struct defined as:
- BytesM
alloc - Change
Trust Op - ChangeTrustOp is an XDR Struct defined as:
- Claim
Claimable Balance Op - ClaimClaimableBalanceOp is an XDR Struct defined as:
- Claim
Liquidity Atom - ClaimLiquidityAtom is an XDR Struct defined as:
- Claim
Offer Atom - ClaimOfferAtom is an XDR Struct defined as:
- Claim
Offer Atom V0 - ClaimOfferAtomV0 is an XDR Struct defined as:
- Claimable
Balance Entry - ClaimableBalanceEntry is an XDR Struct defined as:
- Claimable
Balance Entry Extension V1 - ClaimableBalanceEntryExtensionV1 is an XDR Struct defined as:
- Claimant
V0 - ClaimantV0 is an XDR NestedStruct defined as:
- Clawback
Claimable Balance Op - ClawbackClaimableBalanceOp is an XDR Struct defined as:
- Clawback
Op - ClawbackOp is an XDR Struct defined as:
- Config
Setting Contract Bandwidth V0 - ConfigSettingContractBandwidthV0 is an XDR Struct defined as:
- Config
Setting Contract Compute V0 - ConfigSettingContractComputeV0 is an XDR Struct defined as:
- Config
Setting Contract Events V0 - ConfigSettingContractEventsV0 is an XDR Struct defined as:
- Config
Setting Contract Execution Lanes V0 - ConfigSettingContractExecutionLanesV0 is an XDR Struct defined as:
- Config
Setting Contract Historical Data V0 - ConfigSettingContractHistoricalDataV0 is an XDR Struct defined as:
- Config
Setting Contract Ledger Cost ExtV0 - ConfigSettingContractLedgerCostExtV0 is an XDR Struct defined as:
- Config
Setting Contract Ledger Cost V0 - ConfigSettingContractLedgerCostV0 is an XDR Struct defined as:
- Config
Setting Contract Parallel Compute V0 - ConfigSettingContractParallelComputeV0 is an XDR Struct defined as:
- Config
Setting ScpTiming - ConfigSettingScpTiming is an XDR Struct defined as:
- Config
Upgrade Set - ConfigUpgradeSet is an XDR Struct defined as:
- Config
Upgrade SetKey - ConfigUpgradeSetKey is an XDR Struct defined as:
- Contract
Code Cost Inputs - ContractCodeCostInputs is an XDR Struct defined as:
- Contract
Code Entry - ContractCodeEntry is an XDR Struct defined as:
- Contract
Code Entry V1 - ContractCodeEntryV1 is an XDR NestedStruct defined as:
- Contract
Cost Param Entry - ContractCostParamEntry is an XDR Struct defined as:
- Contract
Cost Params - ContractCostParams is an XDR Typedef defined as:
- Contract
Data Entry - ContractDataEntry is an XDR Struct defined as:
- Contract
Event - ContractEvent is an XDR Struct defined as:
- Contract
Event V0 - ContractEventV0 is an XDR NestedStruct defined as:
- Contract
Id - ContractId is an XDR Typedef defined as:
- Contract
IdPreimage From Address - ContractIdPreimageFromAddress is an XDR NestedStruct defined as:
- Create
Account Op - CreateAccountOp is an XDR Struct defined as:
- Create
Claimable Balance Op - CreateClaimableBalanceOp is an XDR Struct defined as:
- Create
Contract Args - CreateContractArgs is an XDR Struct defined as:
- Create
Contract Args V2 - CreateContractArgsV2 is an XDR Struct defined as:
- Create
Passive Sell Offer Op - CreatePassiveSellOfferOp is an XDR Struct defined as:
- Curve25519
Public - Curve25519Public is an XDR Struct defined as:
- Curve25519
Secret - Curve25519Secret is an XDR Struct defined as:
- Data
Entry - DataEntry is an XDR Struct defined as:
- Data
Value - DataValue is an XDR Typedef defined as:
- Decorated
Signature - DecoratedSignature is an XDR Struct defined as:
- Dependent
TxCluster - DependentTxCluster is an XDR Typedef defined as:
- Diagnostic
Event - DiagnosticEvent is an XDR Struct defined as:
- Dont
Have - DontHave is an XDR Struct defined as:
- Duration
- Duration is an XDR Typedef defined as:
- Encoded
Ledger Key - EncodedLedgerKey is an XDR Typedef defined as:
- Encrypted
Body - EncryptedBody is an XDR Typedef defined as:
- Eviction
Iterator - EvictionIterator is an XDR Struct defined as:
- Extend
Footprint TtlOp - ExtendFootprintTtlOp is an XDR Struct defined as:
- FeeBump
Transaction - FeeBumpTransaction is an XDR Struct defined as:
- FeeBump
Transaction Envelope - FeeBumpTransactionEnvelope is an XDR Struct defined as:
- Flood
Advert - FloodAdvert is an XDR Struct defined as:
- Flood
Demand - FloodDemand is an XDR Struct defined as:
- Frame
- Frame wraps an XDR object with the framing defined by the Record Marking Standard in RFC 5531 Section 11.
- Freeze
Bypass Txs - FreezeBypassTxs is an XDR Struct defined as:
- Freeze
Bypass TxsDelta - FreezeBypassTxsDelta is an XDR Struct defined as:
- Frozen
Ledger Keys - FrozenLedgerKeys is an XDR Struct defined as:
- Frozen
Ledger Keys Delta - FrozenLedgerKeysDelta is an XDR Struct defined as:
- Hash
- Hash is an XDR Typedef defined as:
- Hash
IdPreimage Contract Id - HashIdPreimageContractId is an XDR NestedStruct defined as:
- Hash
IdPreimage Operation Id - HashIdPreimageOperationId is an XDR NestedStruct defined as:
- Hash
IdPreimage Revoke Id - HashIdPreimageRevokeId is an XDR NestedStruct defined as:
- Hash
IdPreimage Soroban Authorization - HashIdPreimageSorobanAuthorization is an XDR NestedStruct defined as:
- Hash
IdPreimage Soroban Authorization With Address - HashIdPreimageSorobanAuthorizationWithAddress is an XDR NestedStruct defined as:
- Hello
- Hello is an XDR Struct defined as:
- Hmac
Sha256 Key - HmacSha256Key is an XDR Struct defined as:
- Hmac
Sha256 Mac - HmacSha256Mac is an XDR Struct defined as:
- Inflation
Payout - InflationPayout is an XDR Struct defined as:
- Inner
Transaction Result - InnerTransactionResult is an XDR Struct defined as:
- Inner
Transaction Result Pair - InnerTransactionResultPair is an XDR Struct defined as:
- Int128
Parts - Int128Parts is an XDR Struct defined as:
- Int256
Parts - Int256Parts is an XDR Struct defined as:
- Invoke
Contract Args - InvokeContractArgs is an XDR Struct defined as:
- Invoke
Host Function Op - InvokeHostFunctionOp is an XDR Struct defined as:
- Invoke
Host Function Success PreImage - InvokeHostFunctionSuccessPreImage is an XDR Struct defined as:
- Ledger
Bounds - LedgerBounds is an XDR Struct defined as:
- Ledger
Close Meta Batch - LedgerCloseMetaBatch is an XDR Struct defined as:
- Ledger
Close Meta ExtV1 - LedgerCloseMetaExtV1 is an XDR Struct defined as:
- Ledger
Close Meta V0 - LedgerCloseMetaV0 is an XDR Struct defined as:
- Ledger
Close Meta V1 - LedgerCloseMetaV1 is an XDR Struct defined as:
- Ledger
Close Meta V2 - LedgerCloseMetaV2 is an XDR Struct defined as:
- Ledger
Close Value Signature - LedgerCloseValueSignature is an XDR Struct defined as:
- Ledger
Entry - LedgerEntry is an XDR Struct defined as:
- Ledger
Entry Changes - LedgerEntryChanges is an XDR Typedef defined as:
- Ledger
Entry Extension V1 - LedgerEntryExtensionV1 is an XDR Struct defined as:
- Ledger
Footprint - LedgerFootprint is an XDR Struct defined as:
- Ledger
Header - LedgerHeader is an XDR Struct defined as:
- Ledger
Header Extension V1 - LedgerHeaderExtensionV1 is an XDR Struct defined as:
- Ledger
Header History Entry - LedgerHeaderHistoryEntry is an XDR Struct defined as:
- Ledger
KeyAccount - LedgerKeyAccount is an XDR NestedStruct defined as:
- Ledger
KeyClaimable Balance - LedgerKeyClaimableBalance is an XDR NestedStruct defined as:
- Ledger
KeyConfig Setting - LedgerKeyConfigSetting is an XDR NestedStruct defined as:
- Ledger
KeyContract Code - LedgerKeyContractCode is an XDR NestedStruct defined as:
- Ledger
KeyContract Data - LedgerKeyContractData is an XDR NestedStruct defined as:
- Ledger
KeyData - LedgerKeyData is an XDR NestedStruct defined as:
- Ledger
KeyLiquidity Pool - LedgerKeyLiquidityPool is an XDR NestedStruct defined as:
- Ledger
KeyOffer - LedgerKeyOffer is an XDR NestedStruct defined as:
- Ledger
KeyTrust Line - LedgerKeyTrustLine is an XDR NestedStruct defined as:
- Ledger
KeyTtl - LedgerKeyTtl is an XDR NestedStruct defined as:
- Ledger
ScpMessages - LedgerScpMessages is an XDR Struct defined as:
- Liabilities
- Liabilities is an XDR Struct defined as:
- Limited
std Limitedwraps an object and provides functions for enforcing limits.- Limits
std Limitscontains the limits that a limited reader or writer will be constrained to.- Liquidity
Pool Constant Product Parameters - LiquidityPoolConstantProductParameters is an XDR Struct defined as:
- Liquidity
Pool Deposit Op - LiquidityPoolDepositOp is an XDR Struct defined as:
- Liquidity
Pool Entry - LiquidityPoolEntry is an XDR Struct defined as:
- Liquidity
Pool Entry Constant Product - LiquidityPoolEntryConstantProduct is an XDR NestedStruct defined as:
- Liquidity
Pool Withdraw Op - LiquidityPoolWithdrawOp is an XDR Struct defined as:
- Manage
BuyOffer Op - ManageBuyOfferOp is an XDR Struct defined as:
- Manage
Data Op - ManageDataOp is an XDR Struct defined as:
- Manage
Offer Success Result - ManageOfferSuccessResult is an XDR Struct defined as:
- Manage
Sell Offer Op - ManageSellOfferOp is an XDR Struct defined as:
- Muxed
Account Med25519 - MuxedAccountMed25519 is an XDR NestedStruct defined as:
- Muxed
Ed25519 Account - MuxedEd25519Account is an XDR Struct defined as:
- NodeId
- NodeId is an XDR Typedef defined as:
- Offer
Entry - OfferEntry is an XDR Struct defined as:
- Operation
- Operation is an XDR Struct defined as:
- Operation
Meta - OperationMeta is an XDR Struct defined as:
- Operation
Meta V2 - OperationMetaV2 is an XDR Struct defined as:
- Parallel
TxExecution Stage - ParallelTxExecutionStage is an XDR Typedef defined as:
- Parallel
TxsComponent - ParallelTxsComponent is an XDR Struct defined as:
- Path
Payment Strict Receive Op - PathPaymentStrictReceiveOp is an XDR Struct defined as:
- Path
Payment Strict Receive Result Success - PathPaymentStrictReceiveResultSuccess is an XDR NestedStruct defined as:
- Path
Payment Strict Send Op - PathPaymentStrictSendOp is an XDR Struct defined as:
- Path
Payment Strict Send Result Success - PathPaymentStrictSendResultSuccess is an XDR NestedStruct defined as:
- Payment
Op - PaymentOp is an XDR Struct defined as:
- Peer
Address - PeerAddress is an XDR Struct defined as:
- Peer
Stats - PeerStats is an XDR Struct defined as:
- Persisted
ScpState V0 - PersistedScpStateV0 is an XDR Struct defined as:
- Persisted
ScpState V1 - PersistedScpStateV1 is an XDR Struct defined as:
- PoolId
- PoolId is an XDR Typedef defined as:
- Preconditions
V2 - PreconditionsV2 is an XDR Struct defined as:
- Price
- Price is an XDR Struct defined as:
- Read
XdrIter std - Restore
Footprint Op - RestoreFootprintOp is an XDR Struct defined as:
- Revoke
Sponsorship OpSigner - RevokeSponsorshipOpSigner is an XDR NestedStruct defined as:
- SError
- SError is an XDR Struct defined as:
- ScBytes
- ScBytes is an XDR Typedef defined as:
- ScContract
Instance - ScContractInstance is an XDR Struct defined as:
- ScEnv
Meta Entry Interface Version - ScEnvMetaEntryInterfaceVersion is an XDR NestedStruct defined as:
- ScMap
- ScMap is an XDR Typedef defined as:
- ScMap
Entry - ScMapEntry is an XDR Struct defined as:
- ScMeta
V0 - ScMetaV0 is an XDR Struct defined as:
- ScNonce
Key - ScNonceKey is an XDR Struct defined as:
- ScSpec
Event Param V0 - ScSpecEventParamV0 is an XDR Struct defined as:
- ScSpec
Event V0 - ScSpecEventV0 is an XDR Struct defined as:
- ScSpec
Function Input V0 - ScSpecFunctionInputV0 is an XDR Struct defined as:
- ScSpec
Function V0 - ScSpecFunctionV0 is an XDR Struct defined as:
- ScSpec
Type BytesN - ScSpecTypeBytesN is an XDR Struct defined as:
- ScSpec
Type Map - ScSpecTypeMap is an XDR Struct defined as:
- ScSpec
Type Option - ScSpecTypeOption is an XDR Struct defined as:
- ScSpec
Type Result - ScSpecTypeResult is an XDR Struct defined as:
- ScSpec
Type Tuple - ScSpecTypeTuple is an XDR Struct defined as:
- ScSpec
Type Udt - ScSpecTypeUdt is an XDR Struct defined as:
- ScSpec
Type Vec - ScSpecTypeVec is an XDR Struct defined as:
- ScSpec
UdtEnum Case V0 - ScSpecUdtEnumCaseV0 is an XDR Struct defined as:
- ScSpec
UdtEnum V0 - ScSpecUdtEnumV0 is an XDR Struct defined as:
- ScSpec
UdtError Enum Case V0 - ScSpecUdtErrorEnumCaseV0 is an XDR Struct defined as:
- ScSpec
UdtError Enum V0 - ScSpecUdtErrorEnumV0 is an XDR Struct defined as:
- ScSpec
UdtStruct Field V0 - ScSpecUdtStructFieldV0 is an XDR Struct defined as:
- ScSpec
UdtStruct V0 - ScSpecUdtStructV0 is an XDR Struct defined as:
- ScSpec
UdtUnion Case Tuple V0 - ScSpecUdtUnionCaseTupleV0 is an XDR Struct defined as:
- ScSpec
UdtUnion Case Void V0 - ScSpecUdtUnionCaseVoidV0 is an XDR Struct defined as:
- ScSpec
UdtUnion V0 - ScSpecUdtUnionV0 is an XDR Struct defined as:
- ScString
- ScString is an XDR Typedef defined as:
- ScSymbol
- ScSymbol is an XDR Typedef defined as:
- ScVec
- ScVec is an XDR Typedef defined as:
- ScpBallot
- ScpBallot is an XDR Struct defined as:
- ScpEnvelope
- ScpEnvelope is an XDR Struct defined as:
- ScpHistory
Entry V0 - ScpHistoryEntryV0 is an XDR Struct defined as:
- ScpNomination
- ScpNomination is an XDR Struct defined as:
- ScpQuorum
Set - ScpQuorumSet is an XDR Struct defined as:
- ScpStatement
- ScpStatement is an XDR Struct defined as:
- ScpStatement
Confirm - ScpStatementConfirm is an XDR NestedStruct defined as:
- ScpStatement
Externalize - ScpStatementExternalize is an XDR NestedStruct defined as:
- ScpStatement
Prepare - ScpStatementPrepare is an XDR NestedStruct defined as:
- Send
More - SendMore is an XDR Struct defined as:
- Send
More Extended - SendMoreExtended is an XDR Struct defined as:
- Sequence
Number - SequenceNumber is an XDR Typedef defined as:
- Serialized
Binary Fuse Filter - SerializedBinaryFuseFilter is an XDR Struct defined as:
- SetOptions
Op - SetOptionsOp is an XDR Struct defined as:
- SetTrust
Line Flags Op - SetTrustLineFlagsOp is an XDR Struct defined as:
- Short
Hash Seed - ShortHashSeed is an XDR Struct defined as:
- Signature
- Signature is an XDR Typedef defined as:
- Signature
Hint - SignatureHint is an XDR Typedef defined as:
- Signed
Time Sliced Survey Request Message - SignedTimeSlicedSurveyRequestMessage is an XDR Struct defined as:
- Signed
Time Sliced Survey Response Message - SignedTimeSlicedSurveyResponseMessage is an XDR Struct defined as:
- Signed
Time Sliced Survey Start Collecting Message - SignedTimeSlicedSurveyStartCollectingMessage is an XDR Struct defined as:
- Signed
Time Sliced Survey Stop Collecting Message - SignedTimeSlicedSurveyStopCollectingMessage is an XDR Struct defined as:
- Signer
- Signer is an XDR Struct defined as:
- Signer
KeyEd25519 Signed Payload - SignerKeyEd25519SignedPayload is an XDR NestedStruct defined as:
- Simple
Payment Result - SimplePaymentResult is an XDR Struct defined as:
- Skip
Whitespace std - Forwards read operations to the wrapped object, skipping over any whitespace.
- Soroban
Address Credentials - SorobanAddressCredentials is an XDR Struct defined as:
- Soroban
Address Credentials With Delegates - SorobanAddressCredentialsWithDelegates is an XDR Struct defined as:
- Soroban
Authorization Entries - SorobanAuthorizationEntries is an XDR Typedef defined as:
- Soroban
Authorization Entry - SorobanAuthorizationEntry is an XDR Struct defined as:
- Soroban
Authorized Invocation - SorobanAuthorizedInvocation is an XDR Struct defined as:
- Soroban
Delegate Signature - SorobanDelegateSignature is an XDR Struct defined as:
- Soroban
Resources - SorobanResources is an XDR Struct defined as:
- Soroban
Resources ExtV0 - SorobanResourcesExtV0 is an XDR Struct defined as:
- Soroban
Transaction Data - SorobanTransactionData is an XDR Struct defined as:
- Soroban
Transaction Meta - SorobanTransactionMeta is an XDR Struct defined as:
- Soroban
Transaction Meta ExtV1 - SorobanTransactionMetaExtV1 is an XDR Struct defined as:
- Soroban
Transaction Meta V2 - SorobanTransactionMetaV2 is an XDR Struct defined as:
- Sponsorship
Descriptor - SponsorshipDescriptor is an XDR Typedef defined as:
- State
Archival Settings - StateArchivalSettings is an XDR Struct defined as:
- Stellar
Value - StellarValue is an XDR Struct defined as:
- Stellar
Value Proposed Value - StellarValueProposedValue is an XDR NestedStruct defined as:
- Stored
Debug Transaction Set - StoredDebugTransactionSet is an XDR Struct defined as:
- String32
- String32 is an XDR Typedef defined as:
- String64
- String64 is an XDR Typedef defined as:
- StringM
alloc - A string type that contains arbitrary bytes.
- Survey
Request Message - SurveyRequestMessage is an XDR Struct defined as:
- Survey
Response Message - SurveyResponseMessage is an XDR Struct defined as:
- Test
Next Type - TestNextType is an XDR Struct defined as:
- Thresholds
- Thresholds is an XDR Typedef defined as:
- Time
Bounds - TimeBounds is an XDR Struct defined as:
- Time
Point - TimePoint is an XDR Typedef defined as:
- Time
Sliced Node Data - TimeSlicedNodeData is an XDR Struct defined as:
- Time
Sliced Peer Data - TimeSlicedPeerData is an XDR Struct defined as:
- Time
Sliced Peer Data List - TimeSlicedPeerDataList is an XDR Typedef defined as:
- Time
Sliced Survey Request Message - TimeSlicedSurveyRequestMessage is an XDR Struct defined as:
- Time
Sliced Survey Response Message - TimeSlicedSurveyResponseMessage is an XDR Struct defined as:
- Time
Sliced Survey Start Collecting Message - TimeSlicedSurveyStartCollectingMessage is an XDR Struct defined as:
- Time
Sliced Survey Stop Collecting Message - TimeSlicedSurveyStopCollectingMessage is an XDR Struct defined as:
- Topology
Response Body V2 - TopologyResponseBodyV2 is an XDR Struct defined as:
- Transaction
- Transaction is an XDR Struct defined as:
- Transaction
Event - TransactionEvent is an XDR Struct defined as:
- Transaction
History Entry - TransactionHistoryEntry is an XDR Struct defined as:
- Transaction
History Result Entry - TransactionHistoryResultEntry is an XDR Struct defined as:
- Transaction
Meta V1 - TransactionMetaV1 is an XDR Struct defined as:
- Transaction
Meta V2 - TransactionMetaV2 is an XDR Struct defined as:
- Transaction
Meta V3 - TransactionMetaV3 is an XDR Struct defined as:
- Transaction
Meta V4 - TransactionMetaV4 is an XDR Struct defined as:
- Transaction
Result - TransactionResult is an XDR Struct defined as:
- Transaction
Result Meta - TransactionResultMeta is an XDR Struct defined as:
- Transaction
Result Meta V1 - TransactionResultMetaV1 is an XDR Struct defined as:
- Transaction
Result Pair - TransactionResultPair is an XDR Struct defined as:
- Transaction
Result Set - TransactionResultSet is an XDR Struct defined as:
- Transaction
Set - TransactionSet is an XDR Struct defined as:
- Transaction
SetV1 - TransactionSetV1 is an XDR Struct defined as:
- Transaction
Signature Payload - TransactionSignaturePayload is an XDR Struct defined as:
- Transaction
V0 - TransactionV0 is an XDR Struct defined as:
- Transaction
V0Envelope - TransactionV0Envelope is an XDR Struct defined as:
- Transaction
V1Envelope - TransactionV1Envelope is an XDR Struct defined as:
- Trust
Line Entry - TrustLineEntry is an XDR Struct defined as:
- Trust
Line Entry Extension V2 - TrustLineEntryExtensionV2 is an XDR Struct defined as:
- Trust
Line Entry V1 - TrustLineEntryV1 is an XDR NestedStruct defined as:
- TtlEntry
- TtlEntry is an XDR Struct defined as:
- TxAdvert
Vector - TxAdvertVector is an XDR Typedef defined as:
- TxDemand
Vector - TxDemandVector is an XDR Typedef defined as:
- TxSet
Component TxsMaybe Discounted Fee - TxSetComponentTxsMaybeDiscountedFee is an XDR NestedStruct defined as:
- UInt128
Parts - UInt128Parts is an XDR Struct defined as:
- UInt256
Parts - UInt256Parts is an XDR Struct defined as:
- Uint256
- Uint256 is an XDR Typedef defined as:
- Upgrade
Entry Meta - UpgradeEntryMeta is an XDR Struct defined as:
- Upgrade
Type - UpgradeType is an XDR Typedef defined as:
- Value
- Value is an XDR Typedef defined as:
- VecM
- Version
Enums§
- Account
Entry Ext - AccountEntryExt is an XDR NestedUnion defined as:
- Account
Entry Extension V1Ext - AccountEntryExtensionV1Ext is an XDR NestedUnion defined as:
- Account
Entry Extension V2Ext - AccountEntryExtensionV2Ext is an XDR NestedUnion defined as:
- Account
Flags - AccountFlags is an XDR Enum defined as:
- Account
Merge Result - AccountMergeResult is an XDR Union defined as:
- Account
Merge Result Code - AccountMergeResultCode is an XDR Enum defined as:
- Allow
Trust Result - AllowTrustResult is an XDR Union defined as:
- Allow
Trust Result Code - AllowTrustResultCode is an XDR Enum defined as:
- Asset
- Asset is an XDR Union defined as:
- Asset
Code - AssetCode is an XDR Union defined as:
- Asset
Type - AssetType is an XDR Enum defined as:
- Authenticated
Message - AuthenticatedMessage is an XDR Union defined as:
- Begin
Sponsoring Future Reserves Result - BeginSponsoringFutureReservesResult is an XDR Union defined as:
- Begin
Sponsoring Future Reserves Result Code - BeginSponsoringFutureReservesResultCode is an XDR Enum defined as:
- Binary
Fuse Filter Type - BinaryFuseFilterType is an XDR Enum defined as:
- Bucket
Entry - BucketEntry is an XDR Union defined as:
- Bucket
Entry Type - BucketEntryType is an XDR Enum defined as:
- Bucket
List Type - BucketListType is an XDR Enum defined as:
- Bucket
Metadata Ext - BucketMetadataExt is an XDR NestedUnion defined as:
- Bump
Sequence Result - BumpSequenceResult is an XDR Union defined as:
- Bump
Sequence Result Code - BumpSequenceResultCode is an XDR Enum defined as:
- Change
Trust Asset - ChangeTrustAsset is an XDR Union defined as:
- Change
Trust Result - ChangeTrustResult is an XDR Union defined as:
- Change
Trust Result Code - ChangeTrustResultCode is an XDR Enum defined as:
- Claim
Atom - ClaimAtom is an XDR Union defined as:
- Claim
Atom Type - ClaimAtomType is an XDR Enum defined as:
- Claim
Claimable Balance Result - ClaimClaimableBalanceResult is an XDR Union defined as:
- Claim
Claimable Balance Result Code - ClaimClaimableBalanceResultCode is an XDR Enum defined as:
- Claim
Predicate - ClaimPredicate is an XDR Union defined as:
- Claim
Predicate Type - ClaimPredicateType is an XDR Enum defined as:
- Claimable
Balance Entry Ext - ClaimableBalanceEntryExt is an XDR NestedUnion defined as:
- Claimable
Balance Entry Extension V1Ext - ClaimableBalanceEntryExtensionV1Ext is an XDR NestedUnion defined as:
- Claimable
Balance Flags - ClaimableBalanceFlags is an XDR Enum defined as:
- Claimable
Balance Id - ClaimableBalanceId is an XDR Union defined as:
- Claimable
Balance IdType - ClaimableBalanceIdType is an XDR Enum defined as:
- Claimant
- Claimant is an XDR Union defined as:
- Claimant
Type - ClaimantType is an XDR Enum defined as:
- Clawback
Claimable Balance Result - ClawbackClaimableBalanceResult is an XDR Union defined as:
- Clawback
Claimable Balance Result Code - ClawbackClaimableBalanceResultCode is an XDR Enum defined as:
- Clawback
Result - ClawbackResult is an XDR Union defined as:
- Clawback
Result Code - ClawbackResultCode is an XDR Enum defined as:
- Config
Setting Entry - ConfigSettingEntry is an XDR Union defined as:
- Config
Setting Id - ConfigSettingId is an XDR Enum defined as:
- Contract
Code Entry Ext - ContractCodeEntryExt is an XDR NestedUnion defined as:
- Contract
Cost Type - ContractCostType is an XDR Enum defined as:
- Contract
Data Durability - ContractDataDurability is an XDR Enum defined as:
- Contract
Event Body - ContractEventBody is an XDR NestedUnion defined as:
- Contract
Event Type - ContractEventType is an XDR Enum defined as:
- Contract
Executable - ContractExecutable is an XDR Union defined as:
- Contract
Executable Type - ContractExecutableType is an XDR Enum defined as:
- Contract
IdPreimage - ContractIdPreimage is an XDR Union defined as:
- Contract
IdPreimage Type - ContractIdPreimageType is an XDR Enum defined as:
- Create
Account Result - CreateAccountResult is an XDR Union defined as:
- Create
Account Result Code - CreateAccountResultCode is an XDR Enum defined as:
- Create
Claimable Balance Result - CreateClaimableBalanceResult is an XDR Union defined as:
- Create
Claimable Balance Result Code - CreateClaimableBalanceResultCode is an XDR Enum defined as:
- Crypto
KeyType - CryptoKeyType is an XDR Enum defined as:
- Data
Entry Ext - DataEntryExt is an XDR NestedUnion defined as:
- EndSponsoring
Future Reserves Result - EndSponsoringFutureReservesResult is an XDR Union defined as:
- EndSponsoring
Future Reserves Result Code - EndSponsoringFutureReservesResultCode is an XDR Enum defined as:
- Envelope
Type - EnvelopeType is an XDR Enum defined as:
- Error
- Error contains all errors returned by functions in this crate. It can be
compared via
PartialEq, however any contained IO errors will only be compared on theirErrorKind. - Error
Code - ErrorCode is an XDR Enum defined as:
- Extend
Footprint TtlResult - ExtendFootprintTtlResult is an XDR Union defined as:
- Extend
Footprint TtlResult Code - ExtendFootprintTtlResultCode is an XDR Enum defined as:
- Extension
Point - ExtensionPoint is an XDR Union defined as:
- FeeBump
Transaction Ext - FeeBumpTransactionExt is an XDR NestedUnion defined as:
- FeeBump
Transaction Inner Tx - FeeBumpTransactionInnerTx is an XDR NestedUnion defined as:
- Generalized
Transaction Set - GeneralizedTransactionSet is an XDR Union defined as:
- Hash
IdPreimage - HashIdPreimage is an XDR Union defined as:
- Host
Function - HostFunction is an XDR Union defined as:
- Host
Function Type - HostFunctionType is an XDR Enum defined as:
- HotArchive
Bucket Entry - HotArchiveBucketEntry is an XDR Union defined as:
- HotArchive
Bucket Entry Type - HotArchiveBucketEntryType is an XDR Enum defined as:
- Inflation
Result - InflationResult is an XDR Union defined as:
- Inflation
Result Code - InflationResultCode is an XDR Enum defined as:
- Inner
Transaction Result Ext - InnerTransactionResultExt is an XDR NestedUnion defined as:
- Inner
Transaction Result Result - InnerTransactionResultResult is an XDR NestedUnion defined as:
- Invoke
Host Function Result - InvokeHostFunctionResult is an XDR Union defined as:
- Invoke
Host Function Result Code - InvokeHostFunctionResultCode is an XDR Enum defined as:
- IpAddr
Type - IpAddrType is an XDR Enum defined as:
- Ledger
Close Meta - LedgerCloseMeta is an XDR Union defined as:
- Ledger
Close Meta Ext - LedgerCloseMetaExt is an XDR Union defined as:
- Ledger
Entry Change - LedgerEntryChange is an XDR Union defined as:
- Ledger
Entry Change Type - LedgerEntryChangeType is an XDR Enum defined as:
- Ledger
Entry Data - LedgerEntryData is an XDR NestedUnion defined as:
- Ledger
Entry Ext - LedgerEntryExt is an XDR NestedUnion defined as:
- Ledger
Entry Extension V1Ext - LedgerEntryExtensionV1Ext is an XDR NestedUnion defined as:
- Ledger
Entry Type - LedgerEntryType is an XDR Enum defined as:
- Ledger
Header Ext - LedgerHeaderExt is an XDR NestedUnion defined as:
- Ledger
Header Extension V1Ext - LedgerHeaderExtensionV1Ext is an XDR NestedUnion defined as:
- Ledger
Header Flags - LedgerHeaderFlags is an XDR Enum defined as:
- Ledger
Header History Entry Ext - LedgerHeaderHistoryEntryExt is an XDR NestedUnion defined as:
- Ledger
Key - LedgerKey is an XDR Union defined as:
- Ledger
Upgrade - LedgerUpgrade is an XDR Union defined as:
- Ledger
Upgrade Type - LedgerUpgradeType is an XDR Enum defined as:
- Liquidity
Pool Deposit Result - LiquidityPoolDepositResult is an XDR Union defined as:
- Liquidity
Pool Deposit Result Code - LiquidityPoolDepositResultCode is an XDR Enum defined as:
- Liquidity
Pool Entry Body - LiquidityPoolEntryBody is an XDR NestedUnion defined as:
- Liquidity
Pool Parameters - LiquidityPoolParameters is an XDR Union defined as:
- Liquidity
Pool Type - LiquidityPoolType is an XDR Enum defined as:
- Liquidity
Pool Withdraw Result - LiquidityPoolWithdrawResult is an XDR Union defined as:
- Liquidity
Pool Withdraw Result Code - LiquidityPoolWithdrawResultCode is an XDR Enum defined as:
- Manage
BuyOffer Result - ManageBuyOfferResult is an XDR Union defined as:
- Manage
BuyOffer Result Code - ManageBuyOfferResultCode is an XDR Enum defined as:
- Manage
Data Result - ManageDataResult is an XDR Union defined as:
- Manage
Data Result Code - ManageDataResultCode is an XDR Enum defined as:
- Manage
Offer Effect - ManageOfferEffect is an XDR Enum defined as:
- Manage
Offer Success Result Offer - ManageOfferSuccessResultOffer is an XDR NestedUnion defined as:
- Manage
Sell Offer Result - ManageSellOfferResult is an XDR Union defined as:
- Manage
Sell Offer Result Code - ManageSellOfferResultCode is an XDR Enum defined as:
- Memo
- Memo is an XDR Union defined as:
- Memo
Type - MemoType is an XDR Enum defined as:
- Message
Type - MessageType is an XDR Enum defined as:
- Muxed
Account - MuxedAccount is an XDR Union defined as:
- Offer
Entry Ext - OfferEntryExt is an XDR NestedUnion defined as:
- Offer
Entry Flags - OfferEntryFlags is an XDR Enum defined as:
- Operation
Body - OperationBody is an XDR NestedUnion defined as:
- Operation
Result - OperationResult is an XDR Union defined as:
- Operation
Result Code - OperationResultCode is an XDR Enum defined as:
- Operation
Result Tr - OperationResultTr is an XDR NestedUnion defined as:
- Operation
Type - OperationType is an XDR Enum defined as:
- Path
Payment Strict Receive Result - PathPaymentStrictReceiveResult is an XDR Union defined as:
- Path
Payment Strict Receive Result Code - PathPaymentStrictReceiveResultCode is an XDR Enum defined as:
- Path
Payment Strict Send Result - PathPaymentStrictSendResult is an XDR Union defined as:
- Path
Payment Strict Send Result Code - PathPaymentStrictSendResultCode is an XDR Enum defined as:
- Payment
Result - PaymentResult is an XDR Union defined as:
- Payment
Result Code - PaymentResultCode is an XDR Enum defined as:
- Peer
Address Ip - PeerAddressIp is an XDR NestedUnion defined as:
- Persisted
ScpState - PersistedScpState is an XDR Union defined as:
- Precondition
Type - PreconditionType is an XDR Enum defined as:
- Preconditions
- Preconditions is an XDR Union defined as:
- Public
Key - PublicKey is an XDR Union defined as:
- Public
KeyType - PublicKeyType is an XDR Enum defined as:
- Restore
Footprint Result - RestoreFootprintResult is an XDR Union defined as:
- Restore
Footprint Result Code - RestoreFootprintResultCode is an XDR Enum defined as:
- Revoke
Sponsorship Op - RevokeSponsorshipOp is an XDR Union defined as:
- Revoke
Sponsorship Result - RevokeSponsorshipResult is an XDR Union defined as:
- Revoke
Sponsorship Result Code - RevokeSponsorshipResultCode is an XDR Enum defined as:
- Revoke
Sponsorship Type - RevokeSponsorshipType is an XDR Enum defined as:
- ScAddress
- ScAddress is an XDR Union defined as:
- ScAddress
Type - ScAddressType is an XDR Enum defined as:
- ScEnv
Meta Entry - ScEnvMetaEntry is an XDR Union defined as:
- ScEnv
Meta Kind - ScEnvMetaKind is an XDR Enum defined as:
- ScError
- ScError is an XDR Union defined as:
- ScError
Code - ScErrorCode is an XDR Enum defined as:
- ScError
Type - ScErrorType is an XDR Enum defined as:
- ScMeta
Entry - ScMetaEntry is an XDR Union defined as:
- ScMeta
Kind - ScMetaKind is an XDR Enum defined as:
- ScSpec
Entry - ScSpecEntry is an XDR Union defined as:
- ScSpec
Entry Kind - ScSpecEntryKind is an XDR Enum defined as:
- ScSpec
Event Data Format - ScSpecEventDataFormat is an XDR Enum defined as:
- ScSpec
Event Param Location V0 - ScSpecEventParamLocationV0 is an XDR Enum defined as:
- ScSpec
Type - ScSpecType is an XDR Enum defined as:
- ScSpec
Type Def - ScSpecTypeDef is an XDR Union defined as:
- ScSpec
UdtUnion Case V0 - ScSpecUdtUnionCaseV0 is an XDR Union defined as:
- ScSpec
UdtUnion Case V0Kind - ScSpecUdtUnionCaseV0Kind is an XDR Enum defined as:
- ScVal
- ScVal is an XDR Union defined as:
- ScVal
Type - ScValType is an XDR Enum defined as:
- ScpHistory
Entry - ScpHistoryEntry is an XDR Union defined as:
- ScpStatement
Pledges - ScpStatementPledges is an XDR NestedUnion defined as:
- ScpStatement
Type - ScpStatementType is an XDR Enum defined as:
- SetOptions
Result - SetOptionsResult is an XDR Union defined as:
- SetOptions
Result Code - SetOptionsResultCode is an XDR Enum defined as:
- SetTrust
Line Flags Result - SetTrustLineFlagsResult is an XDR Union defined as:
- SetTrust
Line Flags Result Code - SetTrustLineFlagsResultCode is an XDR Enum defined as:
- Signer
Key - SignerKey is an XDR Union defined as:
- Signer
KeyType - SignerKeyType is an XDR Enum defined as:
- Soroban
Authorized Function - SorobanAuthorizedFunction is an XDR Union defined as:
- Soroban
Authorized Function Type - SorobanAuthorizedFunctionType is an XDR Enum defined as:
- Soroban
Credentials - SorobanCredentials is an XDR Union defined as:
- Soroban
Credentials Type - SorobanCredentialsType is an XDR Enum defined as:
- Soroban
Transaction Data Ext - SorobanTransactionDataExt is an XDR NestedUnion defined as:
- Soroban
Transaction Meta Ext - SorobanTransactionMetaExt is an XDR Union defined as:
- Stellar
Message - StellarMessage is an XDR Union defined as:
- Stellar
Value Ext - StellarValueExt is an XDR NestedUnion defined as:
- Stellar
Value Type - StellarValueType is an XDR Enum defined as:
- Stored
Transaction Set - StoredTransactionSet is an XDR Union defined as:
- Survey
Message Command Type - SurveyMessageCommandType is an XDR Enum defined as:
- Survey
Message Response Type - SurveyMessageResponseType is an XDR Enum defined as:
- Survey
Response Body - SurveyResponseBody is an XDR Union defined as:
- Threshold
Indexes - ThresholdIndexes is an XDR Enum defined as:
- Transaction
Envelope - TransactionEnvelope is an XDR Union defined as:
- Transaction
Event Stage - TransactionEventStage is an XDR Enum defined as:
- Transaction
Ext - TransactionExt is an XDR NestedUnion defined as:
- Transaction
History Entry Ext - TransactionHistoryEntryExt is an XDR NestedUnion defined as:
- Transaction
History Result Entry Ext - TransactionHistoryResultEntryExt is an XDR NestedUnion defined as:
- Transaction
Meta - TransactionMeta is an XDR Union defined as:
- Transaction
Phase - TransactionPhase is an XDR Union defined as:
- Transaction
Result Code - TransactionResultCode is an XDR Enum defined as:
- Transaction
Result Ext - TransactionResultExt is an XDR NestedUnion defined as:
- Transaction
Result Result - TransactionResultResult is an XDR NestedUnion defined as:
- Transaction
Signature Payload Tagged Transaction - TransactionSignaturePayloadTaggedTransaction is an XDR NestedUnion defined as:
- Transaction
V0Ext - TransactionV0Ext is an XDR NestedUnion defined as:
- Trust
Line Asset - TrustLineAsset is an XDR Union defined as:
- Trust
Line Entry Ext - TrustLineEntryExt is an XDR NestedUnion defined as:
- Trust
Line Entry Extension V2Ext - TrustLineEntryExtensionV2Ext is an XDR NestedUnion defined as:
- Trust
Line Entry V1Ext - TrustLineEntryV1Ext is an XDR NestedUnion defined as:
- Trust
Line Flags - TrustLineFlags is an XDR Enum defined as:
- TxSet
Component - TxSetComponent is an XDR Union defined as:
- TxSet
Component Type - TxSetComponentType is an XDR Enum defined as:
- Type
type_enum - Type
Variant type_enum
Constants§
- AUTH_
MSG_ FLAG_ FLOW_ CONTROL_ BYTES_ REQUESTED - AuthMsgFlagFlowControlBytesRequested is an XDR Const defined as:
- CONTRACT_
COST_ COUNT_ LIMIT - ContractCostCountLimit is an XDR Const defined as:
- LIQUIDITY_
POOL_ FEE_ V18 - LiquidityPoolFeeV18 is an XDR Const defined as:
- MASK_
ACCOUNT_ FLAGS - MaskAccountFlags is an XDR Const defined as:
- MASK_
ACCOUNT_ FLAGS_ V17 - MaskAccountFlagsV17 is an XDR Const defined as:
- MASK_
CLAIMABLE_ BALANCE_ FLAGS - MaskClaimableBalanceFlags is an XDR Const defined as:
- MASK_
LEDGER_ HEADER_ FLAGS - MaskLedgerHeaderFlags is an XDR Const defined as:
- MASK_
OFFERENTRY_ FLAGS - MaskOfferentryFlags is an XDR Const defined as:
- MASK_
TRUSTLINE_ FLAGS - MaskTrustlineFlags is an XDR Const defined as:
- MASK_
TRUSTLINE_ FLAGS_ V13 - MaskTrustlineFlagsV13 is an XDR Const defined as:
- MASK_
TRUSTLINE_ FLAGS_ V17 - MaskTrustlineFlagsV17 is an XDR Const defined as:
- MAX_
OPS_ PER_ TX - MaxOpsPerTx is an XDR Const defined as:
- MAX_
SIGNERS - MaxSigners is an XDR Const defined as:
- SCSYMBOL_
LIMIT - ScsymbolLimit is an XDR Const defined as:
- SC_
SPEC_ DOC_ LIMIT - ScSpecDocLimit is an XDR Const defined as:
- TX_
ADVERT_ VECTOR_ MAX_ SIZE - TxAdvertVectorMaxSize is an XDR Const defined as:
- TX_
DEMAND_ VECTOR_ MAX_ SIZE - TxDemandVectorMaxSize is an XDR Const defined as:
- VERSION
- XDR_
FILES_ SHA256 XDR_FILES_SHA256is a list of pairs of source files and their SHA256 hashes.
Traits§
- Discriminant
- Discriminant defines types that may contain a one-of value determined according to the discriminant, and exposes the value of the discriminant for that type, such as in an XDR union.
- Enum
- Name
- Name defines types that assign a static name to their value, such as the name given to an identifier in an XDR enum, or the name given to the case in a union.
- ReadXdr
- Union
- Validate
- Variants
- Iter defines types that have variants that can be iterated.
- Write
Xdr