tidepool-rpc 0.2.0

Tidepool — Helius-compatible local RPC service: cNFT indexing, DAS responses, upstream-agnostic. The headline Rust crate.
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

//! AccountDecoder trait — the pluggable seam for uncompressed-asset
//! decoding. The proxy picks a decoder by matching the account's
//! `owner` program ID; first match wins. Ship your own decoder to add
//! support for any NFT program.
//!
//! Decoders are synchronous + pure. Upstream reads, caching, and
//! cross-account resolution are the DAS-handler's job; decoders only
//! turn raw bytes into a DAS-shaped response (or `Ok(None)` when the
//! byte layout isn't a variant this decoder handles).

use thiserror::Error;

use super::types::DasAsset;

#[derive(Debug, Error)]
pub enum DecoderError {
    #[error("decoder `{decoder}` failed on {context}: {source}")]
    DecodeFailed {
        decoder: &'static str,
        context: String,
        #[source]
        source: std::io::Error,
    },
    #[error("decoder `{decoder}`: {reason}")]
    Invariant {
        decoder: &'static str,
        reason: &'static str,
    },
}

pub trait AccountDecoder: Send + Sync {
    /// Program ID (base58) this decoder handles. The proxy dispatches
    /// by matching the account's `owner` field against this string.
    fn program_id(&self) -> &str;

    /// Human-readable name — used in the `interface` field of the DAS
    /// asset response and in log output.
    fn name(&self) -> &str;

    /// Decode raw account bytes into a DAS asset. Return `Ok(None)`
    /// when the bytes are the right owner program but the wrong
    /// account variant (e.g. HashedAssetV1 when this decoder only
    /// handles AssetV1). Error out only on genuinely corrupt bytes.
    fn decode(&self, pubkey: &str, data: &[u8]) -> Result<Option<DasAsset>, DecoderError>;
}