build

package
Version: v0.0.0-...-1b485ba Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2017 License: Apache-2.0, MIT Imports: 12 Imported by: 0

Documentation

Overview

Package build provides a builder system for constructing various xdr structures used by the stellar network.

At the core of this package is the *Builder and *Mutator types. A Builder object (ex. PaymentBuilder, TransactionBuilder) contain an underlying xdr struct that is being iteratively built by having zero or more Mutator structs applied to it. See ExampleTransactionBuilder in main_test.go for an example.

Index

Examples

Constants

View Source
const (
	// MemoTextMaxLength represents the maximum number of bytes a valid memo of
	// type "MEMO_TEXT" can be.
	MemoTextMaxLength = 28
)

Variables

View Source
var (
	// PublicNetwork is a mutator that configures the transaction for submission
	// to the main public stellar network.
	PublicNetwork = Network{network.PublicNetworkPassphrase}

	// TestNetwork is a mutator that configures the transaction for submission
	// to the test stellar network (often called testnet).
	TestNetwork = Network{network.TestNetworkPassphrase}

	// DefaultNetwork is a mutator that configures the transaction for submission
	// to the default stellar network.  Integrators may change this value to
	// another `Network` mutator if they would like to effect the default in a
	// process-global manner.
	DefaultNetwork = TestNetwork
)

MaxLimit represents the maximum value that can be passed as trutline Limit

Functions

This section is empty.

Types

type AccountMergeBuilder

type AccountMergeBuilder struct {
	O           xdr.Operation
	Destination xdr.AccountId
	Err         error
}

AccountMergeBuilder represents a transaction that is being built.

func AccountMerge

func AccountMerge(muts ...interface{}) (result AccountMergeBuilder)

AccountMerge groups the creation of a new AccountMergeBuilder with a call to Mutate.

Example

ExampleAccountMerge creates and signs a simple transaction with AccountMerge operation, and then encodes it into a base64 string capable of being submitted to stellar-core.

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	AccountMerge(
		Destination{"GBDT3K42LOPSHNAEHEJ6AVPADIJ4MAR64QEKKW2LQPBSKLYD22KUEH4P"},
	),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func (*AccountMergeBuilder) Mutate

