secp256k1fx

package
v1.6.2-rc.4 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2021 License: BSD-3-Clause Imports: 18 Imported by: 137

Documentation

Index

Constants

View Source
const (
	CostPerSignature uint64 = 1000
)

Variables

View Source
var (
	ID = ids.ID{'s', 'e', 'c', 'p', '2', '5', '6', 'k', '1', 'f', 'x'}
)

ID that this Fx uses when labeled

Functions

This section is empty.

Types

type Credential

type Credential struct {
	Sigs [][crypto.SECP256K1RSigLen]byte `serialize:"true" json:"signatures"`
}

func (*Credential) MarshalJSON added in v0.8.0

func (cr *Credential) MarshalJSON() ([]byte, error)

MarshalJSON marshals [cr] to JSON The string representation of each signature is created using the hex formatter

func (*Credential) Verify

func (cr *Credential) Verify() error

type Factory

type Factory struct{}

func (*Factory) New

func (f *Factory) New(*snow.Context) (interface{}, error)

type Fx

type Fx struct {
	VM          VM
	SECPFactory crypto.FactorySECP256K1R
	// contains filtered or unexported fields
}

Fx describes the secp256k1 feature extension

func (*Fx) Bootstrapped added in v0.8.0

func (fx *Fx) Bootstrapped() error

func (*Fx) Bootstrapping added in v0.8.0

func (fx *Fx) Bootstrapping() error

func (*Fx) CreateOutput added in v0.8.0

func (fx *Fx) CreateOutput(amount uint64, ownerIntf interface{}) (interface{}, error)

CreateOutput creates a new output with the provided control group worth the specified amount

func (*Fx) Initialize

func (fx *Fx) Initialize(vmIntf interface{}) error

func (*Fx) InitializeVM

func (fx *Fx) InitializeVM(vmIntf interface{}) error

func (*Fx) VerifyCredentials

func (fx *Fx) VerifyCredentials(tx Tx, in *Input, cred *Credential, out *OutputOwners) error

VerifyCredentials ensures that the output can be spent by the input with the credential. A nil return values means the output can be spent.

func (*Fx) VerifyOperation

func (fx *Fx) VerifyOperation(txIntf, opIntf, credIntf interface{}, utxosIntf []interface{}) error

func (*Fx) VerifyPermission added in v0.8.0

func (fx *Fx) VerifyPermission(txIntf, inIntf, credIntf, ownerIntf interface{}) error

VerifyPermission returns nil iff [credIntf] proves that [controlGroup] assents to [txIntf]

func (*Fx) VerifySpend

func (fx *Fx) VerifySpend(tx Tx, in *TransferInput, cred *Credential, utxo *TransferOutput) error

VerifySpend ensures that the utxo can be sent to any address

func (*Fx) VerifyTransfer

func (fx *Fx) VerifyTransfer(txIntf, inIntf, credIntf, utxoIntf interface{}) error

type Input

type Input struct {
	// This input consumes an output, which has an owner list.
	// This input will be spent with a list of signatures.
	// SignatureList[i] is the signature of OwnerList[i]
	SigIndices []uint32 `serialize:"true" json:"signatureIndices"`
}

func (*Input) Cost added in v1.5.0

func (in *Input) Cost() (uint64, error)

func (*Input) Verify

func (in *Input) Verify() error

Verify this input is syntactically valid

type Keychain

type Keychain struct {

	// These can be used to iterate over. However, they should not be modified externally.
	Addrs ids.ShortSet
	Keys  []*crypto.PrivateKeySECP256K1R
	// contains filtered or unexported fields
}

Keychain is a collection of keys that can be used to spend outputs

func NewKeychain

func NewKeychain() *Keychain

NewKeychain returns a new, empty, keychain

func (*Keychain) Add

func (kc *Keychain) Add(key *crypto.PrivateKeySECP256K1R)

Add a new key to the key chain

func (Keychain) Addresses

func (kc Keychain) Addresses() ids.ShortSet

Addresses returns a list of addresses this keychain manages

func (Keychain) Get

Get a key from the keychain. If the key is unknown, the

func (*Keychain) Match

func (kc *Keychain) Match(owners *OutputOwners, time uint64) ([]uint32, []*crypto.PrivateKeySECP256K1R, bool)

Match attempts to match a list of addresses up to the provided threshold

func (*Keychain) New

func (kc *Keychain) New() (*crypto.PrivateKeySECP256K1R, error)

New returns a newly generated private key

func (*Keychain) PrefixedString

func (kc *Keychain) PrefixedString(prefix string) string

PrefixedString returns the key chain as a string representation with [prefix] added before every line.

func (*Keychain) Spend

Spend attempts to create an input

func (*Keychain) String

func (kc *Keychain) String() string

type MintOperation

type MintOperation struct {
	MintInput      Input          `serialize:"true" json:"mintInput"`
	MintOutput     MintOutput     `serialize:"true" json:"mintOutput"`
	TransferOutput TransferOutput `serialize:"true" json:"transferOutput"`
}

