canic-core 0.91.0

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Module: api::intent
//!
//! Responsibility: expose direct local and receipt-backed intent operations.
//! Does not own: external calls, domain receipt validation, or retry policy.
//! Boundary: maps public inputs to non-awaiting intent workflows.

use crate::{
    dto::error::Error,
    workflow::runtime::intent::{LocalIntentWorkflow, ReceiptBackedIntentWorkflow},
};

pub use crate::{
    ids::{IntentId, IntentResourceKey},
    model::{
        intent::{
            BeginLocalIntentInput, BeginReceiptBackedIntentInput, BeginReceiptBackedIntentResult,
            PayloadBinding, ReceiptBackedIntent, ReceiptBackedIntentState,
            SettleReceiptBackedIntentInput, SettleReceiptBackedIntentResult, TerminalEvidence,
            TerminalEvidenceDecision,
        },
        replay::OperationId,
    },
};

/// Direct operations for locally decidable, expirable reservations.
pub struct LocalIntentApi;

impl LocalIntentApi {
    pub fn begin(input: BeginLocalIntentInput) -> Result<IntentId, Error> {
        LocalIntentWorkflow::begin(input).map_err(Error::from)
    }

    pub fn commit(intent_id: IntentId) -> Result<(), Error> {
        LocalIntentWorkflow::commit(intent_id).map_err(Error::from)
    }

    pub fn rollback(intent_id: IntentId) -> Result<(), Error> {
        LocalIntentWorkflow::rollback(intent_id).map_err(Error::from)
    }
}

/// Exact-key receipt-backed operations for consumer-validated evidence.
pub struct ReceiptBackedIntentApi;

impl ReceiptBackedIntentApi {
    pub fn begin_or_load(
        input: &BeginReceiptBackedIntentInput,
    ) -> Result<BeginReceiptBackedIntentResult, Error> {
        ReceiptBackedIntentWorkflow::begin_or_load(input).map_err(Error::from)
    }

    pub fn load(operation_id: OperationId) -> Result<Option<ReceiptBackedIntent>, Error> {
        ReceiptBackedIntentWorkflow::load(operation_id).map_err(Error::from)
    }

    pub fn settle_if_pending(
        input: &SettleReceiptBackedIntentInput,
    ) -> Result<SettleReceiptBackedIntentResult, Error> {
        ReceiptBackedIntentWorkflow::settle_if_pending(input).map_err(Error::from)
    }
}