bchutil: github.com/gcash/bchutil Index | Examples | Files | Directories

package bchutil

import "github.com/gcash/bchutil"

Package bchutil provides bitcoin cash-specific convenience functions and types.

Block Overview

A Block defines a bitcoin cash block that provides easier and more efficient manipulation of raw wire protocol blocks. It also memoizes hashes for the block and its transactions on their first access so subsequent accesses don't have to repeat the relatively expensive hashing operations.

Tx Overview

A Tx defines a bitcoin cash transaction that provides more efficient manipulation of raw wire protocol transactions. It memoizes the hash for the transaction on its first access so subsequent accesses don't have to repeat the relatively expensive hashing operations.

Address Overview

The Address interface provides an abstraction for a Bitcoin Cashaddress. While the most common type is a pay-to-pubkey-hash, Bitcoin Cash already supports others and may well support more in the future. This package currently provides implementations for the pay-to-pubkey, pay-to-pubkey-hash, and pay-to-script-hash address types.

To decode/encode an address:

// NOTE: The default network is only used for address types which do not
// already contain that information.  At this time, that is only
// pay-to-pubkey addresses.
addrString := "04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962" +
	"e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d57" +
	"8a4c702b6bf11d5f"
defaultNet := &chaincfg.MainNetParams
addr, err := bchutil.DecodeAddress(addrString, defaultNet)
if err != nil {
	fmt.Println(err)
	return
}
fmt.Println(addr.EncodeAddress())

Index

Examples

Package Files

address.go amount.go appdata.go block.go certgen.go const.go doc.go hash160.go net.go tx.go wif.go

Constants

const (
    // SatoshiPerBitcent is the number of satoshi in one bitcoin cent.
    SatoshiPerBitcent = 1e6

    // SatoshiPerBitcoin is the number of satoshi in one bitcoin (1 BTC).
    SatoshiPerBitcoin = 1e8

    // MaxSatoshi is the maximum transaction amount allowed in satoshi.
    MaxSatoshi = 21e6 * SatoshiPerBitcoin
)
const BlockHeightUnknown = int32(-1)

BlockHeightUnknown is the value returned for a block height that is unknown. This is typically because the block has not been inserted into the main chain yet.

const Charset string = "qpzry9x8gf2tvdw0s3jn54khce6mua7l"

Charset is the base32 character set for the cashaddr.

const TxIndexUnknown = -1

TxIndexUnknown is the value returned for a transaction index that is unknown. This is typically because the transaction has not been inserted into a block yet.

Variables

var (
    // ErrChecksumMismatch describes an error where decoding failed due
    // to a bad checksum.
    ErrChecksumMismatch = errors.New("checksum mismatch")

    // ErrUnknownAddressType describes an error where an address can not
    // decoded as a specific address type due to the string encoding
    // begining with an identifier byte unknown to any standard or
    // registered (via chaincfg.Register) network.
    ErrUnknownAddressType = errors.New("unknown address type")

    // ErrAddressCollision describes an error where an address can not
    // be uniquely determined as either a pay-to-pubkey-hash or
    // pay-to-script-hash address since the leading identifier is used for
    // describing both address kinds, but for different networks.  Rather
    // than assuming or defaulting to one or the other, this error is
    // returned and the caller must decide how to decode the address.
    ErrAddressCollision = errors.New("address collision")

    // ErrInvalidFormat describes an error where decoding failed due to invalid version
    ErrInvalidFormat = errors.New("invalid format: version and/or checksum bytes missing")
)
var CharsetRev = [128]int8{ /* 128 elements not displayed */

}

CharsetRev is the cashaddr character set for decoding.

var ErrMalformedPrivateKey = errors.New("malformed private key")

ErrMalformedPrivateKey describes an error where a WIF-encoded private key cannot be decoded due to being improperly formatted. This may occur if the byte length is incorrect or an unexpected magic number was encountered.

func AppDataDir Uses

func AppDataDir(appName string, roaming bool) string

