bch

Documentation

Index

• Constants
• func NewBackend(cfg *asset.BackendConfig) (asset.Backend, error)
• type BCHBackend
  • func (bch *BCHBackend) Contract(coinID []byte, redeemScript []byte) (*asset.Contract, error)
• type Driver
  • func (d *Driver) DecodeCoinID(coinID []byte) (string, error)
  • func (d *Driver) MinBondSize(maxFeeRate uint64) uint64
  • func (d *Driver) MinLotSize(maxFeeRate uint64) uint64
  • func (d *Driver) Name() string
  • func (d *Driver) Setup(cfg *asset.BackendConfig) (asset.Backend, error)
  • func (d *Driver) UnitInfo() dex.UnitInfo
  • func (d *Driver) Version() uint32

Constants

const (
	BipID = 145
)

Functions

func NewBackend

func NewBackend(cfg *asset.BackendConfig) (asset.Backend, error)

NewBackend generates the network parameters and creates a bch backend as a btc clone using an asset/btc helper function.

Types

type BCHBackend

type BCHBackend struct {
	*btc.Backend
}

BCHBackend embeds *btc.Backend and re-implements the Contract method to deal with Cash Address translation.

func (*BCHBackend) Contract

func (bch *BCHBackend) Contract(coinID []byte, redeemScript []byte) (*asset.Contract, error)

Contract returns the output from embedded Backend's Contract method, but with the SwapAddress field converted to 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) MinBondSize

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

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

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

func (d *Driver) Name() string

Name is the asset's name.

func (*Driver) Setup

func (d *Driver) Setup(cfg *asset.BackendConfig) (asset.Backend, error)

Setup creates the BCH backend. Start the backend with its Run method.

func (*Driver) UnitInfo

func (d *Driver) UnitInfo() dex.UnitInfo

UnitInfo returns the dex.UnitInfo for the asset.

func (*Driver) Version

func (d *Driver) Version() uint32

Version returns the Backend implementation's version number.