func (*MintOperation) Cost added in v1.5.0

func (op *MintOperation) Cost() (uint64, error)

func (*MintOperation) InitCtx added in v1.4.12

func (op *MintOperation) InitCtx(ctx *snow.Context)

func (*MintOperation) Outs

func (op *MintOperation) Outs() []verify.State

func (*MintOperation) Verify

func (op *MintOperation) Verify() error

type MintOutput

type MintOutput struct {
	OutputOwners `serialize:"true"`
}

func (*MintOutput) Verify

func (out *MintOutput) Verify() error

func (*MintOutput) VerifyState added in v0.8.0

func (out *MintOutput) VerifyState() error

type OutputOwners

type OutputOwners struct {
	Locktime  uint64        `serialize:"true" json:"locktime"`
	Threshold uint32        `serialize:"true" json:"threshold"`
	Addrs     []ids.ShortID `serialize:"true" json:"addresses"`
	// contains filtered or unexported fields
}

func (*OutputOwners) Addresses

func (out *OutputOwners) Addresses() [][]byte

Addresses returns the addresses that manage this output

func (*OutputOwners) AddressesSet added in v0.8.0

func (out *OutputOwners) AddressesSet() ids.ShortSet

AddressesSet returns addresses as a set

func (*OutputOwners) Equals

func (out *OutputOwners) Equals(other *OutputOwners) bool

Equals returns true if the provided owners create the same condition

func (*OutputOwners) Fields added in v1.5.1

func (out *OutputOwners) Fields() (map[string]interface{}, error)

Fields returns JSON keys in a map that can be used with marshal JSON to serialise OutputOwners struct

func (*OutputOwners) InitCtx added in v1.4.12

func (out *OutputOwners) InitCtx(ctx *snow.Context)

InitCtx assigns the OutputOwners.ctx object to given [ctx] object Must be called at least once for MarshalJSON to work successfully

func (*OutputOwners) MarshalJSON added in v1.4.12

func (out *OutputOwners) MarshalJSON() ([]byte, error)

MarshalJSON marshals OutputOwners as JSON with human readable addresses. OutputOwners.InitCtx must be called before marshalling this or one of the parent objects to json. Uses the OutputOwners.ctx method to format the addresses. Returns errMarshal error if OutputOwners.ctx is not set.

func (*OutputOwners) Sort

func (out *OutputOwners) Sort()

func (*OutputOwners) Verify

func (out *OutputOwners) Verify() error

func (*OutputOwners) VerifyState added in v0.8.0

func (out *OutputOwners) VerifyState() error

type TestTx

type TestTx struct{ Bytes []byte }

TestTx is a minimal implementation of a Tx

func (*TestTx) UnsignedBytes

func (tx *TestTx) UnsignedBytes() []byte

UnsignedBytes returns Bytes

type TestVM

type TestVM struct {
	CLK   timer.Clock
	Codec codec.Registry
	Log   logging.Logger
}

TestVM is a minimal implementation of a VM

func (*TestVM) Clock

func (vm *TestVM) Clock() *timer.Clock

func (*TestVM) CodecRegistry added in v1.0.6

func (vm *TestVM) CodecRegistry() codec.Registry

func (*TestVM) Logger

func (vm *TestVM) Logger() logging.Logger

type TransferInput

type TransferInput struct {
	Amt   uint64 `serialize:"true" json:"amount"`
	Input `serialize:"true"`
}

func (*TransferInput) Amount

func (in *TransferInput) Amount() uint64

Amount returns the quantity of the asset this input produces

func (*TransferInput) InitCtx added in v1.4.12

func (in *TransferInput) InitCtx(*snow.Context)

func (*TransferInput) Verify

func (in *TransferInput) Verify() error

Verify this input is syntactically valid

type TransferOutput

type TransferOutput struct {
	Amt uint64 `serialize:"true" json:"amount"`

	OutputOwners `serialize:"true"`
}

func (*TransferOutput) Amount

func (out *TransferOutput) Amount() uint64

Amount returns the quantity of the asset this output consumes

func (*TransferOutput) MarshalJSON added in v1.5.1

func (out *TransferOutput) MarshalJSON() ([]byte, error)

MarshalJSON marshals Amt and the embedded OutputOwners struct into a JSON readable format If OutputOwners cannot be serialised then this will return error

func (*TransferOutput) Owners added in v0.8.0

func (out *TransferOutput) Owners() interface{}

func (*TransferOutput) Verify

func (out *TransferOutput) Verify() error

func (*TransferOutput) VerifyState added in v0.8.0

func (out *TransferOutput) VerifyState() error

type Tx

type Tx interface {
	UnsignedBytes() []byte
}

Tx that this Fx is supporting

type VM

type VM interface {
	CodecRegistry() codec.Registry
	Clock() *timer.Clock
	Logger() logging.Logger
}

VM that this Fx must be run by

Jump to

Keyboard shortcuts

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