AppDataDir returns an operating system specific directory to be used for storing application data for an application.

The appName parameter is the name of the application the data directory is being requested for. This function will prepend a period to the appName for POSIX style operating systems since that is standard practice. An empty appName or one with a single dot is treated as requesting the current directory so only "." will be returned. Further, the first character of appName will be made lowercase for POSIX style operating systems and uppercase for Mac and Windows since that is standard practice.

The roaming parameter only applies to Windows where it specifies the roaming application data profile (%APPDATA%) should be used instead of the local one (%LOCALAPPDATA%) that is used by default.

Example results:

dir := AppDataDir("myapp", false)
 POSIX (Linux/BSD): ~/.myapp
 Mac OS: $HOME/Library/Application Support/Myapp
 Windows: %LOCALAPPDATA%\Myapp
 Plan 9: $home/myapp

func DecodeCashAddress Uses

func DecodeCashAddress(str string) (string, []byte, error)

DecodeCashAddress decodes a cashaddr string and returns the prefix and data element.

func Hash160 Uses

func Hash160(buf []byte) []byte

Hash160 calculates the hash ripemd160(sha256(b)).

func NewTLSCertPair Uses

func NewTLSCertPair(organization string, validUntil time.Time, extraHosts []string) (cert, key []byte, err error)

NewTLSCertPair returns a new PEM-encoded x.509 certificate pair based on a 521-bit ECDSA private key. The machine's local interface addresses and all variants of IPv4 and IPv6 localhost are included as valid IP addresses.

type Address Uses

type Address interface {
    // String returns the string encoding of the transaction output
    // destination.
    //
    // Please note that String differs subtly from EncodeAddress: String
    // will return the value as a string without any conversion, while
    // EncodeAddress may convert destination types (for example,
    // converting pubkeys to P2PKH addresses) before encoding as a
    // payment address string.
    String() string

    // EncodeAddress returns the string encoding of the payment address
    // associated with the Address value.  See the comment on String
    // for how this method differs from String.
    EncodeAddress() string

    // ScriptAddress returns the raw bytes of the address to be used
    // when inserting the address into a txout's script.
    ScriptAddress() []byte

    // IsForNet returns whether or not the address is associated with the
    // passed bitcoin network.
    IsForNet(*chaincfg.Params) bool
}

Address is an interface type for any type of destination a transaction output may spend to. This includes pay-to-pubkey (P2PK), pay-to-pubkey-hash (P2PKH), and pay-to-script-hash (P2SH). Address is designed to be generic enough that other kinds of addresses may be added in the future without changing the decoding and encoding API.

func DecodeAddress Uses

func DecodeAddress(addr string, defaultNet *chaincfg.Params) (Address, error)

DecodeAddress decodes the string encoding of an address and returns the Address if addr is a valid encoding for a known address type.

The bitcoin network the address is associated with is extracted if possible. When the address does not encode the network, such as in the case of a raw public key, the address will be associated with the passed defaultNet.

type AddressPubKey Uses

type AddressPubKey struct {
    // contains filtered or unexported fields
}

AddressPubKey is an Address for a pay-to-pubkey transaction.

func NewAddressPubKey Uses

func NewAddressPubKey(serializedPubKey []byte, net *chaincfg.Params) (*AddressPubKey, error)

NewAddressPubKey returns a new AddressPubKey which represents a pay-to-pubkey address. The serializedPubKey parameter must be a valid pubkey and can be uncompressed, compressed, or hybrid.

func (*AddressPubKey) AddressPubKeyHash Uses

func (a *AddressPubKey) AddressPubKeyHash() *AddressPubKeyHash

AddressPubKeyHash returns the pay-to-pubkey address converted to a pay-to-pubkey-hash address. Note that the public key format (uncompressed, compressed, etc) will change the resulting address. This is expected since pay-to-pubkey-hash is a hash of the serialized public key which obviously differs with the format. At the time of this writing, most Bitcoin addresses are pay-to-pubkey-hash constructed from the uncompressed public key.

