Skip to main content

tbc_sdk/
lib.rs

1pub mod address;
2pub mod api;
3pub mod builder;
4pub mod contracts;
5pub mod encoding;
6pub mod error;
7pub mod hash;
8pub mod hd;
9pub mod keys;
10pub mod script;
11pub mod sighash;
12pub mod signing;
13pub mod transaction;
14pub mod validator;
15
16pub use address::Address;
17pub use api::{ApiClient, FtlpUtxo, PoolNftInfo, UtxoInfo};
18pub use builder::{TransactionBuilder, Utxo};
19pub use contracts::ft::{BatchFtTx, Ft, FtInfo, FtReceiver, FtUtxo, MintFtTx};
20pub use contracts::multisig::{
21    MultiSig, MultiSigAddressInfo, MultiSigDestination, MultiSigInputSignatures,
22    MultiSigUnsignedTx, MultiSigUtxo,
23};
24pub use contracts::nft::{BatchNftTx, CollectionData, Nft, NftData, NftInfo, NftUtxo};
25pub use contracts::orderbook::{
26    BuyOrderParams, CancelBuyOrderParams, MatchOrderParams, OrderBook, OrderData, OrderUtxo,
27    SellOrderParams,
28};
29pub use contracts::pool_nft_v2::{
30    FTLP_CODE_SATOSHIS, FTLP_TAPE_SATOSHIS, FtScriptVersion, FtSpendContext, FtlpCodeParams,
31    FtlpLockTimeEntry, FtlpSpendContext, FtlpTapeLayout, FtlpTapeParams, LockedLpCost,
32    LockedPoolCodeParams, POOL_CODE_DUST_SAT, POOL_CODE_SATOSHIS, POOL_TAPE_SATOSHIS, PoolAmounts,
33    PoolCodeParams, PoolDifference, PoolFtAuthority, PoolInitContext, PoolNftV2,
34    PoolOperationContext, PoolSpendContext, PoolState, PoolUpdate, consume_lp, format_decimal_raw,
35    ftlp_code, ftlp_lock_time_code, ftlp_tape, increase_lp, initial_lp_raw, locked_pool_code,
36    parse_decimal_raw, pool_code, pool_held_ft_code, pool_tape, swap_ft_to_tbc, swap_tbc_to_ft,
37};
38pub use contracts::stable_coin::{
39    AdminSighash, CoinNftData, FinalizedStableCoinCreate, StableCoin, StableCoinCreate,
40    StableCoinMint,
41};
42pub use contracts::tbc20::{
43    TBC20_AMOUNT_SLOTS, TBC20_ARTIFACT_SHA256, TBC20_CODE_BYTES, TBC20_CODE_PARTIAL_OFFSET,
44    TBC20_CODE_SATOSHIS, TBC20_MAX_INPUTS, TBC20_MAX_OUTPUT_GROUPS, TBC20_MAX_OUTPUTS,
45    TBC20_MAX_SLOT_AMOUNT, TBC20_MAX_TAPE_BYTES, TBC20_MIN_TAPE_BYTES, TBC20_TAPE_SATOSHIS, Tbc20,
46    Tbc20AncestorResolver, Tbc20BuildResult, Tbc20Config, Tbc20ContractControllerWitness,
47    Tbc20Definition, Tbc20MintResult, Tbc20Outpoint, Tbc20OutputGroup, Tbc20ParsedTape, Tbc20Spend,
48    Tbc20TokenOutput, Tbc20UnlockOptions, Tbc20Utxo, build_tbc20_metadata_extension,
49    build_tbc20_tape, build_tbc20_unlock_script, build_tbc20_unlock_script_with_signature,
50    build_tbc20_utxo, encode_tbc20_original_utxo, instantiate_tbc20_code,
51    is_tbc20_artifact_candidate, parse_tbc20_tape, replace_tbc20_controller,
52    replace_tbc20_tape_amounts, tbc20_address_controller, tbc20_code_identity,
53    tbc20_contract_controller, tbc20_controller, tbc20_human_to_raw, tbc20_raw_to_human,
54    validate_tbc20_code,
55};
56pub use error::{Error, Result};
57pub use hd::{HdNetwork, HdPrivateKey, HdPublicKey, Mnemonic, TBC_DERIVATION_PATH};
58pub use keys::{PrivateKey, PublicKey};
59pub use transaction::{OutPoint, Transaction, TxIn, TxOut, Txid};
60pub use validator::{
61    InMemoryTokenTransactionFetcher, TokenAncestorEdge, TokenAssetEvidence, TokenInputEvidence,
62    TokenOutputGroup, TokenProtocolDescriptor, TokenTransactionFetcher, TokenValidationIssue,
63    TokenValidationOptions, TokenValidationPolicy, TokenValidationResult, TokenValidationSource,
64    assert_valid_on_chain_transaction, validate_on_chain_transaction,
65    validate_on_chain_transaction_with_fetcher,
66};
67
68pub const COIN: u64 = 1_000_000;
69pub const TX_VERSION: i32 = 10;
70pub const ADDRESS_P2PKH_PREFIX: u8 = 0x00;
71pub const WIF_PREFIX: u8 = 0x80;
72pub const DEFAULT_SEQUENCE: u32 = 0xffff_ffff;
73pub const DEFAULT_LOCK_TIME: u32 = 0;
74pub const DEFAULT_FEE_RATE_SAT_PER_KB: u64 = 80;
75pub const SDK_DUST_SAT: u64 = 24;
76pub const SIGHASH_ALL: u32 = 0x01;
77pub const SIGHASH_FORKID: u32 = 0x40;
78pub const DEFAULT_SIGHASH: u32 = SIGHASH_ALL | SIGHASH_FORKID;
79
80/// Modern-generation Standard contracts; legacy `Tbc20` remains available.
81pub use contracts::tbc20_standard::*;
82pub use contracts::tbc721_standard::Tbc721Standard;
83
84/// Published JavaScript contract package used for the modern-generation parity fixtures.
85pub const JS_REFERENCE_VERSION: &str = "1.7.4";