bitcoin

Documentation

Index

• Constants
• func HmacSha256(password string) (salt, hash string)
• func NewClient(node *bitcoinv1alpha1.Node, client client.Client) clients.Interface
• type BitcoinCoreClient
  • func (c *BitcoinCoreClient) Args() (args []string)
  • func (c *BitcoinCoreClient) Command() (command []string)
  • func (c *BitcoinCoreClient) Env() (env []corev1.EnvVar)
  • func (c *BitcoinCoreClient) HomeDir() string

Constants

const (
	// BitcoinArgChain is argument used to set chain
	BitcoinArgChain = "-chain"
	// BitcoinArgListen is argument used to accept connections from outside
	BitcoinArgListen = "-listen"
	// BitcoinArgBind is argument used to bind and listen to the given address
	BitcoinArgBind = "-bind"
	// BitcoinArgServer is argument used to enable CLI and JSON-RPC server
	BitcoinArgServer = "-server"
	// BitcoinArgRPCPort is argument used to set JSON-RPC port
	BitcoinArgRPCPort = "-rpcport"
	// BitcoinArgDataDir is argument used to set data directory
	BitcoinArgDataDir = "-datadir"
	// BitcoinArgRPCBind is argument used to set JSON-RPC server host
	BitcoinArgRPCBind = "-rpcbind"
	// BitcoinArgRPCAllowIp is argument used to allow JSON-RPC connections from specific sources
	BitcoinArgRPCAllowIp = "-rpcallowip"
	// BitcoinArgRPCAuth is argument used to set JSON-RPC user and password in the format of user:salt$hash
	BitcoinArgRPCAuth = "-rpcauth"
	// BitcoinArgDisableWallet is argument used to disable wallet and RPC calls
	BitcoinArgDisableWallet = "-disablewallet"
	// BitcoinArgReIndex is argument used to rebuild chain state and block index
	BitcoinArgReIndex = "-reindex"
	// BitcoinArgTransactionIndex is argument used to maintain a full transaction index
	BitcoinArgTransactionIndex = "-txindex"
	// BitcoinArgCoinStatsIndex is argument used to maintain coinstats index
	BitcoinArgCoinStatsIndex = "-coinstatsindex"
	// BitcoinArgBlocksOnly is argument used to reject transactions from network peers
	BitcoinArgBlocksOnly = "-blocksonly"
	// BitcoinArgPrune is argument used to allows pruneblockchain RPC to be called to delete specific blocks
	BitcoinArgPrune = "-prune"
	// BitcoinArgRpcWhitelist is argument used to set default rpc whitelist
	BitcoinArgRpcWhitelist = "-rpcwhitelist"
	// BitcoinArgDBCacheSize is argument used to set maximum database cache size
	BitcoinArgDBCacheSize = "-dbcache"
	// BitcoinArgMaxConnections is argument used to set maximum connections to peers
	BitcoinArgMaxConnections = "-maxconnections"
)

const (
	// BitcoinCoreHomeDir is Bitcoin core image home dir
	BitcoinCoreHomeDir = "/data"
)

Images

const (
	// EnvBitcoinData is environment variable used to set data directory
	EnvBitcoinData = "BITCOIN_DATA"
)

Functions

func HmacSha256

func HmacSha256(password string) (salt, hash string)

HmacSha256 creates new hmac sha256 hash reference implementation: https://github.com/bitcoin/bitcoin/blob/master/share/rpcauth/rpcauth.py

func NewClient

func NewClient(node *bitcoinv1alpha1.Node, client client.Client) clients.Interface

Types

type BitcoinCoreClient

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

BitcoinCoreClient is Bitcoin core client https://github.com/bitcoin/bitcoin

func (*BitcoinCoreClient) Args

func (c *BitcoinCoreClient) Args() (args []string)

Args returns Bitcoin core client args

func (*BitcoinCoreClient) Command

func (c *BitcoinCoreClient) Command() (command []string)

Command is Bitcoin core client entrypoint

func (*BitcoinCoreClient) Env

func (c *BitcoinCoreClient) Env() (env []corev1.EnvVar)

Command returns environment variables for the client

func (*BitcoinCoreClient) HomeDir

func (c *BitcoinCoreClient) HomeDir() string

HomeDir is the home directory of Bitcoin core client image