dex

package
Version: v0.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 29, 2022 License: BlueOak-1.0.0 Imports: 14 Imported by: 3

Documentation

Index

Constants

View Source
const (
	LevelTrace    = slog.LevelTrace
	LevelDebug    = slog.LevelDebug
	LevelInfo     = slog.LevelInfo
	LevelWarn     = slog.LevelWarn
	LevelError    = slog.LevelError
	LevelCritical = slog.LevelCritical
	LevelOff      = slog.LevelOff

	DefaultLogLevel = LevelDebug // TODO: back to LevelInfo at some point
)

Level constants.

View Source
const Simnet = Regtest

Simnet is an alias of Regtest.

View Source
const (
	UnsupportedScriptError = ErrorKind("unsupported script type")
)

Variables

This section is empty.

Functions

func BipIDSymbol

func BipIDSymbol(id uint32) string

BipIDSymbol returns the BIP ID for a given symbol.

func BipSymbolID

func BipSymbolID(symbol string) (uint32, bool)

BipSymbolID returns the asset ID associated with a given ticker symbol. While there are a number of duplicate ticker symbols in the BIP ID list (cpc, cmt, xrd, dst, one, ask, ...), those are disambiguated in the bipIDs map here, so must be referenced with their bracketed suffix.

func LockTimeMaker

func LockTimeMaker(network Network) time.Duration

LockTimeMaker returns the maker locktime value that should be used by both client and server for the specified network. Mainnet uses a constant value while test networks support setting a custom value during build.

func LockTimeTaker

func LockTimeTaker(network Network) time.Duration

LockTimeTaker returns the taker locktime value that should be used by both client and server for the specified network. Mainnet uses a constant value while test networks support setting a custom value during build.

func MarketName

func MarketName(base, quote uint32) (string, error)

MarketName creates the string representation of a DEX market (e.g. "dcr_btc") given the base and quote asset indexes defined in BIP-0044. See also BipIDSymbol.

func SemverCompatible

func SemverCompatible(required, actual Semver) bool

SemverCompatible decides if the actual version is compatible with the required one.

Types

type Asset

type Asset struct {
	ID           uint32   `json:"id"`
	Symbol       string   `json:"symbol"`
	Version      uint32   `json:"version"`
	MaxFeeRate   uint64   `json:"maxFeeRate"`
	SwapSize     uint64   `json:"swapSize"`
	SwapSizeBase uint64   `json:"swapSizeBase"`
	SwapConf     uint32   `json:"swapConf"`
	UnitInfo     UnitInfo `json:"unitInfo"`
}

Asset is the configurable asset variables.

type Bytes

type Bytes []byte

Bytes is a byte slice that marshals to and unmarshals from a hexadecimal string. The default go behavior is to marshal []byte to a base-64 string.

func (Bytes) Equal added in v0.2.0

func (b Bytes) Equal(otherB []byte) bool

Equal is true if otherB has identical []byte contents to the Bytes.

func (Bytes) MarshalJSON

func (b Bytes) MarshalJSON() ([]byte, error)

MarshalJSON satisfies the json.Marshaller interface, and will marshal the bytes to a hex string.

func (*Bytes) Scan

func (b *Bytes) Scan(src interface{}) error

Scan implements the sql.Scanner interface.

func (Bytes) String

func (b Bytes) String() string

String return the hex encoding of the Bytes.

func (*Bytes) UnmarshalJSON

func (b *Bytes) UnmarshalJSON(encHex []byte) (err error)

UnmarshalJSON satisfies the json.Unmarshaler interface, and expects a UTF-8 encoding of a hex string in double quotes.

type ConnectionMaster

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

ConnectionMaster manages a Connector.

func NewConnectionMaster

func NewConnectionMaster(c Connector) *ConnectionMaster

NewConnectionMaster is the constructor for a new ConnectionMaster.

func (*ConnectionMaster) Connect

func (c *ConnectionMaster) Connect(ctx context.Context) (err error)

Connect connects the Connector, and returns any initial connection error. Use Disconnect to shut down the Connector.

func (*ConnectionMaster) Disconnect

func (c *ConnectionMaster) Disconnect()

Disconnect closes the connection and waits for shutdown.

func (*ConnectionMaster) On

func (cm *ConnectionMaster) On() bool

On will be true until the context is canceled.

func (*ConnectionMaster) Wait

func (c *ConnectionMaster) Wait()

Wait waits for the the WaitGroup returned by Connect.

type Connector

type Connector interface {
	Connect(ctx context.Context) (*sync.WaitGroup, error)
}

Connector is any type that implements the Connect method, which will return a connection error, and a WaitGroup that can be waited on at Disconnection.

