common

package

v1.13.2 Latest Latest Go to latest Published: Jun 23, 2025 License: BSD-3-Clause Imports: 11 Imported by: 66

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ava-labs/avalanchego

Links

Open Source Insights

Documentation ¶

Index ¶

func MatchOwners(owners *secp256k1fx.OutputOwners, addrs set.Set[ids.ShortID], ...) ([]uint32, bool)
type ChainUTXOs
- func NewChainUTXOs(chainID ids.ID, utxos UTXOs) ChainUTXOs
type ConfirmationReceipt
type IssuanceReceipt
type Option
type Options
- func NewOptions(ops []Option) *Options
type UTXOs
- func NewUTXOs() UTXOs

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MatchOwners ¶

func MatchOwners(
	owners *secp256k1fx.OutputOwners,
	addrs set.Set[ids.ShortID],
	minIssuanceTime uint64,
) ([]uint32, bool)

MatchOwners attempts to match a list of addresses up to the provided threshold.

Types ¶

type ChainUTXOs ¶ added in v1.10.9

type ChainUTXOs interface {
	AddUTXO(ctx context.Context, destinationChainID ids.ID, utxo *avax.UTXO) error
	RemoveUTXO(ctx context.Context, sourceChainID, utxoID ids.ID) error

	UTXOs(ctx context.Context, sourceChainID ids.ID) ([]*avax.UTXO, error)
	GetUTXO(ctx context.Context, sourceChainID, utxoID ids.ID) (*avax.UTXO, error)
}

func NewChainUTXOs ¶ added in v1.11.0

func NewChainUTXOs(chainID ids.ID, utxos UTXOs) ChainUTXOs

type ConfirmationReceipt ¶ added in v1.13.1

type ConfirmationReceipt struct {
	// Identifies the primary chain ("P", "X" or "C")
	ChainAlias string
	// ID of the issued transaction
	TxID ids.ID
	// The time from initiation to confirmation
	TotalDuration time.Duration
	// The time from issuance to confirmation. It does not include the duration
	// of issuance.
	ConfirmationDuration time.Duration
}

ConfirmationReceipt is the information known after issuing and confirming a transaction.

type IssuanceReceipt ¶ added in v1.13.1

type IssuanceReceipt struct {
	// Identifies the primary chain ("P", "X" or "C")
	ChainAlias string
	// ID of the issued transaction
	TxID ids.ID
	// The time from initiation to issuance
	Duration time.Duration
}

IssuanceReceipt is the information known after issuing a transaction.

type Option ¶

type Option func(*Options)

func UnionOptions ¶

func UnionOptions(first, second []Option) []Option

func WithAssumeDecided ¶

func WithAssumeDecided() Option

func WithBaseFee ¶ added in v1.10.9

func WithBaseFee(baseFee *big.Int) Option

func WithChangeOwner ¶

func WithChangeOwner(changeOwner *secp256k1fx.OutputOwners) Option

func WithConfirmationHandler ¶ added in v1.13.1

func WithConfirmationHandler(f func(ConfirmationReceipt)) Option

func WithContext ¶

func WithContext(ctx context.Context) Option

func WithCustomAddresses ¶

func WithCustomAddresses(addrs set.Set[ids.ShortID]) Option

func WithCustomEthAddresses ¶ added in v1.10.9

func WithCustomEthAddresses(addrs set.Set[ethcommon.Address]) Option

func WithIssuanceHandler ¶ added in v1.13.1

func WithIssuanceHandler(f func(IssuanceReceipt)) Option

func WithMemo ¶

func WithMemo(memo []byte) Option

func WithMinIssuanceTime ¶

func WithMinIssuanceTime(minIssuanceTime uint64) Option

func WithPollFrequency ¶

func WithPollFrequency(pollFrequency time.Duration) Option

func WithStakeableLocked ¶

func WithStakeableLocked() Option

type Options ¶

type Options struct {
	// contains filtered or unexported fields
}

func NewOptions ¶

func NewOptions(ops []Option) *Options

func (*Options) Addresses ¶

func (o *Options) Addresses(defaultAddresses set.Set[ids.ShortID]) set.Set[ids.ShortID]

func (*Options) AllowStakeableLocked ¶

func (o *Options) AllowStakeableLocked() bool

func (*Options) AssumeDecided ¶

func (o *Options) AssumeDecided() bool

func (*Options) BaseFee ¶ added in v1.10.9

func (o *Options) BaseFee(defaultBaseFee *big.Int) *big.Int

func (*Options) ChangeOwner ¶

func (o *Options) ChangeOwner(defaultOwner *secp256k1fx.OutputOwners) *secp256k1fx.OutputOwners

func (*Options) ConfirmationHandler ¶ added in v1.13.1

func (o *Options) ConfirmationHandler() func(ConfirmationReceipt)

func (*Options) Context ¶

func (o *Options) Context() context.Context

func (*Options) EthAddresses ¶ added in v1.10.9

func (o *Options) EthAddresses(defaultAddresses set.Set[ethcommon.Address]) set.Set[ethcommon.Address]

func (*Options) IssuanceHandler ¶ added in v1.13.1

func (o *Options) IssuanceHandler() func(IssuanceReceipt)

func (*Options) Memo ¶

func (o *Options) Memo() []byte

func (*Options) MinIssuanceTime ¶

func (o *Options) MinIssuanceTime() uint64

func (*Options) PollFrequency ¶

func (o *Options) PollFrequency() time.Duration

type UTXOs ¶ added in v1.11.0

type UTXOs interface {
	AddUTXO(ctx context.Context, sourceChainID, destinationChainID ids.ID, utxo *avax.UTXO) error
	RemoveUTXO(ctx context.Context, sourceChainID, destinationChainID, utxoID ids.ID) error

	UTXOs(ctx context.Context, sourceChainID, destinationChainID ids.ID) ([]*avax.UTXO, error)
	GetUTXO(ctx context.Context, sourceChainID, destinationChainID, utxoID ids.ID) (*avax.UTXO, error)
}

func NewUTXOs ¶ added in v1.11.0

func NewUTXOs() UTXOs

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
utxotest

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL