signer

Documentation

Index

• Variables
• func SignUnsigned(ctx stdcontext.Context, signer Signer, utx txs.UnsignedTx) (*txs.Tx, error)
• type Backend
• type Signer
  • func New(kc keychain.Keychain, backend Backend) Signer

Variables

var (
	ErrUnsupportedTxType       = errors.New("unsupported tx type")
	ErrUnknownInputType        = errors.New("unknown input type")
	ErrUnknownOutputType       = errors.New("unknown output type")
	ErrInvalidUTXOSigIndex     = errors.New("invalid UTXO signature index")
	ErrUnknownSupernetAuthType = errors.New("unknown supernet auth type")
	ErrUnknownOwnerType        = errors.New("unknown owner type")
	ErrUnknownCredentialType   = errors.New("unknown credential type")
)

Functions

func SignUnsigned

func SignUnsigned(
	ctx stdcontext.Context,
	signer Signer,
	utx txs.UnsignedTx,
) (*txs.Tx, error)

Types

type Backend

type Backend interface {
	GetUTXO(ctx stdcontext.Context, chainID, utxoID ids.ID) (*avax.UTXO, error)
	GetSupernetOwner(ctx stdcontext.Context, supernetID ids.ID) (fx.Owner, error)
}

type Signer

type Signer interface {
	// Sign adds as many missing signatures as possible to the provided
	// transaction.
	//
	// If there are already some signatures on the transaction, those signatures
	// will not be removed.
	//
	// If the signer doesn't have the ability to provide a required signature,
	// the signature slot will be skipped without reporting an error.
	Sign(ctx stdcontext.Context, tx *txs.Tx) error
}

func New

func New(kc keychain.Keychain, backend Backend) Signer