type Denomination added in v0.4.0

type Denomination struct {
	Unit             string `json:"unit"`
	ConversionFactor uint64 `json:"conversionFactor"`
}

Denomination is a unit and its conversion factor.

type Error

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

Error pairs an error with details.

func NewError

func NewError(err error, detail string) Error

NewError wraps the provided Error with details in a Error, facilitating the use of errors.Is and errors.As via errors.Unwrap.

func (Error) Error

func (e Error) Error() string

Error satisfies the error interface, combining the wrapped error message with the details.

func (Error) Unwrap

func (e Error) Unwrap() error

Unwrap returns the wrapped error, allowing errors.Is and errors.As to work.

type ErrorKind

type ErrorKind string

ErrorKind identifies a kind of error that can be used to define new errors via const SomeError = dex.ErrorKind("something").

func (ErrorKind) Error

func (e ErrorKind) Error() string

Error satisfies the error interface and prints human-readable errors.

type IPKey added in v0.2.0

type IPKey [net.IPv6len]byte

IPKey is a IP address byte array.

func NewIPKey added in v0.2.0

func NewIPKey(addr string) IPKey

NewIPKey parses an IP address string into an IPKey. For an IPV6 address, this drops the interface identifier, which is the second half of the address. The first half of the address comprises 48-bits for the prefix, which is the public topology of a network that is assigned by an ISP, and 16-bits for the Site-Level Aggregation Identifier (SLA). However, any number of the SLA bits may be assigned by a provider, potentially giving a single link the freedom to use multiple subnets, thus expanding the set of addresses they may use freely. As such, IPv6 addresses with just the interface bits masked may not be sufficient to identify a single remote uplink.

func (IPKey) IsLoopback added in v0.4.0

func (ipk IPKey) IsLoopback() bool

IsLoopback reports whether the IPKey represents a loopback address.

func (IPKey) IsUnspecified added in v0.4.0

func (ipk IPKey) IsUnspecified() bool

IsUnspecified reports whether the IPKey is zero (unspecified).

func (IPKey) PrefixV6 added in v0.4.0

func (ipk IPKey) PrefixV6() *IPKey

PrefixV6 returns the first 48-bits of an IPv6 address, or nil for an IPv4 address. This may be used to identify multiple remote hosts from the same public topology but different subnets. A heuristic may be defined to treat hosts with the same prefix as the same host if there are many such hosts.

func (IPKey) String added in v0.2.0

func (ipk IPKey) String() string

String returns a readable IP address representation of the IPKey. This is done by copying the bytes of the IPKey array, and invoking the net.(IP).String method. As such it is inefficient and should not be invoked repeatedly or in hot paths.

type Logger

type Logger interface {
	slog.Logger
	SubLogger(name string) Logger
}

Logger is a logger. Many dcrdex types will take a logger as an argument.

var Disabled Logger = &logger{
	Logger:  slog.Disabled,
	level:   LevelOff,
	backend: slog.NewBackend(io.Discard),
}

Disabled is a Logger that will never output anything.

func NewLogger

func NewLogger(name string, lvl slog.Level, writer io.Writer, utc ...bool) Logger

NewLogger creates a new Logger with the given name, log level, and io.Writer.

func StdOutLogger

func StdOutLogger(name string, lvl slog.Level, utc ...bool) Logger

StdOutLogger creates a Logger with the provided name with lvl as the log level and prints to standard out.

type LoggerMaker

type LoggerMaker struct {
	*slog.Backend
	DefaultLevel slog.Level
	Levels       map[string]slog.Level
}

LoggerMaker allows creation of new log subsystems with predefined levels.

func NewLoggerMaker

func NewLoggerMaker(writer io.Writer, debugLevel string, utc ...bool) (*LoggerMaker, error)

NewLoggerMaker creates a new LoggerMaker from the provided io.Writer and debug level string. See SetLevels for details on the debug level string.

func (*LoggerMaker) Level

func (lm *LoggerMaker) Level(name string) slog.Level

Level returns the log level for the named subsystem. If a level is not configured for this subsystem, the LoggerMaker's DefaultLevel is returned.

func (*LoggerMaker) Logger

func (lm *LoggerMaker) Logger(name string) Logger

Logger creates a logger with the provided name, using the log level for that name if it was set, otherwise the default log level. This differs from NewLogger, which does not look in the Level map for the name.

func (*LoggerMaker) NewLogger

func (lm *LoggerMaker) NewLogger(name string, level ...slog.Level) Logger

NewLogger creates a new Logger for the subsystem with the given name. If a log level is specified, it is used for the Logger. Otherwise the DefaultLevel is used.

