bch

Documentation

Index

• Constants
• Variables
• func NewWallet(cfg *asset.WalletConfig, logger dex.Logger, network dex.Network) (asset.Wallet, error)
• type BCHWallet
  • func (bch *BCHWallet) Address() (string, error)
  • func (bch *BCHWallet) AuditContract(coinID, contract, txData dex.Bytes) (*asset.AuditInfo, error)
• type Driver
  • func (d *Driver) DecodeCoinID(coinID []byte) (string, error)
  • func (d *Driver) Info() *asset.WalletInfo
  • func (d *Driver) Setup(cfg *asset.WalletConfig, logger dex.Logger, network dex.Network) (asset.Wallet, error)

Constants

const (

	// BipID is the Bip 44 coin ID for Bitcoin Cash.
	BipID = 145
)

Variables

var (

	// WalletInfo defines some general information about a Bitcoin Cash wallet.
	WalletInfo = &asset.WalletInfo{
		Name:    "Bitcoin Cash",
		Units:   "Satoshi",
		Version: version,

		DefaultConfigPath: dexbtc.SystemConfigPath("bitcoin"),
		ConfigOpts:        configOpts,
	}
)

Functions

func NewWallet

func NewWallet(cfg *asset.WalletConfig, logger dex.Logger, network dex.Network) (asset.Wallet, error)

NewWallet is the exported constructor by which the DEX will import the exchange wallet. The wallet will shut down when the provided context is canceled. The configPath can be an empty string, in which case the standard system location of the daemon config file is assumed.

Types

type BCHWallet

type BCHWallet struct {
	*btc.ExchangeWallet
}

BCHWallet embeds btc.ExchangeWallet, but re-implements a couple of methods to perform on-the-fly address translation.

func (*BCHWallet) Address

func (bch *BCHWallet) Address() (string, error)

Address converts the Bitcoin base58-encoded address returned by the embedded ExchangeWallet into a Cash Address.

func (*BCHWallet) AuditContract

func (bch *BCHWallet) AuditContract(coinID, contract, txData dex.Bytes) (*asset.AuditInfo, error)

AuditContract modifies the *asset.Contract returned by the ExchangeWallet AuditContract method by converting the Recipient to the Cash Address encoding.

type Driver

type Driver struct{}

Driver implements asset.Driver.

func (*Driver) DecodeCoinID

func (d *Driver) DecodeCoinID(coinID []byte) (string, error)

DecodeCoinID creates a human-readable representation of a coin ID for Bitcoin Cash.

func (*Driver) Info

func (d *Driver) Info() *asset.WalletInfo

Info returns basic information about the wallet and asset.

func (*Driver) Setup

func (d *Driver) Setup(cfg *asset.WalletConfig, logger dex.Logger, network dex.Network) (asset.Wallet, error)

Setup creates the BCH exchange wallet. Start the wallet with its Run method.