View Source Stellar.TxBuild.Spec behaviour (Elixir Stellar SDK v0.22.0)

Defines contracts to build a Stellar transaction.

Summary

Types

account()
base_fee()
envelope()
hash()
memo()
network_passphrase()
operation()
operations()
opts()
preconditions()
sequence_number()
signatures()
soroban_data()
time_bounds()
tx_build()
tx_envelope()
tx_hash()

Callbacks

add_memo(tx_build, memo)
add_operation(tx_build, operation)
add_operations(tx_build, operations)
build(tx_build)
envelope(tx_build)
hash(tx_build)
new(account, opts)
set_base_fee(tx_build, base_fee)
set_network_passphrase(tx_build, network_passphrase)
set_preconditions(tx_build, preconditions)
set_sequence_number(tx_build, sequence_number)
set_soroban_data(tx_build, soroban_data)
set_time_bounds(tx_build, time_bounds)
sign(tx_build, signatures)
sign_envelope(envelope, signatures, network_passphrase)

Types

Link to this type

account()

View Source 
@type account() :: Stellar.TxBuild.Account.t()
Link to this type

base_fee()

View Source 
@type base_fee() :: Stellar.TxBuild.BaseFee.t()
Link to this type

envelope()

View Source 
@type envelope() :: String.t()
Link to this type

hash()

View Source 
@type hash() :: String.t()
Link to this type

memo()

View Source 
@type memo() :: Stellar.TxBuild.Memo.t()
Link to this type

network_passphrase()

View Source 
@type network_passphrase() :: String.t()
Link to this type

operation()

View Source 
@type operation() ::
  Stellar.TxBuild.AccountMerge.t()
  | Stellar.TxBuild.BumpSequence.t()
  | Stellar.TxBuild.BeginSponsoringFutureReserves.t()
  | Stellar.TxBuild.ChangeTrust.t()
  | Stellar.TxBuild.Clawback.t()
  | Stellar.TxBuild.ClawbackClaimableBalance.t()
  | Stellar.TxBuild.CreateAccount.t()
  | Stellar.TxBuild.CreatePassiveSellOffer.t()
  | Stellar.TxBuild.EndSponsoringFutureReserves.t()
  | Stellar.TxBuild.ManageData.t()
  | Stellar.TxBuild.ManageSellOffer.t()
  | Stellar.TxBuild.ManageBuyOffer.t()
  | Stellar.TxBuild.Payment.t()
  | Stellar.TxBuild.PathPaymentStrictSend.t()
  | Stellar.TxBuild.PathPaymentStrictReceive.t()
  | Stellar.TxBuild.SetOptions.t()
Link to this type

operations()

View Source 
@type operations() :: [operation()]
Link to this type

opts()

View Source 
@type opts() :: Keyword.t()
Link to this type

preconditions()

View Source 
@type preconditions() :: Stellar.TxBuild.Preconditions.t()
Link to this type

sequence_number()

View Source 
@type sequence_number() :: Stellar.TxBuild.SequenceNumber.t()
Link to this type

signatures()

View Source 
@type signatures() :: Stellar.TxBuild.Signature.t() | [Stellar.TxBuild.Signature.t()]
Link to this type

soroban_data()

View Source 
@type soroban_data() :: String.t() | StellarBase.XDR.SorobanTransactionData.t()
Link to this type

time_bounds()

View Source 
@type time_bounds() :: Stellar.TxBuild.TimeBounds.t()
Link to this type

tx_build()

View Source 
@type tx_build() :: {:ok, Stellar.TxBuild.t()} | {:error, atom()}
Link to this type

tx_envelope()

View Source 
@type tx_envelope() :: {:ok, envelope()} | {:error, atom()}
Link to this type

tx_hash()

View Source 
@type tx_hash() :: {:ok, hash()} | {:error, atom()}

Callbacks

Link to this callback

add_memo(tx_build, memo)

View Source (optional) 
@callback add_memo(tx_build(), memo()) :: tx_build()
Link to this callback

add_operation(tx_build, operation)

View Source 
@callback add_operation(tx_build(), operation()) :: tx_build()
Link to this callback

add_operations(tx_build, operations)

View Source 
@callback add_operations(tx_build(), operations()) :: tx_build()
Link to this callback

build(tx_build)

View Source 
@callback build(tx_build()) :: tx_build()
Link to this callback

envelope(tx_build)

View Source 
@callback envelope(tx_build()) :: tx_envelope()
Link to this callback

hash(tx_build)

View Source 
@callback hash(tx_build()) :: tx_hash()
Link to this callback

new(account, opts)

View Source 
@callback new(account(), opts()) :: tx_build()
Link to this callback

set_base_fee(tx_build, base_fee)

View Source (optional) 
@callback set_base_fee(tx_build(), base_fee()) :: tx_build()
Link to this callback

set_network_passphrase(tx_build, network_passphrase)

View Source 
@callback set_network_passphrase(tx_build(), network_passphrase()) :: tx_build()
Link to this callback

set_preconditions(tx_build, preconditions)

View Source (optional) 
@callback set_preconditions(tx_build(), preconditions()) :: tx_build()
Link to this callback

set_sequence_number(tx_build, sequence_number)

View Source (optional) 
@callback set_sequence_number(tx_build(), sequence_number()) :: tx_build()
Link to this callback

set_soroban_data(tx_build, soroban_data)

View Source 
@callback set_soroban_data(tx_build(), soroban_data()) :: tx_build()
Link to this callback

set_time_bounds(tx_build, time_bounds)

View Source (optional) 
@callback set_time_bounds(tx_build(), time_bounds()) :: tx_build()
Link to this callback

sign(tx_build, signatures)

View Source 
@callback sign(tx_build(), signatures()) :: tx_build()
Link to this callback

sign_envelope(envelope, signatures, network_passphrase)

View Source 
@callback sign_envelope(envelope(), signatures(), network_passphrase()) :: tx_envelope()