pegin

package

v1.0.2 Latest Latest Go to latest Published: Dec 2, 2021 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/yenkuanlee/go-elements

Links

Open Source Insights

Documentation ¶

Index ¶

func Claim(btcNetwork *chaincfg.Params, isDynaFedEnabled bool, peggedAsset []byte, ...) (*transaction.Transaction, error)
func ClaimWitnessScript(publicKeyBytes []byte, net *network.Network) ([]byte, error)
func GetPeginTxOutIndexAndAmount(btcTx []byte, fedpegScript []byte, contract []byte, ...) (uint32, int64, error)
func MainChainAddress(contract []byte, btcNetwork *chaincfg.Params, isDynaFedEnabled bool, ...) (string, error)
func SerializeValue(value int64) ([]byte, error)
func StripWitnessFromBtcTx(btcTx []byte) ([]byte, error)
type AddressInfo
type FedpegInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Claim ¶

func Claim(
	btcNetwork *chaincfg.Params,
	isDynaFedEnabled bool,
	peggedAsset []byte,
	parentGenesisBlockHash []byte,
	fedpegScript []byte,
	contract []byte,
	btcTx []byte,
	btcTxOutProof []byte,
	claimScript []byte,
	milisatsPerByte float64,
) (*transaction.Transaction, error)

Claim crafts raw claim pegin transaction which is to be signed and broadcated to network

func ClaimWitnessScript ¶

func ClaimWitnessScript(
	publicKeyBytes []byte,
	net *network.Network,
) ([]byte, error)

ClaimWitnessScript returns claim script that is to be used to calculate contract (pegincontract.Calculate) and craft raw pegin transaction (pegin.Claim)

func GetPeginTxOutIndexAndAmount ¶

func GetPeginTxOutIndexAndAmount(
	btcTx []byte,
	fedpegScript []byte,
	contract []byte,
	btcNetwork *chaincfg.Params,
	isDynaFedEnabled bool,
) (uint32, int64, error)

func MainChainAddress ¶

func MainChainAddress(
	contract []byte,
	btcNetwork *chaincfg.Params,
	isDynaFedEnabled bool,
	fedpegScript []byte,
) (string, error)

MainChainAddress creates btc address to which BTC amount is to be sent that is to be pegged in Liquid network

func SerializeValue ¶

func SerializeValue(value int64) ([]byte, error)

func StripWitnessFromBtcTx ¶

func StripWitnessFromBtcTx(btcTx []byte) ([]byte, error)

Types ¶

type AddressInfo ¶

type AddressInfo struct {
	ClaimScript      string
	MainChainAddress string
}

type FedpegInfo ¶

type FedpegInfo struct {
	FedpegScript  []byte
	FedpegProgram []byte
}

Source Files ¶

View all Source files

pegin.go

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