func (*AddressPubKey) EncodeAddress Uses

func (a *AddressPubKey) EncodeAddress() string

EncodeAddress returns the string encoding of the public key as a pay-to-pubkey-hash. Note that the public key format (uncompressed, compressed, etc) will change the resulting address. This is expected since pay-to-pubkey-hash is a hash of the serialized public key which obviously differs with the format. At the time of this writing, most Bitcoin addresses are pay-to-pubkey-hash constructed from the uncompressed public key.

Part of the Address interface.

func (*AddressPubKey) Format Uses

func (a *AddressPubKey) Format() PubKeyFormat

Format returns the format (uncompressed, compressed, etc) of the pay-to-pubkey address.

func (*AddressPubKey) IsForNet Uses

func (a *AddressPubKey) IsForNet(net *chaincfg.Params) bool

IsForNet returns whether or not the pay-to-pubkey address is associated with the passed bitcoin network.

func (*AddressPubKey) PubKey Uses

func (a *AddressPubKey) PubKey() *bchec.PublicKey

PubKey returns the underlying public key for the address.

func (*AddressPubKey) ScriptAddress Uses

func (a *AddressPubKey) ScriptAddress() []byte

ScriptAddress returns the bytes to be included in a txout script to pay to a public key. Setting the public key format will affect the output of this function accordingly. Part of the Address interface.

func (*AddressPubKey) SetFormat Uses

func (a *AddressPubKey) SetFormat(pkFormat PubKeyFormat)

SetFormat sets the format (uncompressed, compressed, etc) of the pay-to-pubkey address.

func (*AddressPubKey) String Uses

func (a *AddressPubKey) String() string

String returns the hex-encoded human-readable string for the pay-to-pubkey address. This is not the same as calling EncodeAddress.

type AddressPubKeyHash Uses

type AddressPubKeyHash struct {
    // contains filtered or unexported fields
}

AddressPubKeyHash is an Address for a pay-to-pubkey-hash (P2PKH) transaction.

func NewAddressPubKeyHash Uses

func NewAddressPubKeyHash(pkHash []byte, net *chaincfg.Params) (*AddressPubKeyHash, error)

NewAddressPubKeyHash returns a new AddressPubKeyHash. pkHash mustbe 20 bytes.

func (*AddressPubKeyHash) EncodeAddress Uses

func (a *AddressPubKeyHash) EncodeAddress() string

EncodeAddress returns the string encoding of a pay-to-pubkey-hash address. Part of the Address interface.

func (*AddressPubKeyHash) Hash160 Uses

func (a *AddressPubKeyHash) Hash160() *[ripemd160.Size]byte

Hash160 returns the underlying array of the pubkey hash. This can be useful when an array is more appropiate than a slice (for example, when used as map keys).

func (*AddressPubKeyHash) IsForNet Uses

func (a *AddressPubKeyHash) IsForNet(net *chaincfg.Params) bool

IsForNet returns whether or not the pay-to-pubkey-hash address is associated with the passed bitcoin cash network.

func (*AddressPubKeyHash) ScriptAddress Uses

func (a *AddressPubKeyHash) ScriptAddress() []byte

ScriptAddress returns the bytes to be included in a txout script to pay to a pubkey hash. Part of the Address interface.

func (*AddressPubKeyHash) String Uses

func (a *AddressPubKeyHash) String() string

String returns a human-readable string for the pay-to-pubkey-hash address. This is equivalent to calling EncodeAddress, but is provided so the type can be used as a fmt.Stringer.

type AddressScriptHash Uses

type AddressScriptHash struct {
    // contains filtered or unexported fields
}

AddressScriptHash is an Address for a pay-to-script-hash (P2SH) transaction.

func NewAddressScriptHash Uses

func NewAddressScriptHash(serializedScript []byte, net *chaincfg.Params) (*AddressScriptHash, error)

NewAddressScriptHash returns a new AddressScriptHash.

func NewAddressScriptHashFromHash Uses

