firo

Documentation

Index

• Constants
• Variables
• func NewWallet(cfg *asset.WalletConfig, logger dex.Logger, network dex.Network) (asset.Wallet, error)
• type Driver
  • func (d *Driver) DecodeCoinID(coinID []byte) (string, 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 (

	// Zcoin XZC
	BipID = 136
)

Variables

var (

	// WalletInfo defines some general information about a Firo wallet.
	WalletInfo = &asset.WalletInfo{
		Name:              "Firo",
		Version:           version,
		SupportedVersions: []uint32{version},
		UnitInfo:          dexfiro.UnitInfo,
		AvailableWallets: []*asset.WalletDefinition{
			{
				Type:              walletTypeRPC,
				Tab:               "Firo Core (external)",
				Description:       "Connect to firod",
				DefaultConfigPath: dexbtc.SystemConfigPath("firo"),
				ConfigOpts:        configOpts,
			},
			{
				Type:        walletTypeElectrum,
				Tab:         "Electrum-Firo (external)",
				Description: "Use an external Electrum-Firo Wallet",
				ConfigOpts:  append(btc.ElectrumConfigOpts, btc.CommonConfigOpts("FIRO", true)...),
			},
		},
	}
)

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 firod config file is assumed.

Types

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 Firo.

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 FIRO exchange wallet. Start the wallet with its Run method.