func (*LoggerMaker) SetLevels

func (lm *LoggerMaker) SetLevels(debugLevel string) error

SetLevels either set the DefaultLevel or resets the Levels map for future subsystems created with the LoggerMaker.

The debugLevel string can specify a single verbosity for the entire system: "trace", "debug", "info", "warn", "error", "critical", "off". The Levels map is not modified with this syntax.

Or the verbosity can be specified for individual subsystems, separating subsystems by commas and assigning each specifically. Such a debugLevel string might look like `CORE=debug,SWAP=trace`. The DefaultLevel is not modified with this syntax.

type MarketInfo

type MarketInfo struct {
	Name                   string
	Base                   uint32
	Quote                  uint32
	LotSize                uint64
	RateStep               uint64
	EpochDuration          uint64 // msec
	MarketBuyBuffer        float64
	MaxUserCancelsPerEpoch uint32
	BookedLotLimit         uint32
}

MarketInfo specifies a market that the Archiver must support.

func NewMarketInfo

func NewMarketInfo(base, quote uint32, lotSize, rateStep, epochDuration uint64, marketBuyBuffer float64) (*MarketInfo, error)

NewMarketInfo creates a new market configuration (MarketInfo) from the given base and quote asset indexes, order lot size, and epoch duration in milliseconds. See also MarketName.

func NewMarketInfoFromSymbols

func NewMarketInfoFromSymbols(base, quote string, lotSize, rateStep, epochDuration uint64, marketBuyBuffer float64) (*MarketInfo, error)

NewMarketInfoFromSymbols is like NewMarketInfo, but the base and quote assets are identified by their symbols as defined in the decred.org/dcrdex/server/asset package.

func (*MarketInfo) String added in v0.2.0

func (mi *MarketInfo) String() string

String returns the market's Name.

type Network

type Network uint8

Network flags passed to asset backends to signify which network to use.

const (
	Mainnet Network = iota
	Testnet
	Regtest
)

func NetFromString

func NetFromString(net string) (Network, error)

NetFromString returns the Network for the given network name.

func (Network) String

func (n Network) String() string

String returns the string representation of a Network.

type Runner

type Runner interface {
	Run(ctx context.Context)
}

Runner is satisfied by DEX subsystems, which must start any of their goroutines via the Run method.

type Semver

type Semver struct {
	Major uint32
	Minor uint32
	Patch uint32
}

Semver models a semantic version major.minor.patch

func NewSemver

func NewSemver(major, minor, patch uint32) Semver

NewSemver returns a new Semver with the version major.minor.patch

func (Semver) String

func (s Semver) String() string

Semver formats the Semver as major.minor.patch (e.g. 1.2.3).

type StartStopWaiter

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

StartStopWaiter wraps a Runner, providing the non-blocking Start and Stop methods, and the blocking WaitForShutdown method.

func NewStartStopWaiter

func NewStartStopWaiter(runner Runner) *StartStopWaiter

NewStartStopWaiter creates a StartStopWaiter from a Runner.

func (*StartStopWaiter) On

func (cm *StartStopWaiter) On() bool

On will be true until the context is canceled.

func (*StartStopWaiter) Start

func (ssw *StartStopWaiter) Start(ctx context.Context)

Start launches the Runner in a goroutine. Start will return immediately. Use Stop to signal the Runner to stop, followed by WaitForShutdown to allow shutdown to complete.

func (*StartStopWaiter) Stop

func (ssw *StartStopWaiter) Stop()

Stop cancels the context.

func (*StartStopWaiter) WaitForShutdown

func (ssw *StartStopWaiter) WaitForShutdown()

WaitForShutdown blocks until the Runner has returned in response to Stop.

type UnitInfo added in v0.4.0

type UnitInfo struct {
	// AtomicUnit is the name associated with the asset's integral unit of
	// measure, e.g. satoshis, atoms, gwei (for DEX purposes).
	AtomicUnit string `json:"atomicUnit"`
	// Conventional is the conventionally-used denomination.
	Conventional Denomination `json:"conventional"`
	// Alternatives lists additionally available Denominations, and can be
	// empty.
	Alternatives []Denomination `json:"denominations"`
}

UnitInfo conveys information about the units and available denominations for an asset.

func (*UnitInfo) ConventionalString added in v0.4.0

func (ui *UnitInfo) ConventionalString(v uint64) string

ConventionalString converts the quantity to conventional units, and returns the formatted float string.

Directories

Path Synopsis
networks
bch
btc
dcr
eth
ltc
Package order defines the Order and Match types used throughout the DEX.
Package order defines the Order and Match types used throughout the DEX.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL