dcr

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Aug 29, 2024 License: BlueOak-1.0.0 Imports: 37 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	BipID = 42

	BondVersion = 0
)
View Source 
const ErrReorgDetected = dex.ErrorKind("reorg detected")

Variables

This section is empty.

Functions

func ParseBondTx added in v0.6.0 

func ParseBondTx(ver uint16, rawTx []byte) (bondCoinID []byte, amt int64, bondAddr string,
	bondPubKeyHash []byte, lockTime int64, acct account.AccountID, err error)

ParseBondTx performs basic validation of a serialized time-locked fidelity bond transaction given the bond's P2SH redeem script.

The transaction must have at least two outputs: out 0 pays to a P2SH address (the bond), and out 1 is a nulldata output that commits to an account ID. There may also be a change output.

Returned: The bond's coin ID (i.e. encoded UTXO) of the bond output. The bond output's amount and P2SH address. The lockTime and pubkey hash data pushes from the script. The account ID from the second output is also returned.

Properly formed transactions:

  1. The bond output (vout 0) must be a P2SH output.
  2. The bond's redeem script must be of the form: <lockTime[4]> OP_CHECKLOCKTIMEVERIFY OP_DROP OP_DUP OP_HASH160 <pubkeyhash[20]> OP_EQUALVERIFY OP_CHECKSIG
  3. The null data output (vout 1) must have a 58-byte data push (ver | account ID | lockTime | pubkeyHash).
  4. The transaction must have a zero locktime and expiry.
  5. All inputs must have the max sequence num set (finalized).
  6. The transaction must pass the checks in the blockchain.CheckTransactionSanity function.

For DCR, and possibly all assets, the bond script is reconstructed from the null data output, and it is verified that the bond output pays to this script.

func ValidateXPub added in v0.6.0 

func ValidateXPub(xpub string) error

ValidateXPub validates the base-58 encoded extended key, and ensures that it is an extended public, not private, key.

Types

type Backend 

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

Backend is an asset backend for Decred. It has methods for fetching output information and subscribing to block updates. It maintains a cache of block data for quick lookups. Backend implements asset.Backend, so provides exported methods for DEX-related blockchain info.

func NewBackend 

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

NewBackend is the exported constructor by which the DEX will import the Backend. If configPath is an empty string, the backend will attempt to read the settings directly from the dcrd config file in its default system location.

func (*Backend) BlockChannel 

func (dcr *Backend) BlockChannel(size int) <-chan *asset.BlockUpdate

BlockChannel creates and returns a new channel on which to receive block updates. If the returned channel is ever blocking, there will be no error logged from the dcr package. Part of the asset.Backend interface.

func (*Backend) BondCoin added in v0.6.0 

func (dcr *Backend) BondCoin(ctx context.Context, ver uint16, coinID []byte) (amt, lockTime, confs int64, acct account.AccountID, err error)

BondCoin locates a bond transaction output, validates the entire transaction, and returns the amount, encoded lockTime and account ID, and the confirmations of the transaction. It is a CoinNotFoundError if the transaction output is spent.

func (*Backend) BondVer added in v0.6.0 

func (dcr *Backend) BondVer() uint16

BondVer returns the latest supported bond version.

func (*Backend) CheckSwapAddress added in v0.6.0 

func (dcr *Backend) CheckSwapAddress(addr string) bool

CheckSwapAddress checks that the given address is parseable and of the required type for a swap contract script (p2pkh).

func (*Backend) Connect added in v0.2.0 

func (dcr *Backend) Connect(ctx context.Context) (_ *sync.WaitGroup, err error)

Connect connects to the node RPC server. A dex.Connector.

func (*Backend) Contract 

func (dcr *Backend) Contract(coinID []byte, redeemScript []byte) (*asset.Contract, error)

Contract is part of the asset.Backend interface. An asset.Contract is an output that has been validated as a swap contract for the passed redeem script. A spendable output is one that can be spent in the next block. Every regular-tree output from a non-coinbase transaction is spendable immediately. Coinbase and stake tree outputs are only spendable after CoinbaseMaturity confirmations. Pubkey scripts can be P2PKH or P2SH in either regular- or stake-tree flavor. P2PKH supports two alternative signatures, Schnorr and Edwards. Multi-sig P2SH redeem scripts are supported as well.

func (*Backend) FeeCoin 

func (dcr *Backend) FeeCoin(coinID []byte) (addr string, val uint64, confs int64, err error)

FeeCoin gets the recipient address, value, and confirmations of a transaction output encoded by the given coinID. A non-nil error is returned if the output's pubkey script is not a non-stake P2PKH requiring a single ECDSA-secp256k1 signature.

func (*Backend) FeeRate 

func (dcr *Backend) FeeRate(ctx context.Context) (uint64, error)

FeeRate returns the current optimal fee rate in atoms / byte.

func (*Backend) FundingCoin 

func (dcr *Backend) FundingCoin(ctx context.Context, coinID []byte, redeemScript []byte) (asset.FundingCoin, error)

FundingCoin is an unspent output.

func (*Backend) Info added in v0.5.0 

func (*Backend) Info() *asset.BackendInfo

Info provides some general information about the backend.

func (*Backend) ParseBondTx added in v0.6.0 

func (*Backend) ParseBondTx(ver uint16, rawTx []byte) (bondCoinID []byte, amt int64, bondAddr string,
	bondPubKeyHash []byte, lockTime int64, acct account.AccountID, err error)

ParseBondTx makes the package-level ParseBondTx pure function accessible via a Backend instance. This performs basic validation of a serialized time-locked fidelity bond transaction given the bond's P2SH redeem script.

