trident-sdk 0.2.0

End-user SDK for Trident deposits and cross-chain spends
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

use alloy_primitives::U256;
use async_trait::async_trait;

use crate::conversions::ProtoConversionError;
use crate::deposit::DepositContext;
use crate::evm::EvmChainError;
use crate::proto::v1;
use crate::spend_attestation::SpendAttestationChainContext;

/// Errors raised by a live [`ChainHandler`] while servicing an SDK
/// operation (signing, deposit preparation, etc.). Surfaced through
/// [`crate::TridentClientError::ChainHandler`].
#[derive(Debug, thiserror::Error)]
pub enum ChainHandlerError {
    /// The wrapped handler is an EVM chain and the underlying operation
    /// failed.
    #[error(transparent)]
    EvmChain(#[from] EvmChainError),
}

/// Errors produced while materializing a [`ChainHandler`] from a pending
/// registration once the delivery service has returned deployment data.
#[derive(Debug, thiserror::Error)]
pub enum ChainHandlerBuildError {
    /// Decoding a proto-sourced contract address failed.
    #[error("Invalid proto conversion: {0}")]
    ProtoConversion(#[from] ProtoConversionError),
}

#[async_trait]
pub(crate) trait ChainHandler: Send + Sync {
    fn delivery_contract(&self) -> v1::MultiChainAddress;
    fn deposit_contract(&self) -> v1::MultiChainAddress;
    fn signer(&self) -> v1::MultiChainAddress;

    async fn sign_spend_intent(
        &self,
        intent: v1::SpendIntent,
    ) -> Result<Vec<u8>, ChainHandlerError>;

    fn prepare_deposit(
        &self,
        token: v1::MultiChainAddress,
        amount: U256,
    ) -> Result<DepositContext, ChainHandlerError>;

    fn prepare_spend_attestation(&self) -> SpendAttestationChainContext;
}

/// Materializes a [`ChainHandler`] for a specific chain family once the
/// delivery-service deployment data is in hand.
///
/// Chain-agnostic [`crate::TridentClientBuilder`] stores these as
/// `Box<dyn ChainHandlerBuilder>` and invokes [`build`](Self::build) at
/// `connect()` time.
#[async_trait]
pub(crate) trait ChainHandlerBuilder: Send + Sync {
    async fn build(
        self: Box<Self>,
        delivery_contract: v1::MultiChainAddress,
        deposit_contract: v1::MultiChainAddress,
    ) -> Result<Box<dyn ChainHandler>, ChainHandlerBuildError>;
}