func (b *AccountMergeBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (AccountMergeBuilder) MutateTransaction

func (m AccountMergeBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for AccountMergeBuilder causes the underylying Destination to be added to the operation list for the provided transaction

type AccountMergeMutator

type AccountMergeMutator interface {
	MutateAccountMerge(*AccountMergeBuilder) error
}

AccountMergeMutator is a interface that wraps the MutateAccountMerge operation. types may implement this interface to specify how they modify an xdr.AccountMergeBuilder object

type AccountType

type AccountType uint32

type AdministrativeOpBuilder

type AdministrativeOpBuilder struct {
	O      xdr.Operation
	OpData xdr.LongString
	Err    error
}

AdministrativeOpBuilder represents a transaction that is being built.

func AdministrativeOp

func AdministrativeOp(muts ...interface{}) (result AdministrativeOpBuilder)

AdministrativeOp groups the creation of a new AdministrativeOpBuilder with a call to Mutate.

func (*AdministrativeOpBuilder) Mutate

func (b *AdministrativeOpBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder or operation.

func (AdministrativeOpBuilder) MutateTransaction

func (m AdministrativeOpBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for AdministrativeOpBuilder causes the underylying OpLongData to be added to the operation list for the provided transaction

type AdministrativeOpMutator

type AdministrativeOpMutator interface {
	MutateAdministrativeOp(*AdministrativeOpBuilder) error
}

AdministrativeOpMutator is a interface that wraps the MutateAdministrativeOp operation. types may implement this interface to specify how they modify an xdr.AdministrativeOpBuilder object

type AllowTrustAsset

type AllowTrustAsset struct {
	Code string
}

AllowTrustAsset is a mutator capable of setting the asset on an operations that have one.

func (AllowTrustAsset) MutateAllowTrust

func (m AllowTrustAsset) MutateAllowTrust(o *xdr.AllowTrustOp) (err error)

MutateAllowTrust for Asset sets the AllowTrustOp's Asset field

type AllowTrustBuilder

type AllowTrustBuilder struct {
	O   xdr.Operation
	AT  xdr.AllowTrustOp
	Err error
}

AllowTrustBuilder represents a transaction that is being built.

func AllowTrust

func AllowTrust(muts ...interface{}) (result AllowTrustBuilder)

AllowTrust groups the creation of a new AllowTrustBuilder with a call to Mutate.

func (*AllowTrustBuilder) Mutate

func (b *AllowTrustBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (AllowTrustBuilder) MutateTransaction

func (m AllowTrustBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for AllowTrustBuilder causes the underylying AllowTrustOp to be added to the operation list for the provided transaction

type AllowTrustMutator

type AllowTrustMutator interface {
	MutateAllowTrust(*xdr.AllowTrustOp) error
}

AllowTrustMutator is a interface that wraps the MutateAllowTrust operation. types may implement this interface to specify how they modify an xdr.AllowTrustOp object

type Amount

type Amount string

Amount is a mutator capable of setting the amount

func (Amount) MutateManageOffer

func (m Amount) MutateManageOffer(o interface{}) (err error)

MutateManageOffer for Amount sets the ManageOfferOp's Amount field

type Asset

type Asset struct {
	Code   string
	Issuer string
	Native bool
}

Asset is struct used in path_payment mutators

func CreditAsset

func CreditAsset(code, issuer string) Asset

CreditAsset is a helper method to create credit Asset object

func NativeAsset

func NativeAsset() Asset

NativeAsset is a helper method to create native Asset object

func (Asset) MutateChangeTrust

func (m Asset) MutateChangeTrust(o *xdr.ChangeTrustOp) (err error)

MutateChangeTrust for Asset sets the ChangeTrustOp's Line field

func (Asset) ToXdrObject

func (a Asset) ToXdrObject() (xdr.Asset, error)

ToXdrObject creates xdr.Asset object from build.Asset object

type Authorize

type Authorize struct {
	Value bool
}

Authorize is a mutator capable of setting the `authorize` flag

func (Authorize) MutateAllowTrust

func (m Authorize) MutateAllowTrust(o *xdr.AllowTrustOp) error

MutateAllowTrust for Authorize sets the AllowTrustOp's Authorize field

type AutoSequence

type AutoSequence struct {
	SequenceProvider
}

AutoSequence loads the sequence to use for the transaction from an external provider.

func (AutoSequence) MutateTransaction

func (m AutoSequence) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for AutoSequence loads the sequence and sets it on the tx. NOTE: this mutator assumes that the source account has already been set on the transaction and will error if that has not occurred.

type ChangeTrustBuilder

type ChangeTrustBuilder struct {
	O   xdr.Operation
	CT  xdr.ChangeTrustOp
	Err error
}

ChangeTrustBuilder represents a transaction that is being built.

func ChangeTrust

func ChangeTrust(muts ...interface{}) (result ChangeTrustBuilder)

ChangeTrust groups the creation of a new ChangeTrustBuilder with a call to Mutate.

Example

ExampleChangeTrust creates and signs a simple transaction with ChangeTrust operation, and then encodes it into a base64 string capable of being submitted to stellar-core.

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	Trust("USD", "GAWSI2JO2CF36Z43UGMUJCDQ2IMR5B3P5TMS7XM7NUTU3JHG3YJUDQXA", Limit("100.25")),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func RemoveTrust

func RemoveTrust(code, issuer string, args ...interface{}) (result ChangeTrustBuilder)

RemoveTrust is a helper that creates ChangeTrustBuilder

Example

ExampleRemoveTrust creates and signs a simple transaction with ChangeTrust operation (remove trust), and then encodes it into a base64 string capable of being submitted to stellar-core.

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
operationSource := "GCVJCNUHSGKOTBBSXZJ7JJZNOSE2YDNGRLIDPMQDUEQWJQSE6QZSDPNU"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	RemoveTrust(
		"USD",
		"GAWSI2JO2CF36Z43UGMUJCDQ2IMR5B3P5TMS7XM7NUTU3JHG3YJUDQXA",
		SourceAccount{operationSource},
	),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func Trust

func Trust(code, issuer string, args ...interface{}) (result ChangeTrustBuilder)

Trust is a helper that creates ChangeTrustBuilder

func (*ChangeTrustBuilder) Mutate

func (b *ChangeTrustBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (ChangeTrustBuilder) MutateTransaction

func (m ChangeTrustBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for ChangeTrustBuilder causes the underylying CreateAccountOp to be added to the operation list for the provided transaction

type ChangeTrustMutator

type ChangeTrustMutator interface {
	MutateChangeTrust(*xdr.ChangeTrustOp) error
}

ChangeTrustMutator is a interface that wraps the MutateChangeTrust operation. types may implement this interface to specify how they modify an xdr.ChangeTrustOp object

type ClearFlag

type ClearFlag int32

ClearFlag is a mutator capable of clearing account flags

func ClearAuthImmutable

func ClearAuthImmutable() ClearFlag

ClearAuthImmutable clears AuthImmutableFlag on SetOptions operation

func ClearAuthRequired

func ClearAuthRequired() ClearFlag

ClearAuthRequired clears AuthRequiredFlag on SetOptions operation

func ClearAuthRevocable

func ClearAuthRevocable() ClearFlag

ClearAuthRevocable clears AuthRevocableFlag on SetOptions operation

func (ClearFlag) MutateSetOptions

func (m ClearFlag) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for ClearFlag sets the SetOptionsOp's ClearFlags field

func (ClearFlag) MutateTransaction

func (m ClearFlag) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for ClearFlag allows creating an operation using a single mutator

type CommissionAmount

type CommissionAmount struct {
	Amount string
}

func (CommissionAmount) MutatePaymentReversal

func (m CommissionAmount) MutatePaymentReversal(o interface{}) (err error)

MutatePaymentReversal for Commission amount

type CreateAccountBuilder

type CreateAccountBuilder struct {
	O   xdr.Operation
	CA  xdr.CreateAccountOp
	Err error
}

CreateAccountBuilder helps to build CreateAccountOp structs.

func CreateAccount

func CreateAccount(muts ...interface{}) (result CreateAccountBuilder)

CreateAccount groups the creation of a new CreateAccountBuilder with a call to Mutate.

func (*CreateAccountBuilder) Mutate

func (b *CreateAccountBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (CreateAccountBuilder) MutateTransaction

func (m CreateAccountBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for CreateAccountBuilder causes the underylying CreateAccountOp to be added to the operation list for the provided transaction

type CreateAccountMutator

type CreateAccountMutator interface {
	MutateCreateAccount(*xdr.CreateAccountOp) error
}

CreateAccountMutator is a interface that wraps the MutateCreateAccount operation. types may implement this interface to specify how they modify an xdr.PaymentOp object

type CreateAccountWithScratch

type CreateAccountWithScratch struct {
	AccountType uint32
	Asset       *Asset
	Amount      *uint64
}

type CreditAmount

type CreditAmount struct {
	Code   string
	Issuer string
	Amount string
}

CreditAmount is a mutator that configures a payment to be using credit asset and have the amount provided.

func (CreditAmount) MutatePayment

func (m CreditAmount) MutatePayment(o interface{}) (err error)

MutatePayment for Asset sets the PaymentOp's Asset field

func (CreditAmount) MutatePaymentReversal

func (m CreditAmount) MutatePaymentReversal(o interface{}) (err error)

MutatePaymentReversal for Asset sets the PaymentReversalOp's Asset field

type Defaults

type Defaults struct{}

Defaults is a mutator that sets defaults

func (Defaults) MutateTransaction

func (m Defaults) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for Defaults sets reasonable defaults on the transaction being built

type Destination

type Destination struct {
	AddressOrSeed string
}

Destination is a mutator capable of setting the destination on an operations that have one.

func (Destination) MutateAccountMerge

func (m Destination) MutateAccountMerge(o *AccountMergeBuilder) error

MutateAccountMerge for Destination sets the AccountMergeBuilder's Destination field

func (Destination) MutateCreateAccount

func (m Destination) MutateCreateAccount(o *xdr.CreateAccountOp) error

MutateCreateAccount for Destination sets the CreateAccountOp's Destination field

func (Destination) MutatePayment

func (m Destination) MutatePayment(o interface{}) error

MutatePayment for Destination sets the PaymentOp's Destination field

type HomeDomain

type HomeDomain string

HomeDomain is a mutator capable of setting home domain of the account

func (HomeDomain) MutateSetOptions

func (m HomeDomain) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for HomeDomain sets the SetOptionsOp's HomeDomain field

func (HomeDomain) MutateTransaction

func (m HomeDomain) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for HomeDomain allows creating an operation using a single mutator

type InflationBuilder

type InflationBuilder struct {
	O   xdr.Operation
	Err error
}

InflationBuilder represents an operation that is being built.

func Inflation

func Inflation(muts ...interface{}) (result InflationBuilder)

Inflation groups the creation of a new InflationBuilder with a call to Mutate.

Example

ExampleInflation creates and signs a simple transaction with Inflation operation, and then encodes it into a base64 string capable of being submitted to stellar-core.

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	Inflation(),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func (*InflationBuilder) Mutate

func (b *InflationBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's operation.

func (InflationBuilder) MutateTransaction

func (m InflationBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for InflationBuilder causes the underylying InflationOp to be added to the operation list for the provided transaction

type InflationDest

type InflationDest string

InflationDest is a mutator capable of setting the inflation destination

func (InflationDest) MutateSetOptions

func (m InflationDest) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for InflationDest sets the SetOptionsOp's InflationDest field

func (InflationDest) MutateTransaction

func (m InflationDest) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for InflationDest allows creating an operation using a single mutator

type Limit

type Limit Amount

Limit is a mutator that sets a limit on the change_trust operation

func (Limit) MutateChangeTrust

func (m Limit) MutateChangeTrust(o *xdr.ChangeTrustOp) (err error)

MutateChangeTrust for Limit sets the ChangeTrustOp's Limit field

type ManageDataBuilder

type ManageDataBuilder struct {
	O   xdr.Operation
	MD  xdr.ManageDataOp
	Err error
}

ManageDataBuilder helps to build ManageDataOp structs.

func ClearData

func ClearData(name string, muts ...interface{}) (result ManageDataBuilder)

ClearData removes a key/value pair associated with the source account

func SetData

func SetData(name string, value []byte, muts ...interface{}) (result ManageDataBuilder)

SetData sets a key/value pair associated with the source account, updating it if one already exists.

func (*ManageDataBuilder) Mutate

func (b *ManageDataBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (ManageDataBuilder) MutateTransaction

func (m ManageDataBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for ManageDataBuilder causes the underylying ManageData to be added to the operation list for the provided transaction

type ManageOfferBuilder

type ManageOfferBuilder struct {
	PassiveOffer bool
	O            xdr.Operation
	MO           xdr.ManageOfferOp
	PO           xdr.CreatePassiveOfferOp
	Err          error
}

ManageOfferBuilder represents a transaction that is being built.

func CreateOffer

func CreateOffer(rate Rate, amount Amount) (result ManageOfferBuilder)

CreateOffer creates a new offer

func CreatePassiveOffer

func CreatePassiveOffer(rate Rate, amount Amount) (result ManageOfferBuilder)

CreatePassiveOffer creates a new passive offer

Example

ExampleCreatePassiveOffer creates and signs a simple transaction with CreatePassiveOffer operation, and then encodes it into a base64 string capable of being submitted to stellar-core.

rate := Rate{
	Selling: NativeAsset(),
	Buying:  CreditAsset("USD", "GAWSI2JO2CF36Z43UGMUJCDQ2IMR5B3P5TMS7XM7NUTU3JHG3YJUDQXA"),
	Price:   Price("125.12"),
}

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	CreatePassiveOffer(rate, "20"),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func DeleteOffer

func DeleteOffer(rate Rate, offerID OfferID) (result ManageOfferBuilder)

DeleteOffer deletes an existing offer

func ManageOffer

func ManageOffer(passiveOffer bool, muts ...interface{}) (result ManageOfferBuilder)

ManageOffer groups the creation of a new ManageOfferBuilder with a call to Mutate.

Example

ExampleManageOffer creates and signs a simple transaction with ManageOffer operations, and then encodes it into a base64 string capable of being submitted to stellar-core.

rate := Rate{
	Selling: NativeAsset(),
	Buying:  CreditAsset("USD", "GAWSI2JO2CF36Z43UGMUJCDQ2IMR5B3P5TMS7XM7NUTU3JHG3YJUDQXA"),
	Price:   Price("125.12"),
}

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	CreateOffer(rate, "20"),
	UpdateOffer(rate, "40", OfferID(2)),
	DeleteOffer(rate, OfferID(1)),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func UpdateOffer

func UpdateOffer(rate Rate, amount Amount, offerID OfferID) (result ManageOfferBuilder)

UpdateOffer updates an existing offer

func (*ManageOfferBuilder) Mutate

func (b *ManageOfferBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's offer or operation.

func (ManageOfferBuilder) MutateTransaction

func (m ManageOfferBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for ManageOfferBuilder causes the underylying ManageData to be added to the operation list for the provided transaction

type ManageOfferMutator

type ManageOfferMutator interface {
	MutateManageOffer(interface{}) error
}

ManageOfferMutator is a interface that wraps the MutateManageOffer operation. types may implement this interface to specify how they modify an xdr.ManageOfferOp object

type MasterWeight

type MasterWeight uint32

MasterWeight is a mutator that sets account's master weight

func (MasterWeight) MutateSetOptions

func (m MasterWeight) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for MasterWeight sets the SetOptionsOp's MasterWeight field

func (MasterWeight) MutateTransaction

func (m MasterWeight) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for MasterWeight allows creating an operation using a single mutator

type MemoHash

type MemoHash struct {
	Value xdr.Hash
}

MemoHash is a mutator that sets a memo on the mutated transaction of type MEMO_HASH.

func (MemoHash) MutateTransaction

func (m MemoHash) MutateTransaction(o *TransactionBuilder) (err error)

MutateTransaction for MemoHash sets the memo.

type MemoID

type MemoID struct {
	Value uint64
}

MemoID is a mutator that sets a memo on the mutated transaction of type MEMO_ID.

func (MemoID) MutateTransaction

func (m MemoID) MutateTransaction(o *TransactionBuilder) (err error)

MutateTransaction for MemoID sets the memo.

type MemoReturn

type MemoReturn struct {
	Value xdr.Hash
}

MemoReturn is a mutator that sets a memo on the mutated transaction of type MEMO_RETURN.

func (MemoReturn) MutateTransaction

func (m MemoReturn) MutateTransaction(o *TransactionBuilder) (err error)

MutateTransaction for MemoReturn sets the memo.

type MemoText

type MemoText struct {
	Value string
}

MemoText is a mutator that sets a memo on the mutated transaction of type MEMO_TEXT.

func (MemoText) MutateTransaction

func (m MemoText) MutateTransaction(o *TransactionBuilder) (err error)

MutateTransaction for MemoText sets the memo.

type MockSequenceProvider

type MockSequenceProvider struct {
	Data map[string]xdr.SequenceNumber
}

MockSequenceProvider is a mock sequence provider.

func (*MockSequenceProvider) SequenceForAccount

func (sp *MockSequenceProvider) SequenceForAccount(
	accountID string,
) (xdr.SequenceNumber, error)

SequenceForAccount implements `SequenceProvider`

type NativeAmount

type NativeAmount struct {
	Amount string
}

NativeAmount is a mutator that configures a payment to be using native currency and have the amount provided.

func (NativeAmount) MutatePayment

func (m NativeAmount) MutatePayment(o interface{}) (err error)

MutatePayment for NativeAmount sets the PaymentOp's currency field to native and sets its amount to the provided integer

type Network

type Network struct {
	Passphrase string
}

Network establishes the stellar network that a transaction should apply to. This modifier influences how a transaction is hashed for the purposes of signature generation.

func (*Network) ID

func (n *Network) ID() [32]byte

ID returns the network ID derived from this struct's Passphrase

func (Network) MutateTransaction

func (m Network) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for Network sets the Network ID to use when signing this transaction

type OfferID

type OfferID uint64

OfferID is a mutator that sets offer ID on offer operations

func (OfferID) MutateManageOffer

func (m OfferID) MutateManageOffer(o interface{}) (err error)

MutateManageOffer for OfferID sets the ManageOfferOp's OfferID field

type OpLongData

type OpLongData struct {
	OpData string
}

OpLongData is a mutator capable of setting the OpData on an operations that have one.

func (OpLongData) MutateAdministrativeOp

func (m OpLongData) MutateAdministrativeOp(o *AdministrativeOpBuilder) error

MutateAdministrativeOp for OpData sets the AdministrativeOpBuilder's OpData field

type OperationMutator

type OperationMutator interface {
	MutateOperation(*xdr.Operation) error
}

OperationMutator is a interface that wraps the MutateOperation operation. types may implement this interface to specify how they modify an xdr.Operation object

type PayWithPath

type PayWithPath struct {
	Asset
	MaxAmount string
	Path      []Asset
}

PayWithPath is a mutator that configures a path_payment's send asset and max amount

func PayWith

func PayWith(sendAsset Asset, maxAmount string) PayWithPath

PayWith is a helper to create PayWithPath struct

func (PayWithPath) MutatePayment

func (m PayWithPath) MutatePayment(o interface{}) (err error)

MutatePayment for PayWithPath sets the PathPaymentOp's SendAsset, SendMax and Path fields

func (PayWithPath) Through

func (pathSend PayWithPath) Through(asset Asset) PayWithPath

Through appends a new asset to the path

type PaymentBuilder

type PaymentBuilder struct {
	PathPayment bool
	O           xdr.Operation
	P           xdr.PaymentOp
	PP          xdr.PathPaymentOp
	Err         error
}

PaymentBuilder represents a transaction that is being built.

func Payment

func Payment(muts ...interface{}) (result PaymentBuilder)

Payment groups the creation of a new PaymentBuilder with a call to Mutate.

func (*PaymentBuilder) Mutate

func (b *PaymentBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (PaymentBuilder) MutateTransaction

func (m PaymentBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for PaymentBuilder causes the underylying PaymentOp or PathPaymentOp to be added to the operation list for the provided transaction

type PaymentID

type PaymentID struct {
	ID int64
}

func (PaymentID) MutatePaymentReversal

func (m PaymentID) MutatePaymentReversal(o interface{}) (err error)

MutatePaymentReversal for payment ID

type PaymentMutator

type PaymentMutator interface {
	MutatePayment(interface{}) error
}

PaymentMutator is a interface that wraps the MutatePayment operation. types may implement this interface to specify how they modify an xdr.PaymentOp object

type PaymentReversalBuilder

type PaymentReversalBuilder struct {
	O   xdr.Operation
	P   xdr.PaymentReversalOp
	Err error
}

PaymentReversalBuilder represents a transaction that is being built.

func PaymentReversal

func PaymentReversal(muts ...interface{}) (result PaymentReversalBuilder)

PaymentReversal groups the creation of a new PaymentReversalBuilder with a call to Mutate.

func (*PaymentReversalBuilder) Mutate

func (b *PaymentReversalBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment reversal or operation.

func (PaymentReversalBuilder) MutateTransaction

func (m PaymentReversalBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for PaymentReversalBuilder causes the underylying PaymentReversalOp to be added to the operation list for the provided transaction

type PaymentReversalMutator

type PaymentReversalMutator interface {
	MutatePaymentReversal(interface{}) error
}

PaymentReversalMutator is a interface that wraps the MutatePaymentReversal operation. types may implement this interface to specify how they modify an xdr.PaymentReversalOp object

type PaymentSender

type PaymentSender struct {
	AddressOrSeed string
}

func (PaymentSender) MutatePaymentReversal

func (m PaymentSender) MutatePaymentReversal(o interface{}) error

MutatePaymentReversal for Destination sets the PaymentReversalOp's Destination field

type Price

type Price string

Price is a mutator that sets price on offer operations

type Rate

type Rate struct {
	Selling Asset
	Buying  Asset
	Price
}

Rate is a mutator that sets selling/buying asset and price on offer operations

func (Rate) MutateManageOffer

func (m Rate) MutateManageOffer(o interface{}) (err error)

MutateManageOffer for Rate sets the ManageOfferOp's selling, buying and price fields

type Sequence

type Sequence struct {
	Sequence uint64
}

Sequence is a mutator that sets the sequence number on a transaction

func (Sequence) MutateTransaction

func (m Sequence) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for Sequence sets the SeqNum on the transaction.

type SequenceProvider

type SequenceProvider interface {
	SequenceForAccount(aid string) (xdr.SequenceNumber, error)
}

SequenceProvider is the interface that other packages may implement to be used with the `AutoSequence` mutator.

type SetFlag

type SetFlag int32

SetFlag is a mutator capable of setting account flags

func SetAuthImmutable

func SetAuthImmutable() SetFlag

SetAuthImmutable sets AuthImmutableFlag on SetOptions operation

func SetAuthRequired

func SetAuthRequired() SetFlag

SetAuthRequired sets AuthRequiredFlag on SetOptions operation

func SetAuthRevocable

func SetAuthRevocable() SetFlag

SetAuthRevocable sets AuthRevocableFlag on SetOptions operation

func (SetFlag) MutateSetOptions

func (m SetFlag) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for SetFlag sets the SetOptionsOp's SetFlags field

func (SetFlag) MutateTransaction

func (m SetFlag) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for SetFlag allows creating an operation using a single mutator

type SetOptionsBuilder

type SetOptionsBuilder struct {
	O   xdr.Operation
	SO  xdr.SetOptionsOp
	Err error
}

SetOptionsBuilder represents a transaction that is being built.

func SetOptions

func SetOptions(muts ...interface{}) (result SetOptionsBuilder)

SetOptions groups the creation of a new SetOptions with a call to Mutate.

Example

ExampleSetOptions creates and signs a simple transaction with SetOptions operation, and then encodes it into a base64 string capable of being submitted to stellar-core.

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	SetOptions(
		InflationDest("GCT7S5BA6ZC7SV7GGEMEYJTWOBYTBOA7SC4JEYP7IAEDG7HQNIWKRJ4G"),
		SetAuthRequired(),
		SetAuthRevocable(),
		SetAuthImmutable(),
		ClearAuthRequired(),
		ClearAuthRevocable(),
		ClearAuthImmutable(),
		MasterWeight(1),
		SetThresholds(2, 3, 4),
		HomeDomain("stellar.org"),
		AddSigner("GC6DDGPXVWXD5V6XOWJ7VUTDYI7VKPV2RAJWBVBHR47OPV5NASUNHTJW", 5, 0),
	),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func (*SetOptionsBuilder) Mutate

func (b *SetOptionsBuilder) Mutate(muts ...interface{})

Mutate applies the provided mutators to this builder's payment or operation.

func (SetOptionsBuilder) MutateTransaction

func (m SetOptionsBuilder) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for SetOptionsBuilder causes the underylying SetOptionsOp to be added to the operation list for the provided transaction

type SetOptionsMutator

type SetOptionsMutator interface {
	MutateSetOptions(*xdr.SetOptionsOp) error
}

SetOptionsMutator is a interface that wraps the MutateSetOptions operation. types may implement this interface to specify how they modify an xdr.SetOptionsOp object

type Sign

type Sign struct {
	Seed string
}

Sign is a mutator that contributes a signature of the provided envelope's transaction with the configured key

func (Sign) MutateTransactionEnvelope

func (m Sign) MutateTransactionEnvelope(txe *TransactionEnvelopeBuilder) error

MutateTransactionEnvelope adds a signature to the provided envelope

type Signer

type Signer struct {
	PublicKey  string
	Weight     uint32
	SignerType uint32
}

Signer is a mutator capable of adding, updating and deleting account signer

func AddSigner

func AddSigner(publicKey string, weight uint32, signerType uint32) Signer

AddSigner creates Signer mutator that sets account's signer

func RemoveSigner

func RemoveSigner(publicKey string) Signer

RemoveSigner creates Signer mutator that removes account's signer

func (Signer) MutateSetOptions

func (m Signer) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for Signer sets the SetOptionsOp's signer field

func (Signer) MutateTransaction

func (m Signer) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for Signer allows creating an operation using a single mutator

type SourceAccount

type SourceAccount struct {
	AddressOrSeed string
}

SourceAccount is a mutator capable of setting the source account on an xdr.Operation and an xdr.Transaction

func (SourceAccount) MutateOperation

func (m SourceAccount) MutateOperation(o *xdr.Operation) error

MutateOperation for SourceAccount sets the operation's SourceAccount to the pubilic key for the address provided

func (SourceAccount) MutateTransaction

func (m SourceAccount) MutateTransaction(o *TransactionBuilder) error

MutateTransaction for SourceAccount sets the transaction's SourceAccount to the pubilic key for the address provided

type Thresholds

type Thresholds struct {
	Low    *uint32
	Medium *uint32
	High   *uint32
}

Thresholds is a mutator capable of setting account thresholds

func SetHighThreshold

func SetHighThreshold(value uint32) Thresholds

SetHighThreshold creates Thresholds mutator that sets account's high threshold

func SetLowThreshold

func SetLowThreshold(value uint32) Thresholds

SetLowThreshold creates Thresholds mutator that sets account's low threshold

func SetMediumThreshold

func SetMediumThreshold(value uint32) Thresholds

SetMediumThreshold creates Thresholds mutator that sets account's medium threshold

func SetThresholds

func SetThresholds(low, medium, high uint32) Thresholds

SetThresholds creates Thresholds mutator

func (Thresholds) MutateSetOptions

func (m Thresholds) MutateSetOptions(o *xdr.SetOptionsOp) (err error)

MutateSetOptions for Thresholds sets the SetOptionsOp's thresholds fields

func (Thresholds) MutateTransaction

func (m Thresholds) MutateTransaction(t *TransactionBuilder) error

MutateTransaction for Thresholds allows creating an operation using a single mutator

type TransactionBuilder

type TransactionBuilder struct {
	TX        *xdr.Transaction
	NetworkID [32]byte
	Err       error
}

TransactionBuilder represents a Transaction that is being constructed.

Example

ExampleTransactionBuilder creates and signs a simple transaction, and then encodes it into a base64 string capable of being submitted to stellar-core.

It uses the transaction builder system

seed := "SDOTALIMPAM2IV65IOZA7KZL7XWZI5BODFXTRVLIHLQZQCKK57PH5F3H"
tx := Transaction(
	SourceAccount{seed},
	Sequence{1},
	Payment(
		Destination{"GAWSI2JO2CF36Z43UGMUJCDQ2IMR5B3P5TMS7XM7NUTU3JHG3YJUDQXA"},
		NativeAmount{"50"},
	),
)

txe := tx.Sign(seed)
txe.Base64()

//fmt.Printf("tx base64: %s", txeB64)
Output:

func Transaction

func Transaction(muts ...TransactionMutator) (result *TransactionBuilder)

Transaction groups the creation of a new TransactionBuilder with a call to Mutate.

func (*TransactionBuilder) Hash

func (b *TransactionBuilder) Hash() ([32]byte, error)

Hash returns the hash of this builder's transaction.

func (*TransactionBuilder) HashHex

func (b *TransactionBuilder) HashHex() (string, error)

HashHex returns the hex-encoded hash of this builder's transaction

func (*TransactionBuilder) Mutate

func (b *TransactionBuilder) Mutate(muts ...TransactionMutator)

Mutate applies the provided TransactionMutators to this builder's transaction

func (*TransactionBuilder) MutateTransactionEnvelope

func (m *TransactionBuilder) MutateTransactionEnvelope(txe *TransactionEnvelopeBuilder) error

MutateTransactionEnvelope for TransactionBuilder causes the underylying transaction to be set as the provided envelope's Tx field

func (*TransactionBuilder) Sign

func (b *TransactionBuilder) Sign(signers ...string) (result TransactionEnvelopeBuilder)

Sign returns an new TransactionEnvelopeBuilder using this builder's transaction as the basis and with signatures of that transaction from the provided Signers.

type TransactionEnvelopeBuilder

type TransactionEnvelopeBuilder struct {
	E   *xdr.TransactionEnvelope
	Err error
	// contains filtered or unexported fields
}

TransactionEnvelopeBuilder helps you build a TransactionEnvelope

func (*TransactionEnvelopeBuilder) Base64

func (b *TransactionEnvelopeBuilder) Base64() (string, error)

Base64 returns a string which is the xdr-then-base64-encoded form of the builder's underlying transaction envelope

func (*TransactionEnvelopeBuilder) Bytes

func (b *TransactionEnvelopeBuilder) Bytes() ([]byte, error)

Bytes encodes the builder's underlying envelope to XDR

func (*TransactionEnvelopeBuilder) Init

func (b *TransactionEnvelopeBuilder) Init()

func (*TransactionEnvelopeBuilder) Mutate

Mutate applies the provided TransactionEnvelopeMutators to this builder's envelope

func (*TransactionEnvelopeBuilder) MutateTX

func (b *TransactionEnvelopeBuilder) MutateTX(muts ...TransactionMutator)

MutateTX runs Mutate on the underlying transaction using the provided mutators.

type TransactionEnvelopeMutator

type TransactionEnvelopeMutator interface {
	MutateTransactionEnvelope(*TransactionEnvelopeBuilder) error
}

TransactionEnvelopeMutator is a interface that wraps the MutateTransactionEnvelope operation. types may implement this interface to specify how they modify an xdr.TransactionEnvelope object

type TransactionMutator

type TransactionMutator interface {
	MutateTransaction(*TransactionBuilder) error
}

TransactionMutator is a interface that wraps the MutateTransaction operation. types may implement this interface to specify how they modify an xdr.Transaction object

type Trustor

type Trustor struct {
	Address string
}

Trustor is a mutator capable of setting the trustor on allow_trust operation.

func (Trustor) MutateAllowTrust

func (m Trustor) MutateAllowTrust(o *xdr.AllowTrustOp) error

MutateAllowTrust for Trustor sets the AllowTrustOp's Trustor field

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL