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 primartily by the vendor of the payment API.
use candid::{CandidType, Deserialize, Principal};
pub use ic_cycles_ledger_client::Account;

use crate::caller::TokenAmount;

/// Billing options that may be offered to a customer.
#[derive(Debug, CandidType, Deserialize, Copy, Clone, Eq, PartialEq)]
#[non_exhaustive]
pub enum PaymentOption {
    /// 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 { fee: Option<TokenAmount> },
    /// The caller is paying with cycles from their main account on the cycles ledger.
    CallerPaysIcrc2Cycles { fee: Option<TokenAmount> },
    /// A patron is paying, on behalf of the caller, from their main account on the cycles ledger.
    PatronPaysIcrc2Cycles { fee: Option<TokenAmount> },
}

/// User's payment details for an ICRC2 payment.
#[derive(Debug, CandidType, Deserialize, Clone, Eq, PartialEq)]
pub struct Icrc2Payer {
    /// The customer's principal and (optionally) subaccount.
    ///
    /// By default, the caller's main account is used.
    pub account: Option<Account>,
    /// The spender, if different from the payer.
    pub spender_subaccount: Option<serde_bytes::ByteBuf>,
    /// The ledger canister ID.
    ///
    /// Note: This is included in order to improve error messages if the caller tries to use the wrong ledger.
    pub ledger_canister_id: Option<Principal>,
    /// Corresponds to the `created_at_time` field in ICRC2.
    pub created_at_time: Option<TokenAmount>,
}