snowgem

Documentation

Index

• Constants
• Variables
• func GetChainParams(chain string) *chaincfg.Params
• func NewSnowGemRPC(config json.RawMessage, pushHandler func(bchain.NotificationType)) (bchain.BlockChain, error)
• type SnowGemParser
  • func NewSnowGemParser(params *chaincfg.Params, c *btc.Configuration) *SnowGemParser
  • func (p *SnowGemParser) PackTx(tx *bchain.Tx, height uint32, blockTime int64) ([]byte, error)
  • func (p *SnowGemParser) UnpackTx(buf []byte) (*bchain.Tx, uint32, error)
• type SnowGemRPC
  • func (z *SnowGemRPC) GetBlock(hash string, height uint32) (*bchain.Block, error)
  • func (z *SnowGemRPC) GetMempoolEntry(txid string) (*bchain.MempoolEntry, error)
  • func (z *SnowGemRPC) GetTransactionForMempool(txid string) (*bchain.Tx, error)
  • func (z *SnowGemRPC) Initialize() error

Constants

const (
	// MainnetMagic is mainnet network constant
	MainnetMagic wire.BitcoinNet = 0x6427c824
	// TestnetMagic is testnet network constant
	TestnetMagic wire.BitcoinNet = 0xbff91afa
	// RegtestMagic is regtest network constant
	RegtestMagic wire.BitcoinNet = 0x5f3fe8aa
)

Variables

var (
	// MainNetParams are parser parameters for mainnet
	MainNetParams chaincfg.Params
	// TestNetParams are parser parameters for testnet
	TestNetParams chaincfg.Params
	// RegtestParams are parser parameters for regtest
	RegtestParams chaincfg.Params
)

Functions

func GetChainParams

func GetChainParams(chain string) *chaincfg.Params

GetChainParams contains network parameters for the main SnowGem network, the regression test SnowGem network, the test SnowGem network and the simulation test SnowGem network, in this order

func NewSnowGemRPC

func NewSnowGemRPC(config json.RawMessage, pushHandler func(bchain.NotificationType)) (bchain.BlockChain, error)

NewSnowGemRPC returns new SnowGemRPC instance

Types

type SnowGemParser

type SnowGemParser struct {
	*btc.BitcoinParser
	// contains filtered or unexported fields
}

SnowGemParser handle

func NewSnowGemParser

func NewSnowGemParser(params *chaincfg.Params, c *btc.Configuration) *SnowGemParser

NewSnowGemParser returns new SnowGemParser instance

func (*SnowGemParser) PackTx

func (p *SnowGemParser) PackTx(tx *bchain.Tx, height uint32, blockTime int64) ([]byte, error)

PackTx packs transaction to byte array using protobuf

func (*SnowGemParser) UnpackTx

func (p *SnowGemParser) UnpackTx(buf []byte) (*bchain.Tx, uint32, error)

UnpackTx unpacks transaction from protobuf byte array

type SnowGemRPC

type SnowGemRPC struct {
	*btc.BitcoinRPC
}

SnowGemRPC is an interface to JSON-RPC bitcoind service

func (*SnowGemRPC) GetBlock

func (z *SnowGemRPC) GetBlock(hash string, height uint32) (*bchain.Block, error)

GetBlock returns block with given hash.

func (*SnowGemRPC) GetMempoolEntry

func (z *SnowGemRPC) GetMempoolEntry(txid string) (*bchain.MempoolEntry, error)

GetMempoolEntry returns mempool data for given transaction

func (*SnowGemRPC) GetTransactionForMempool

func (z *SnowGemRPC) GetTransactionForMempool(txid string) (*bchain.Tx, error)

GetTransactionForMempool returns a transaction by the transaction ID. It could be optimized for mempool, i.e. without block time and confirmations

func (*SnowGemRPC) Initialize

func (z *SnowGemRPC) Initialize() error

Initialize initializes SnowGemRPC instance