Crate nintondo_dogecoin

Rust Dogecoin Library

This is a library that supports the Dogecoin network protocol and associated primitives. It is designed for Rust programs built to work with the Dogecoin network.

It is also written entirely in Rust to illustrate the benefits of strong type safety, including ownership and lifetime, for financial and/or cryptographic software.

See README.md for detailed documentation about development and supported environments.

Available feature flags

• std - the usual dependency on std (default).
• secp-recovery - enables calculating public key from a signature and message.
• base64 - (dependency), enables encoding of PSBTs and message signatures.
• rand - (dependency), makes it more convenient to generate random values.
• serde - (dependency), implements serde-based serialization and deserialization.
• secp-lowmemory - optimizations for low-memory devices.
• no-std - enables additional features required for this crate to be usable without std. Does not disable std. Depends on core2.
• bitcoinconsensus-std - enables std in bitcoinconsensus and communicates it to this crate so it knows how to implement std::error::Error. At this time there’s a hack to achieve the same without this feature but it could happen the implementations diverge one day.

Re-exports

pub extern crate base64;

pub extern crate bech32;

pub extern crate bitcoinconsensus;

pub extern crate bitcoin_hashes as hashes;

pub extern crate hex;

pub extern crate secp256k1;

pub use crate::address::Address;

pub use crate::address::AddressType;

pub use crate::amount::Amount;

pub use crate::amount::Denomination;

pub use crate::amount::SignedAmount;

pub use crate::blockdata::block;

pub use crate::blockdata::block::Block;

pub use crate::blockdata::fee_rate::FeeRate;

pub use crate::blockdata::locktime;

pub use crate::blockdata::locktime::absolute;

pub use crate::blockdata::locktime::relative;

pub use crate::blockdata::script;

pub use crate::blockdata::script::Script;

pub use crate::blockdata::script::ScriptBuf;

pub use crate::blockdata::transaction;

pub use crate::blockdata::transaction::OutPoint;

pub use crate::blockdata::transaction::Sequence;

pub use crate::blockdata::transaction::Transaction;

pub use crate::blockdata::transaction::TxIn;

pub use crate::blockdata::transaction::TxOut;

pub use crate::blockdata::weight::Weight;

pub use crate::blockdata::witness;

pub use crate::blockdata::witness::Witness;

pub use crate::blockdata::constants;

pub use crate::blockdata::opcodes;

pub use crate::consensus::encode::VarInt;

pub use crate::error::Error;

pub use crate::hash_types::BlockHash;

pub use crate::hash_types::PubkeyHash;

pub use crate::hash_types::ScriptHash;

pub use crate::hash_types::Txid;

pub use crate::hash_types::WPubkeyHash;

pub use crate::hash_types::WScriptHash;

pub use crate::hash_types::Wtxid;

pub use crate::merkle_tree::MerkleBlock;

pub use crate::network::constants::Network;

pub use crate::pow::CompactTarget;

pub use crate::pow::Target;

pub use crate::pow::Work;

Modules

address

Dogecoin addresses.

amount

Dogecoin amounts.

base58

Base58 encoder and decoder.

bip32

BIP32 implementation.

bip152

BIP152 Compact Blocks

bip158

BIP 158 Compact Block Filters for Light Clients.

blockdata

Dogecoin block data.

consensus

Dogecoin consensus.

ecdsa

ECDSA Dogecoin signatures.

error

Contains error types and other error handling tools.

hash_types

Dogecoin hash types.

key

Dogecoin keys.

merkle_tree

Dogecoin merkle tree functions.

network

Dogecoin network support.

policy

Dogecoin policy.

pow

Proof-of-work related integer types.

psbt

Partially Signed Dogecoin Transactions.

sighash

Signature hash implementation (used in transaction signing).

sign_message

Signature

string

Dogecoin string parsing utilities.

taproot

Dogecoin Taproot.

util

Utility functions.

Structs

PrivateKey

A Dogecoin ECDSA private key

PublicKey

A Dogecoin ECDSA public key