ic-papi-api 0.1.1

A payment system for ICP canisters offering paid APIs.
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

//! Types used primarily by the caller of the payment API.
use candid::{CandidType, Deserialize, Principal};
pub use ic_cycles_ledger_client::Account;

/// How a caller states that they will pay.
#[derive(Debug, CandidType, Deserialize, Clone, Eq, PartialEq)]
#[non_exhaustive]
pub enum PaymentType {
    /// The caller is paying with cycles attached to the call.
    ///
    /// Note: This is available to inter-canister aclls only; not to ingress messages.
    ///
    /// Note: The API does not require additional arguments to support this payment type.
    AttachedCycles,
    /// The caller is paying with cycles from their main account on the cycles ledger.
    CallerPaysIcrc2Cycles,
    /// A patron is paying with cycles on behalf of the caller.
    PatronPaysIcrc2Cycles(PatronPaysIcrc2Cycles),
    /// The caller is paying with tokens from their main account on the specified ledger.
    CallerPaysIcrc2Tokens(CallerPaysIcrc2Tokens),
    /// A patron is paying, on behalf of the caller, from an account on the specified ledger.
    PatronPaysIcrc2Tokens(PatronPaysIcrc2Tokens),
}

pub type PatronPaysIcrc2Cycles = Account;

#[derive(Debug, CandidType, Deserialize, Copy, Clone, Eq, PartialEq)]
pub struct CallerPaysIcrc2Tokens {
    pub ledger: Principal,
}

#[derive(Debug, CandidType, Deserialize, Clone, Eq, PartialEq)]
pub struct PatronPaysIcrc2Tokens {
    pub ledger: Principal,
    pub patron: Account,
}

pub type TokenAmount = u64;