decdn-incentive 0.0.1

Payment channels, bonding, and voucher management for deCDN
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Incentive layer for deCDN.
//!
//! Manages off-chain USDC payment pools, bonding interactions via
//! `CapacityBond`, and voucher lifecycle (creation, validation, on-chain
//! settlement).
//!
//! Exposes the off-chain payment-voucher primitives — EIP-712
//! signing/verification ([`voucher`]) — required for `cdn/client/v1`, the
//! keystore→signer bridge ([`eth_identity`], #406) used by both
//! `decdn key-gen` and the runtime to load a `PrivateKeySigner`, and the
//! `alloy::sol!` contract bindings for the on-chain surface the node consumes
//! ([`capacity_bond`] reads, [`payment_pool`] reads + writes, [`erc20`]
//! approve). A `PaymentPool` fans one owner's deposit out across many capped
//! signers and many nodes: the owner opens a pool with `openPool`, authorizes
//! each signer off-chain with a [`capability::Capability`], and a signer's
//! per-`(pool, provider)` voucher lane accrues cumulative amount/bytes as
//! `redeem`/`redeemMany` pays it down. The seller-side on-chain settlement
//! path (`PoolOpened`/`Redeemed` → persist per-lane watermark in
//! [`lane::LaneState`], `PoolCloseInitiated` → grace-window monitor,
//! `PoolReclaimed` → forget) is fully driven by the `decdn-node` runtime. So
//! is the buyer-side cache-miss path (one-time USDC approve,
//! `openPool`/`topUp`, `closePool` + `reclaim` on abandonment; bookkeeping in
//! [`buyer_pool`]): the runtime bootstraps the approval and the reclaim
//! sweep, and its node-to-node pull-through origin drives pool open/reuse
//! and voucher signing on a miss.

pub mod bind_sig;
pub mod buyer_pool;
pub mod credit;
pub mod deployment;
// NOTE: no outer `///` docs on these two — each module's `//!` header is its
// documentation. An outer doc here would be a second copy free to drift, and
// rustdoc merges it with the `//!` block and resolves the result in *this*
// module's scope, silently breaking the module's own intra-doc links.
#[cfg(feature = "redb")]
pub mod buyer_pool_redb;
#[cfg(feature = "buyer-store-core")]
pub mod buyer_pool_table;
pub mod capability;
pub mod capability_grant;
pub mod capacity_bond;
pub mod chain;
pub mod client_bridge;
pub mod content_blacklist;
pub mod erc20;
pub mod eth_identity;
pub mod lane;
pub mod node_register;
pub mod origin_assignment;
pub mod payment_pool;
pub mod pool_open_error;
pub mod probe_sig;
pub mod publisher_registry;
pub mod rate;
pub mod sig_canon;
pub mod slash_appeal;
pub mod slash_judge;
pub mod store;
pub mod stream_sig;
pub mod tx;
pub mod voucher;

pub use bind_sig::{
    BindError, CAPACITY_BOND_DOMAIN_NAME, CAPACITY_BOND_DOMAIN_VERSION, EPHEMERAL_BINDING_NONCE,
    bind_node_id_domain, binding_signing_hash, register_node_signing_hash, verify_binding,
};
pub use buyer_pool::{
    AdvanceOutcome, BuyerLaneProgress, BuyerLoad, BuyerPoolState, BuyerPoolStore,
    BuyerProgressError, DepositOutcome, MemoryBuyerPoolStore,
};
pub use capability::{Capability, CapabilityError, SignedCapability};
pub use capability_grant::{CapabilityGrant, GrantError, GrantOwnerError};
pub use chain::{
    CHUNK_BYTES, ChainMeterError, MAX_CHAIN_LENGTH, pack_chain_meter, preimage_at, random_seed,
    root_from_seed, verify_forward,
};
pub use client_bridge::{
    RetrySignal, WireVoucherError, signed_to_wire_voucher, voucher_reject_reason,
    wire_voucher_to_signed,
};
pub use credit::ramped_credit_window;
pub use deployment::Deployment;
pub use erc20::Erc20;
pub use lane::{
    FoldAxis, LaneChain, LaneKey, LaneState, PoolError, PoolId, PreimageApplied, RedeemClaim,
    VoucherApplied,
};
pub use pool_open_error::{PoolOpenFailureReason, is_erc20_allowance_shortfall, is_pool_not_open};
pub use probe_sig::{
    PROBE_RESPONSE_TYPEHASH, ProbeSlashData, ProbeSlashError, SLASH_JUDGE_DOMAIN_NAME,
    SLASH_JUDGE_DOMAIN_VERSION, slash_judge_domain,
};
pub use rate::{
    BYTES_PER_MB, DEFAULT_TOLERANCE_BPS, RateError, floor_micro, min_payment, pool_budget_covers,
    verify_rate,
};
pub use store::{
    CheckpointKey, KeyedCheckpointStore, MemoryPoolStateStore, PendingSettle, PendingSettleStore,
    PoolStateStore, StoreError,
};
pub use stream_sig::{STREAM_RESPONSE_TYPEHASH, StreamSlashData, StreamSlashError};
pub use voucher::{
    DOMAIN_NAME, DOMAIN_VERSION, SignedVoucher, Voucher, VoucherError, voucher_domain,
};