bsv

Documentation

Index

• type CustomInstruction
• type CustomInstructions
• type FeeUnit
  • func (f *FeeUnit) IsLowerThan(other *FeeUnit) bool
  • func (f *FeeUnit) IsValid() bool
  • func (f *FeeUnit) IsZero() bool
  • func (f *FeeUnit) String() string
• type Outpoint
  • func OutpointFromString(s string) (Outpoint, error)
  • func (o Outpoint) String() string
• type Satoshis

Types

type CustomInstruction

type CustomInstruction struct {
	Type        string `json:"type"`
	Instruction string `json:"instruction"`
}

CustomInstruction represents a custom instruction how to unlock a UTXO.

type CustomInstructions

type CustomInstructions []CustomInstruction

CustomInstructions is a slice of CustomInstruction.

type FeeUnit

type FeeUnit struct {
	Satoshis Satoshis `json:"satoshis"` // Fee in satoshis of the amount of Bytes
	Bytes    int      `json:"bytes"`    // Number of bytes that the Fee covers
}

FeeUnit specifies how much satoshis will be paid per specific amount of bytes in a transaction see https://github.com/bitcoin-sv-specs/brfc-misc/tree/master/feespec

func (*FeeUnit) IsLowerThan

func (f *FeeUnit) IsLowerThan(other *FeeUnit) bool

IsLowerThan compare two fee units

func (*FeeUnit) IsValid

func (f *FeeUnit) IsValid() bool

IsValid returns true if the Bytes in fee are greater than 0

func (*FeeUnit) IsZero

func (f *FeeUnit) IsZero() bool

IsZero returns true if the fee unit suggest no fees (free)

func (*FeeUnit) String

func (f *FeeUnit) String() string

String returns the fee unit as a string

type Outpoint

type Outpoint struct {
	TxID string
	Vout uint32
}

Outpoint is a struct that represents a pair consisting of a transaction ID and an output index This represents a specific unspent transaction output (UTXO)

func OutpointFromString

func OutpointFromString(s string) (Outpoint, error)

OutpointFromString creates an Outpoint from a string

func (Outpoint) String

func (o Outpoint) String() string

String returns a string representation of outpoint

type Satoshis

type Satoshis uint64

Satoshis specifies a type that should be used to store value in satoshis