func (*Backend) Redemption 

func (dcr *Backend) Redemption(redemptionID, contractID, _ []byte) (asset.Coin, error)

Redemption is an input that redeems a swap contract.

func (*Backend) SendRawTransaction added in v0.6.0 

func (dcr *Backend) SendRawTransaction(rawtx []byte) (coinID []byte, err error)

SendRawTransaction broadcasts a raw transaction, returning a coin ID.

func (*Backend) Synced 

func (dcr *Backend) Synced() (bool, error)

Synced is true if the blockchain is ready for action.

func (*Backend) TxData added in v0.2.0 

func (dcr *Backend) TxData(coinID []byte) ([]byte, error)

TxData is the raw transaction bytes. SPV clients rebroadcast the transaction bytes to get around not having a mempool to check.

func (*Backend) ValidateCoinID 

func (dcr *Backend) ValidateCoinID(coinID []byte) (string, error)

ValidateCoinID attempts to decode the coinID.

func (*Backend) ValidateContract 

func (dcr *Backend) ValidateContract(contract []byte) error

ValidateContract ensures that the swap contract is constructed properly, and contains valid sender and receiver addresses.

func (*Backend) ValidateFeeRate added in v0.5.0 

func (dcr *Backend) ValidateFeeRate(c asset.Coin, reqFeeRate uint64) bool

ValidateFeeRate checks that the transaction fees used to initiate the contract are sufficient.

func (*Backend) ValidateOrderFunding added in v1.0.0 

func (*Backend) ValidateOrderFunding(swapVal, valSum, _, inputsSize, maxSwaps uint64, nfo *dex.Asset) bool

func (*Backend) ValidateSecret 

func (dcr *Backend) ValidateSecret(secret, contract []byte) bool

ValidateSecret checks that the secret satisfies the contract.

func (*Backend) VerifyUnspentCoin 

func (dcr *Backend) VerifyUnspentCoin(ctx context.Context, coinID []byte) error

VerifyUnspentCoin attempts to verify a coin ID by decoding the coin ID and retrieving the corresponding UTXO. If the coin is not found or no longer unspent, an asset.CoinNotFoundError is returned.

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

func (*Driver) MinBondSize added in v1.0.0 

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 added in v1.0.0 

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 added in v1.0.0 

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 DCR backend. Start the backend with its Run method.

func (*Driver) UnitInfo added in v0.4.0 

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

UnitInfo returns the dex.UnitInfo for the asset.

func (*Driver) Version added in v0.2.0 

func (d *Driver) Version() uint32

Version returns the Backend implementation's version number.

type Input 

type Input struct {
	TXIO
	// contains filtered or unexported fields
}

Input is a transaction input.

func (*Input) Confirmations 

func (input *Input) Confirmations(ctx context.Context) (int64, error)

Confirmations returns the number of confirmations on this input's transaction.

func (*Input) ID 

func (input *Input) ID() []byte

ID returns the coin ID.

func (*Input) String 

func (input *Input) String() string

String creates a human-readable representation of a Decred transaction input in the format "{txid = [transaction hash], vin = [input index]}".

func (*Input) Value 

func (input *Input) Value() uint64

Value is the value of the previous output spent by the input.

type Output 

type Output struct {
	TXIO
	// contains filtered or unexported fields
}

Output represents a transaction output.

func (*Output) Addresses 

func (output *Output) Addresses() []string

func (*Output) Auth 

func (output *Output) Auth(pubkeys, sigs [][]byte, msg []byte) error

Auth verifies that the output pays to the supplied public key(s). This is an asset.FundingCoin method.

func (*Output) Confirmations 

func (output *Output) Confirmations(ctx context.Context) (int64, error)

Confirmations returns the number of confirmations for a transaction output. Because it is possible for an output that was once considered valid to later be considered invalid, this method can return an error to indicate the output is no longer valid. The definition of output validity should not be confused with the validity of regular tree transactions that is voted on by stakeholders. While stakeholder approval is a part of output validity, there are other considerations as well.

func (*Output) ID 

func (output *Output) ID() []byte

ID returns the coin ID.

func (*Output) SpendSize 

func (output *Output) SpendSize() uint32

SpendSize returns the maximum size of the serialized TxIn that spends this Output, in bytes.

func (*Output) String 

func (output *Output) String() string

String creates a human-readable representation of a Decred transaction output in the format "{txid = [transaction hash], vout = [output index]}".

func (*Output) Value 

func (output *Output) Value() uint64

Value is the output value, in atoms.

type TXIO 

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

TXIO is common information stored with an Input or Output.

func (*TXIO) FeeRate 

func (txio *TXIO) FeeRate() uint64

FeeRate returns the transaction fee rate, in atoms/byte.

func (*TXIO) TxID 

func (txio *TXIO) TxID() string

TxID is a string identifier for the transaction, typically a hexadecimal representation of the byte-reversed transaction hash.

type Tx 

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

Tx is information about a transaction. It must satisfy the asset.DEXTx interface to be DEX-compatible.

type UTXO 

type UTXO struct {
	*Output
}

A UTXO is information regarding an unspent transaction output.

func (*UTXO) Coin added in v1.0.0 

func (utxo *UTXO) Coin() asset.Coin

func (*UTXO) Confirmations 

func (utxo *UTXO) Confirmations(ctx context.Context) (int64, error)

Confirmations returns the number of confirmations on this output's transaction. See also (*Output).Confirmations. This function differs from the Output method in that it is necessary to relocate the utxo after a reorg, it may error if the output is spent.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.