Struct MetadataApi

Source

pub struct MetadataApi {
    pub ipfs: Ipfs,
}

Expand description

High-level facade mirroring MetadataApi from the TypeScript SDK.

All operations are available as free functions in this module; MetadataApi groups them under a single type that carries an optional Ipfs configuration, so callers do not have to thread IPFS settings through every call.

§Typical workflow

use cow_app_data::{Ipfs, MetadataApi};

// 1. Create the API (with optional IPFS config).
let api = MetadataApi::new();

// 2. Build an app-data document.
let doc = api.generate_app_data_doc("MyDApp");

// 3. Validate it.
let result = api.validate_app_data_doc(&doc);
assert!(result.is_valid());

// 4. Derive the hash + CID.
let info = api.get_app_data_info(&doc).unwrap();
assert!(info.app_data_hex.starts_with("0x"));

Fields§

§ipfs: Ipfs

Optional IPFS configuration.

Implementations§

Source §

impl MetadataApi

Source

pub fn new() -> Self

Create a new MetadataApi with default IPFS settings.

Uses DEFAULT_IPFS_READ_URI for fetching and DEFAULT_IPFS_WRITE_URI for uploads. No Pinata credentials are configured — set them via with_ipfs if you need upload capability.

§Returns

A new MetadataApi with default Ipfs configuration.

Source

pub const fn with_ipfs(ipfs: Ipfs) -> Self

Create a MetadataApi with custom IPFS configuration.

§Parameters

ipfs — the Ipfs settings (gateway URIs, Pinata credentials).

§Returns

A new MetadataApi using the given configuration.

§Example

use cow_app_data::{Ipfs, MetadataApi};

let api = MetadataApi::with_ipfs(
    Ipfs::default().with_read_uri("https://my-gateway.io/ipfs").with_pinata("key", "secret"),
);

Source

pub fn generate_app_data_doc(&self, app_code: impl Into<String>) -> AppDataDoc

Generate a minimal AppDataDoc for app_code.

§Example

use cow_app_data::MetadataApi;

let api = MetadataApi::new();
let doc = api.generate_app_data_doc("CoW Swap");
assert_eq!(doc.app_code.as_deref(), Some("CoW Swap"));

Source

pub fn validate_app_data_doc(&self, doc: &AppDataDoc) -> ValidationResult

Validate an AppDataDoc.

§Example

use cow_app_data::{AppDataDoc, MetadataApi};

let api = MetadataApi::new();
let doc = AppDataDoc::new("CoW Swap");
let result = api.validate_app_data_doc(&doc);
assert!(result.is_valid());

Source

pub fn appdata_hex(&self, doc: &AppDataDoc) -> Result<B256, CowError>

Compute the keccak256 hash of doc as a B256.

Delegates to appdata_hex. The document is serialised to deterministic JSON before hashing.

§Parameters

doc — the AppDataDoc to hash.

§Returns

A 32-byte B256 digest.

§Errors

Propagates CowError::AppData on serialisation failure.

Source

pub fn get_app_data_info( &self, doc: &AppDataDoc, ) -> Result<AppDataInfo, CowError>

Derive the full AppDataInfo (JSON content, hex hash, CID) from doc.

Delegates to get_app_data_info. This is the most common method for obtaining everything needed to submit an order and pin data on IPFS.

§Parameters

doc — the AppDataDoc to process.

§Returns

An AppDataInfo with canonical JSON, hex hash, and CID.

§Errors

Propagates CowError::AppData.

§Example

use cow_app_data::{AppDataDoc, MetadataApi};

let api = MetadataApi::new();
let doc = AppDataDoc::new("CoW Swap");
let info = api.get_app_data_info(&doc)?;
assert!(info.app_data_hex.starts_with("0x"));

Source

pub fn get_app_data_info_from_str( &self, json: &str, ) -> Result<AppDataInfo, CowError>

Derive AppDataInfo from a pre-serialised JSON string.

Hashes json directly without re-serialising, preserving the exact byte sequence as the canonical keccak256 pre-image.

§Parameters

json — the canonical JSON string.

§Returns

An AppDataInfo where app_data_content is json verbatim.

§Errors

Propagates CowError::AppData.

Source

pub fn app_data_hex_to_cid( &self, app_data_hex: &str, ) -> Result<String, CowError>

Convert app_data_hex to a CIDv1 base16 string.

Delegates to appdata_hex_to_cid.

§Parameters

app_data_hex — the appData hex value, with or without 0x.

§Returns

A base16 CIDv1 string (prefix f).

§Errors

Propagates CowError::AppData.

Source

pub fn cid_to_app_data_hex(&self, cid: &str) -> Result<String, CowError>

Extract the appData hex digest from a CIDv1 string.

Delegates to cid_to_appdata_hex.

§Parameters

cid — a base16 multibase CID string.

§Returns

A 0x-prefixed hex string of the 32-byte digest.

§Errors

Propagates CowError::AppData.

Source

pub async fn fetch_doc_from_cid( &self, cid: &str, ) -> Result<AppDataDoc, CowError>

Fetch an AppDataDoc from IPFS by CIDv1.

Uses the configured ipfs.read_uri or DEFAULT_IPFS_READ_URI when no custom gateway is set.

§Parameters

cid — the CIDv1 base16 string identifying the document on IPFS.

§Returns

The deserialised AppDataDoc.

§Errors

Propagates CowError::Http on network failure or CowError::Parse if the response is not valid JSON.

Source

pub async fn fetch_doc_from_app_data_hex( &self, app_data_hex: &str, ) -> Result<AppDataDoc, CowError>

Fetch an AppDataDoc from IPFS by appData hex value.

Converts app_data_hex to a CIDv1, then fetches the document from the configured IPFS gateway.

§Parameters

app_data_hex — the 0x-prefixed 32-byte hex value.

§Returns

The deserialised AppDataDoc.

§Errors

Propagates CowError::AppData, CowError::Http, or CowError::Parse.

Source

pub async fn upload_app_data( &self, doc: &AppDataDoc, ) -> Result<String, CowError>

Upload doc to IPFS via the Pinata pinning service.

The document is serialised to deterministic JSON, hashed, and pinned to Pinata. Requires Ipfs::pinata_api_key and Ipfs::pinata_api_secret to be set on the configured Ipfs instance.