brc20

Documentation

Index

• Constants
• Variables
• func AddrToPkScript(addr string, network *chaincfg.Params) ([]byte, error)
• func PayToPubKeyHashScript(pubKeyHash []byte) ([]byte, error)
• func PayToWitnessPubKeyHashScript(pubKeyHash []byte) ([]byte, error)
• func Transfer(ins []*TxInput, outs []*TxOutput, network *chaincfg.Params) (string, error)
• type InscribeTxs
  • func Inscribe(network *chaincfg.Params, request *InscriptionRequest) (*InscribeTxs, error)
• type InscriptionData
• type InscriptionRequest
• type InscriptionTool
• type PrevOutput
• type TxInput
• type TxOutput

Constants

const (
	DefaultTxVersion      = 2
	DefaultSequenceNum    = mempool.MaxRBFSequence
	DefaultRevealOutValue = int64(546)
	MaxStandardTxWeight   = blockchain.MaxBlockWeight / 10
)

Variables

var (
	ErrInsufficientBalance = errors.New("insufficient balance")
)

Functions

func AddrToPkScript

func AddrToPkScript(addr string, network *chaincfg.Params) ([]byte, error)

func PayToPubKeyHashScript

func PayToPubKeyHashScript(pubKeyHash []byte) ([]byte, error)

func PayToWitnessPubKeyHashScript

func PayToWitnessPubKeyHashScript(pubKeyHash []byte) ([]byte, error)

func Transfer

func Transfer(ins []*TxInput, outs []*TxOutput, network *chaincfg.Params) (string, error)

Types

type InscribeTxs

type InscribeTxs struct {
	CommitTx     string   `json:"commitTx"`
	RevealTxs    []string `json:"revealTxs"`
	CommitTxFee  int64    `json:"commitTxFee"`
	RevealTxFees []int64  `json:"revealTxFees"`
}

func Inscribe

func Inscribe(network *chaincfg.Params, request *InscriptionRequest) (*InscribeTxs, error)

type InscriptionData

type InscriptionData struct {
	ContentType string `json:"contentType"`
	Body        []byte `json:"body"`
	RevealAddr  string `json:"revealAddr"`
}

type InscriptionRequest

type InscriptionRequest struct {
	CommitTxPrevOutputList []*PrevOutput     `json:"commitTxPrevOutputList"`
	CommitFeeRate          int64             `json:"commitFeeRate"`
	RevealFeeRate          int64             `json:"revealFeeRate"`
	InscriptionDataList    []InscriptionData `json:"inscriptionDataList"`
	RevealOutValue         int64             `json:"revealOutValue"`
	ChangeAddress          string            `json:"changeAddress"`
}

type InscriptionTool

type InscriptionTool struct {
	Network                   *chaincfg.Params
	CommitTxPrevOutputFetcher *txscript.MultiPrevOutFetcher
	CommitTxPrivateKeyList    []*btcec.PrivateKey
	InscriptionTxCtxDataList  []*inscriptionTxCtxData
	RevealTxPrevOutputFetcher *txscript.MultiPrevOutFetcher
	CommitTxPrevOutputList    []*PrevOutput
	RevealTx                  []*wire.MsgTx
	CommitTx                  *wire.MsgTx
	MustCommitTxFee           int64
	MustRevealTxFees          []int64
}

type PrevOutput

type PrevOutput struct {
	TxId       string `json:"txId"`
	VOut       uint32 `json:"vOut"`
	Amount     int64  `json:"amount"`
	Address    string `json:"address"`
	PrivateKey string `json:"privateKey"`
}

type TxInput

type TxInput struct {
	TxId           string
	VOut           uint32
	Amount         int64
	Address        string
	PrivateKey     string
	NonWitnessUtxo string // legacy address need
}

type TxOutput

type TxOutput struct {
	Address string
	Amount  int64
}