bch

Documentation

Index

• Constants
• Variables
• func NewWallet(cfg *asset.WalletConfig, logger dex.Logger, network dex.Network) (asset.Wallet, error)
• func WithdrawSPVFunds(ctx context.Context, walletPW []byte, recipient, dataDir string, ...) ([]byte, error)
• type Driver
  • func (d *Driver) Create(params *asset.CreateWalletParams) error
  • func (d *Driver) DecodeCoinID(coinID []byte) (string, error)
  • func (d *Driver) Exists(walletType, dataDir string, settings map[string]string, net dex.Network) (bool, error)
  • func (d *Driver) Info() *asset.WalletInfo
  • func (d *Driver) MinLotSize(maxFeeRate uint64) uint64
  • func (d *Driver) Open(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
)

const (
	DefaultM uint64 = 784931 // From bchutil. Used for gcs filters.

)

Variables

var (

	// WalletInfo defines some general information about a Bitcoin Cash wallet.
	WalletInfo = &asset.WalletInfo{
		Name:              "Bitcoin Cash",
		SupportedVersions: []uint32{version},

		UnitInfo: dexbch.UnitInfo,
		AvailableWallets: []*asset.WalletDefinition{

			rpcWalletDefinition,
		},
	}
)

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.

func WithdrawSPVFunds

func WithdrawSPVFunds(ctx context.Context, walletPW []byte, recipient, dataDir string, net dex.Network, log dex.Logger) ([]byte, error)

WithdrawSPVFunds is a function to generate a tx that spends all funds from a deprecated SPV wallet.

Types

type Driver

type Driver struct{}

Driver implements asset.Driver.

func (*Driver) Create

func (d *Driver) Create(params *asset.CreateWalletParams) error

Create creates a new SPV wallet.

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) Exists

func (d *Driver) Exists(walletType, dataDir string, settings map[string]string, net dex.Network) (bool, error)

Exists checks the existence of the wallet. Part of the Creator interface, so only used for wallets with WalletDefinition.Seeded = true.

func (*Driver) Info

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

Info returns basic information about the wallet and asset.

func (*Driver) MinLotSize

func (d *Driver) MinLotSize(maxFeeRate uint64) uint64

MinLotSize calculates the minimum bond size for a given fee rate that avoids dust outputs on the swap and refund txs, assuming the maxFeeRate doesn't change.

func (*Driver) Open

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

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