func NewAddressScriptHashFromHash(scriptHash []byte, net *chaincfg.Params) (*AddressScriptHash, error)

NewAddressScriptHashFromHash returns a new AddressScriptHash. scriptHash must be 20 bytes.

func (*AddressScriptHash) EncodeAddress Uses

func (a *AddressScriptHash) EncodeAddress() string

EncodeAddress returns the string encoding of a pay-to-script-hash address. Part of the Address interface.

func (*AddressScriptHash) Hash160 Uses

func (a *AddressScriptHash) Hash160() *[ripemd160.Size]byte

Hash160 returns the underlying array of the script hash. This can be useful when an array is more appropiate than a slice (for example, when used as map keys).

func (*AddressScriptHash) IsForNet Uses

func (a *AddressScriptHash) IsForNet(net *chaincfg.Params) bool

IsForNet returns whether or not the pay-to-script-hash address is associated with the passed bitcoin cash network.

func (*AddressScriptHash) ScriptAddress Uses

func (a *AddressScriptHash) ScriptAddress() []byte

ScriptAddress returns the bytes to be included in a txout script to pay to a script hash. Part of the Address interface.

func (*AddressScriptHash) String Uses

func (a *AddressScriptHash) String() string

String returns a human-readable string for the pay-to-script-hash address. This is equivalent to calling EncodeAddress, but is provided so the type can be used as a fmt.Stringer.

type AddressType Uses

type AddressType int

AddressType represents the type of address and is used when encoding the cashaddr.

const (
    // AddrTypePayToPubKeyHash is the numeric identifier for
    // a cashaddr PayToPubkeyHash address
    AddrTypePayToPubKeyHash AddressType = 0

    // AddrTypePayToScriptHash is the numeric identifier for
    // a cashaddr PayToPubkeyHash address
    AddrTypePayToScriptHash AddressType = 1
)

type Amount Uses

type Amount int64

