txs

Documentation

Index

• func NewAminoCodec() *aminoCodec
• func NewJSONCodec() *jsonCodec
• type Codec
• type Decoder
• type Encoder
• type Envelope
  • func Enclose(chainID string, payload payload.Payload) *Envelope
  • func (txEnv *Envelope) Sign(signingAccounts ...acm.AddressableSigner) error
  • func (txEnv *Envelope) String() string
  • func (txEnv *Envelope) Validate() error
  • func (txEnv *Envelope) Verify(getter state.AccountGetter) error
• type Receipt
• type Signatory
  • func (s *Signatory) RealisePublicKey(getter state.AccountGetter) error
• type Tx
  • func NewTx(payload payload.Payload) *Tx
  • func (tx *Tx) Enclose() *Envelope
  • func (tx *Tx) GenerateReceipt() *Receipt
  • func (tx *Tx) Hash() []byte
  • func (tx *Tx) MarshalJSON() ([]byte, error)
  • func (tx *Tx) MustSignBytes() []byte
  • func (tx *Tx) Rehash() []byte
  • func (tx *Tx) Sign(signingAccounts ...acm.AddressableSigner) (*Envelope, error)
  • func (tx *Tx) SignBytes() ([]byte, error)
  • func (tx *Tx) String() string
  • func (tx *Tx) Type() payload.Type
  • func (tx *Tx) UnmarshalJSON(data []byte) error

Functions

func NewAminoCodec

func NewAminoCodec() *aminoCodec

func NewJSONCodec

func NewJSONCodec() *jsonCodec

Types

type Codec

type Codec interface {
	Encoder
	Decoder
}

type Decoder

type Decoder interface {
	DecodeTx(txBytes []byte) (*Envelope, error)
}

type Encoder

type Encoder interface {
	EncodeTx(envelope *Envelope) ([]byte, error)
}

type Envelope

type Envelope struct {
	Signatories []Signatory
	Tx          *Tx
}

An envelope contains both the signable Tx and the signatures for each input (in signatories)

func Enclose

func Enclose(chainID string, payload payload.Payload) *Envelope

Enclose a Payload in an Envelope so it is ready to be signed by first wrapping the Payload as a Tx (including ChainID) and writing it to the Tx field of the Envelope

func (*Envelope) Sign

func (txEnv *Envelope) Sign(signingAccounts ...acm.AddressableSigner) error

Sign the Tx Envelope by adding Signatories containing the signatures for each TxInput. signing accounts for each input must be provided (in any order).

func (*Envelope) String

func (txEnv *Envelope) String() string

func (*Envelope) Validate

func (txEnv *Envelope) Validate() error

Returns an error if Envelope has a nil transaction or zero signatures (and therefore could not possibly be valid)

func (*Envelope) Verify

func (txEnv *Envelope) Verify(getter state.AccountGetter) error

Verifies the validity of the Signatories' Signatures in the Envelope. The Signatories must appear in the same order as the inputs as returned by Tx.GetInputs().

type Receipt

type Receipt struct {
	TxHash          binary.HexBytes
	CreatesContract bool
	ContractAddress crypto.Address
}

BroadcastTx or Transaction receipt

type Signatory

type Signatory struct {
	Address   *crypto.Address
	PublicKey *crypto.PublicKey
	crypto.Signature
}

Signatory contains signature and one or both of Address and PublicKey to identify the signer

func (*Signatory) RealisePublicKey

func (s *Signatory) RealisePublicKey(getter state.AccountGetter) error

Attempts to 'realise' the PublicKey and Address of a Signatory possibly referring to state in the case where the Signatory contains an Address by no PublicKey. Checks consistency in other cases, possibly generating the Address from the PublicKey

type Tx

type Tx struct {
	ChainID string
	payload.Payload
	// contains filtered or unexported fields
}

Tx is the canonical object that we serialise to produce the SignBytes that we sign

func NewTx

func NewTx(payload payload.Payload) *Tx

Wrap the Payload in Tx required for signing and serialisation

func (*Tx) Enclose

func (tx *Tx) Enclose() *Envelope

Enclose this Tx in an Envelope to be signed

func (*Tx) GenerateReceipt

func (tx *Tx) GenerateReceipt() *Receipt

Generate a transaction Receipt containing the Tx hash and other information if the Tx is call. Returned by ABCI methods.

func (*Tx) Hash

func (tx *Tx) Hash() []byte

Generate a Hash for this transaction based on the SignBytes. The hash is memoized over the lifetime of the Tx so repeated calls to Hash() are effectively free

func (*Tx) MarshalJSON

func (tx *Tx) MarshalJSON() ([]byte, error)

func (*Tx) MustSignBytes

func (tx *Tx) MustSignBytes() []byte

Generate SignBytes, panicking on any failure

func (*Tx) Rehash

func (tx *Tx) Rehash() []byte

Regenerate the Tx hash if it has been mutated or as called by Hash() in first instance

func (*Tx) Sign

func (tx *Tx) Sign(signingAccounts ...acm.AddressableSigner) (*Envelope, error)

Encloses in Envelope and signs envelope

func (*Tx) SignBytes

func (tx *Tx) SignBytes() ([]byte, error)

Produces the canonical SignBytes (the Tx message that will be signed) for a Tx

func (*Tx) String

func (tx *Tx) String() string

func (*Tx) Type

func (tx *Tx) Type() payload.Type

func (*Tx) UnmarshalJSON

func (tx *Tx) UnmarshalJSON(data []byte) error