transaction

Documentation

Index

• type Annotations
• type Bucket
• type OutputAnnotation
  • func NewDataOutputAnnotation() *OutputAnnotation
• type OutputsAnnotations
• type PaymailAnnotation

Types

type Annotations

type Annotations struct {
	Outputs OutputsAnnotations
}

Annotations represents a transaction metadata that will be used by server to properly handle given transaction.

type Bucket

type Bucket string

Bucket represents the UTXO bucket where the output belongs to.

const (
	// BucketData represents the bucket for the data only outputs.
	BucketData Bucket = "data"
	// BucketBSV represents the bucket for the BSV outputs.
	BucketBSV Bucket = "bsv"
)

type OutputAnnotation

type OutputAnnotation struct {
	// What type of bucket should this output be stored in.
	Bucket Bucket
	// Paymail is available if the output is the paymail output.
	Paymail *PaymailAnnotation
}

OutputAnnotation represents the metadata for the output.

func NewDataOutputAnnotation

func NewDataOutputAnnotation() *OutputAnnotation

NewDataOutputAnnotation constructs a new OutputAnnotation for the data output.

type OutputsAnnotations

type OutputsAnnotations map[int]*OutputAnnotation

OutputsAnnotations represents the metadata for chosen outputs. The key is the index of the output.

type PaymailAnnotation

type PaymailAnnotation struct {
	Receiver  string
	Reference string
	Sender    string
}

PaymailAnnotation is the metadata for the paymail output.