Amount represents the base bitcoin monetary unit (colloquially referred to as a `Satoshi'). A single Amount is equal to 1e-8 of a bitcoin.

Code:

a := bchutil.Amount(0)
fmt.Println("Zero Satoshi:", a)

a = bchutil.Amount(1e8)
fmt.Println("100,000,000 Satoshis:", a)

a = bchutil.Amount(1e5)
fmt.Println("100,000 Satoshis:", a)

Output:

Zero Satoshi: 0 BCH
100,000,000 Satoshis: 1 BCH
100,000 Satoshis: 0.001 BCH

Code:

amount := bchutil.Amount(44433322211100)

fmt.Println("Satoshi to kBCH:", amount.Format(bchutil.AmountKiloBCH))
fmt.Println("Satoshi to BCH:", amount)
fmt.Println("Satoshi to MilliBCH:", amount.Format(bchutil.AmountMilliBCH))
fmt.Println("Satoshi to MicroBCH:", amount.Format(bchutil.AmountMicroBCH))
fmt.Println("Satoshi to Satoshi:", amount.Format(bchutil.AmountSatoshi))

Output:

Satoshi to kBCH: 444.333222111 kBCH
Satoshi to BCH: 444333.222111 BCH
Satoshi to MilliBCH: 444333222.111 mBCH
Satoshi to MicroBCH: 444333222111 μBCH
Satoshi to Satoshi: 44433322211100 Satoshi

func NewAmount Uses

func NewAmount(f float64) (Amount, error)

NewAmount creates an Amount from a floating point value representing some value in bitcoin. NewAmount errors if f is NaN or +-Infinity, but does not check that the amount is within the total amount of bitcoin producible as f may not refer to an amount at a single moment in time.

NewAmount is for specifically for converting BCH to Satoshi. For creating a new Amount with an int64 value which denotes a quantity of Satoshi, do a simple type conversion from type int64 to Amount. See GoDoc for example: http://godoc.org/github.com/gcash/bchutil#example-Amount

Code:

amountOne, err := bchutil.NewAmount(1)
if err != nil {
    fmt.Println(err)
    return
}
fmt.Println(amountOne) //Output 1

amountFraction, err := bchutil.NewAmount(0.01234567)
if err != nil {
    fmt.Println(err)
    return
}
fmt.Println(amountFraction) //Output 2

amountZero, err := bchutil.NewAmount(0)
if err != nil {
    fmt.Println(err)
    return
}
fmt.Println(amountZero) //Output 3

amountNaN, err := bchutil.NewAmount(math.NaN())
if err != nil {
    fmt.Println(err)
    return
}
fmt.Println(amountNaN) //Output 4

Output:

1 BCH
0.01234567 BCH
0 BCH
invalid bitcoin amount

func (Amount) Format Uses

func (a Amount) Format(u AmountUnit) string

Format formats a monetary amount counted in bitcoin base units as a string for a given unit. The conversion will succeed for any unit, however, known units will be formated with an appended label describing the units with SI notation, or "Satoshi" for the base unit.

func (Amount) MulF64 Uses

func (a Amount) MulF64(f float64) Amount

MulF64 multiplies an Amount by a floating point value. While this is not an operation that must typically be done by a full node or wallet, it is useful for services that build on top of bitcoin (for example, calculating a fee by multiplying by a percentage).

func (Amount) String Uses

func (a Amount) String() string

String is the equivalent of calling Format with AmountBCH.

func (Amount) ToBCH Uses

func (a Amount) ToBCH() float64

ToBCH is the equivalent of calling ToUnit with AmountBCH.

func (Amount) ToUnit Uses

func (a Amount) ToUnit(u AmountUnit) float64

ToUnit converts a monetary amount counted in bitcoin base units to a floating point value representing an amount of bitcoin.

type AmountUnit Uses

type AmountUnit int

AmountUnit describes a method of converting an Amount to something other than the base unit of a bitcoin. The value of the AmountUnit is the exponent component of the decadic multiple to convert from an amount in bitcoin to an amount counted in units.

const (
    AmountMegaBCH  AmountUnit = 6
    AmountKiloBCH  AmountUnit = 3
    AmountBCH      AmountUnit = 0
    AmountMilliBCH AmountUnit = -3
    AmountMicroBCH AmountUnit = -6
    AmountSatoshi  AmountUnit = -8
)

These constants define various units used when describing a bitcoin monetary amount.

func (AmountUnit) String Uses

func (u AmountUnit) String() string

String returns the unit as a string. For recognized units, the SI prefix is used, or "Satoshi" for the base unit. For all unrecognized units, "1eN BCH" is returned, where N is the AmountUnit.

type Block Uses

type Block struct {
    // contains filtered or unexported fields
}

Block defines a bitcoin block that provides easier and more efficient manipulation of raw blocks. It also memoizes hashes for the block and its transactions on their first access so subsequent accesses don't have to repeat the relatively expensive hashing operations.

func NewBlock Uses

func NewBlock(msgBlock *wire.MsgBlock) *Block

NewBlock returns a new instance of a bitcoin block given an underlying wire.MsgBlock. See Block.

func NewBlockFromBlockAndBytes Uses

func NewBlockFromBlockAndBytes(msgBlock *wire.MsgBlock, serializedBlock []byte) *Block

NewBlockFromBlockAndBytes returns a new instance of a bitcoin block given an underlying wire.MsgBlock and the serialized bytes for it. See Block.

func NewBlockFromBytes Uses

func NewBlockFromBytes(serializedBlock []byte) (*Block, error)

NewBlockFromBytes returns a new instance of a bitcoin block given the serialized bytes. See Block.

func NewBlockFromReader Uses

func NewBlockFromReader(r io.Reader) (*Block, error)

NewBlockFromReader returns a new instance of a bitcoin block given a Reader to deserialize the block. See Block.

func (*Block) Bytes Uses

func (b *Block) Bytes() ([]byte, error)

Bytes returns the serialized bytes for the Block. This is equivalent to calling Serialize on the underlying wire.MsgBlock, however it caches the result so subsequent calls are more efficient.

func (*Block) Hash Uses

func (b *Block) Hash() *chainhash.Hash

Hash returns the block identifier hash for the Block. This is equivalent to calling BlockHash on the underlying wire.MsgBlock, however it caches the result so subsequent calls are more efficient.

func (*Block) Height Uses

func (b *Block) Height() int32

Height returns the saved height of the block in the block chain. This value will be BlockHeightUnknown if it hasn't already explicitly been set.

func (*Block) MsgBlock Uses

func (b *Block) MsgBlock() *wire.MsgBlock

MsgBlock returns the underlying wire.MsgBlock for the Block.

func (*Block) SetHeight Uses

func (b *Block) SetHeight(height int32)

SetHeight sets the height of the block in the block chain.

func (*Block) Transactions Uses

func (b *Block) Transactions() []*Tx

Transactions returns a slice of wrapped transactions (bchutil.Tx) for all transactions in the Block. This is nearly equivalent to accessing the raw transactions (wire.MsgTx) in the underlying wire.MsgBlock, however it instead provides easy access to wrapped versions (bchutil.Tx) of them.

func (*Block) Tx Uses

func (b *Block) Tx(txNum int) (*Tx, error)

Tx returns a wrapped transaction (bchutil.Tx) for the transaction at the specified index in the Block. The supplied index is 0 based. That is to say, the first transaction in the block is txNum 0. This is nearly equivalent to accessing the raw transaction (wire.MsgTx) from the underlying wire.MsgBlock, however the wrapped transaction has some helpful properties such as caching the hash so subsequent calls are more efficient.

func (*Block) TxHash Uses

func (b *Block) TxHash(txNum int) (*chainhash.Hash, error)

TxHash returns the hash for the requested transaction number in the Block. The supplied index is 0 based. That is to say, the first transaction in the block is txNum 0. This is equivalent to calling TxHash on the underlying wire.MsgTx, however it caches the result so subsequent calls are more efficient.

func (*Block) TxLoc Uses

func (b *Block) TxLoc() ([]wire.TxLoc, error)

TxLoc returns the offsets and lengths of each transaction in a raw block. It is used to allow fast indexing into transactions within the raw byte stream.

type LegacyAddressPubKeyHash Uses

type LegacyAddressPubKeyHash struct {
    // contains filtered or unexported fields
}

LegacyAddressPubKeyHash is an Address for a pay-to-pubkey-hash (P2PKH) transaction in the legacy format.

func NewLegacyAddressPubKeyHash Uses

func NewLegacyAddressPubKeyHash(pkHash []byte, net *chaincfg.Params) (*LegacyAddressPubKeyHash, error)

NewLegacyAddressPubKeyHash returns a new AddressPubKeyHash in the legacy format. pkHash mustbe 20 bytes.

func (*LegacyAddressPubKeyHash) EncodeAddress Uses

func (a *LegacyAddressPubKeyHash) EncodeAddress() string

EncodeAddress returns the string encoding of a pay-to-pubkey-hash address. Part of the Address interface.

func (*LegacyAddressPubKeyHash) Hash160 Uses

func (a *LegacyAddressPubKeyHash) Hash160() *[ripemd160.Size]byte

Hash160 returns the underlying array of the pubkey hash. This can be useful when an array is more appropiate than a slice (for example, when used as map keys).

func (*LegacyAddressPubKeyHash) IsForNet Uses

func (a *LegacyAddressPubKeyHash) IsForNet(net *chaincfg.Params) bool

IsForNet returns whether or not the pay-to-pubkey-hash address is associated with the passed bitcoin network.

func (*LegacyAddressPubKeyHash) ScriptAddress Uses

func (a *LegacyAddressPubKeyHash) ScriptAddress() []byte

ScriptAddress returns the bytes to be included in a txout script to pay to a pubkey hash. Part of the Address interface.

func (*LegacyAddressPubKeyHash) String Uses

func (a *LegacyAddressPubKeyHash) String() string

String returns a human-readable string for the pay-to-pubkey-hash address. This is equivalent to calling EncodeAddress, but is provided so the type can be used as a fmt.Stringer.

type LegacyAddressScriptHash Uses

type LegacyAddressScriptHash struct {
    // contains filtered or unexported fields
}

LegacyAddressScriptHash is an Address for a pay-to-script-hash (P2SH) transaction in legacy format.

func NewLegacyAddressScriptHash Uses

func NewLegacyAddressScriptHash(serializedScript []byte, net *chaincfg.Params) (*LegacyAddressScriptHash, error)

NewLegacyAddressScriptHash returns a new LegacyAddressScriptHash.

func NewLegacyAddressScriptHashFromHash Uses

func NewLegacyAddressScriptHashFromHash(scriptHash []byte, net *chaincfg.Params) (*LegacyAddressScriptHash, error)

NewLegacyAddressScriptHashFromHash returns a new AddressScriptHash. scriptHash must be 20 bytes.

func (*LegacyAddressScriptHash) EncodeAddress Uses

func (a *LegacyAddressScriptHash) EncodeAddress() string

EncodeAddress returns the string encoding of a pay-to-script-hash address. Part of the Address interface.

func (*LegacyAddressScriptHash) Hash160 Uses

func (a *LegacyAddressScriptHash) Hash160() *[ripemd160.Size]byte

Hash160 returns the underlying array of the script hash. This can be useful when an array is more appropiate than a slice (for example, when used as map keys).

func (*LegacyAddressScriptHash) IsForNet Uses

func (a *LegacyAddressScriptHash) IsForNet(net *chaincfg.Params) bool

IsForNet returns whether or not the pay-to-script-hash address is associated with the passed bitcoin network.

func (*LegacyAddressScriptHash) ScriptAddress Uses

func (a *LegacyAddressScriptHash) ScriptAddress() []byte

ScriptAddress returns the bytes to be included in a txout script to pay to a script hash. Part of the Address interface.

func (*LegacyAddressScriptHash) String Uses

func (a *LegacyAddressScriptHash) String() string

String returns a human-readable string for the pay-to-script-hash address. This is equivalent to calling EncodeAddress, but is provided so the type can be used as a fmt.Stringer.

type OutOfRangeError Uses

type OutOfRangeError string

OutOfRangeError describes an error due to accessing an element that is out of range.

func (OutOfRangeError) Error Uses

func (e OutOfRangeError) Error() string

Error satisfies the error interface and prints human-readable errors.

type PubKeyFormat Uses

type PubKeyFormat int

PubKeyFormat describes what format to use for a pay-to-pubkey address.

const (
    // PKFUncompressed indicates the pay-to-pubkey address format is an
    // uncompressed public key.
    PKFUncompressed PubKeyFormat = iota

    // PKFCompressed indicates the pay-to-pubkey address format is a
    // compressed public key.
    PKFCompressed

    // PKFHybrid indicates the pay-to-pubkey address format is a hybrid
    // public key.
    PKFHybrid
)

type Tx Uses

type Tx struct {
    // contains filtered or unexported fields
}

Tx defines a bitcoin transaction that provides easier and more efficient manipulation of raw transactions. It also memoizes the hash for the transaction on its first access so subsequent accesses don't have to repeat the relatively expensive hashing operations.

func NewTx Uses

func NewTx(msgTx *wire.MsgTx) *Tx

NewTx returns a new instance of a bitcoin transaction given an underlying wire.MsgTx. See Tx.

func NewTxFromBytes Uses

func NewTxFromBytes(serializedTx []byte) (*Tx, error)

NewTxFromBytes returns a new instance of a bitcoin transaction given the serialized bytes. See Tx.

func NewTxFromReader Uses

func NewTxFromReader(r io.Reader) (*Tx, error)

NewTxFromReader returns a new instance of a bitcoin transaction given a Reader to deserialize the transaction. See Tx.

func (*Tx) Hash Uses

func (t *Tx) Hash() *chainhash.Hash

Hash returns the hash of the transaction. This is equivalent to calling TxHash on the underlying wire.MsgTx, however it caches the result so subsequent calls are more efficient.

func (*Tx) Index Uses

func (t *Tx) Index() int

Index returns the saved index of the transaction within a block. This value will be TxIndexUnknown if it hasn't already explicitly been set.

func (*Tx) MsgTx Uses

func (t *Tx) MsgTx() *wire.MsgTx

MsgTx returns the underlying wire.MsgTx for the transaction.

func (*Tx) SetIndex Uses

func (t *Tx) SetIndex(index int)

SetIndex sets the index of the transaction in within a block.

type WIF Uses

type WIF struct {
    // PrivKey is the private key being imported or exported.
    PrivKey *bchec.PrivateKey

    // CompressPubKey specifies whether the address controlled by the
    // imported or exported private key was created by hashing a
    // compressed (33-byte) serialized public key, rather than an
    // uncompressed (65-byte) one.
    CompressPubKey bool
    // contains filtered or unexported fields
}

WIF contains the individual components described by the Wallet Import Format (WIF). A WIF string is typically used to represent a private key and its associated address in a way that may be easily copied and imported into or exported from wallet software. WIF strings may be decoded into this structure by calling DecodeWIF or created with a user-provided private key by calling NewWIF.

func DecodeWIF Uses

func DecodeWIF(wif string) (*WIF, error)

DecodeWIF creates a new WIF structure by decoding the string encoding of the import format.

The WIF string must be a base58-encoded string of the following byte sequence:

* 1 byte to identify the network, must be 0x80 for mainnet or 0xef for
  either testnet3 or the regression test network
* 32 bytes of a binary-encoded, big-endian, zero-padded private key
* Optional 1 byte (equal to 0x01) if the address being imported or exported
  was created by taking the RIPEMD160 after SHA256 hash of a serialized
  compressed (33-byte) public key
* 4 bytes of checksum, must equal the first four bytes of the double SHA256
  of every byte before the checksum in this sequence

If the base58-decoded byte sequence does not match this, DecodeWIF will return a non-nil error. ErrMalformedPrivateKey is returned when the WIF is of an impossible length or the expected compressed pubkey magic number does not equal the expected value of 0x01. ErrChecksumMismatch is returned if the expected WIF checksum does not match the calculated checksum.

func NewWIF Uses

func NewWIF(privKey *bchec.PrivateKey, net *chaincfg.Params, compress bool) (*WIF, error)

NewWIF creates a new WIF structure to export an address and its private key as a string encoded in the Wallet Import Format. The compress argument specifies whether the address intended to be imported or exported was created by serializing the public key compressed rather than uncompressed.

func (*WIF) IsForNet Uses

func (w *WIF) IsForNet(net *chaincfg.Params) bool

IsForNet returns whether or not the decoded WIF structure is associated with the passed bitcoin network.

func (*WIF) SerializePubKey Uses

func (w *WIF) SerializePubKey() []byte

SerializePubKey serializes the associated public key of the imported or exported private key in either a compressed or uncompressed format. The serialization format chosen depends on the value of w.CompressPubKey.

func (*WIF) String Uses

func (w *WIF) String() string

String creates the Wallet Import Format string encoding of a WIF structure. See DecodeWIF for a detailed breakdown of the format and requirements of a valid WIF string.

Directories

PathSynopsis
base58Package base58 provides an API for working with modified base58 and Base58Check encodings.
bech32Package bech32 provides a Go implementation of the bech32 format specified in BIP 173.
bloom
coinset
gcsPackage gcs provides an API for building and using a Golomb-coded set filter.
gcs/builder
hdkeychainPackage hdkeychain provides an API for bitcoin hierarchical deterministic extended keys (BIP0032).
jsonpb
jsonpb/testpb
merkleblock
txsortPackage txsort provides the transaction sorting according to BIP 69.

Package bchutil imports 31 packages (graph) and is imported by 77 packages. Updated 2019-10-14. Refresh now. Tools for package owners.