Struct LocalJson

pub struct LocalJson { /* private fields */ }

A MetadataGenerator that consults stored JSON files in the local filesystem.

Notes

Files must be stored at contract.json for contract-level metadata, and {token-id}.json for tokens, where token-id is the string representation of the decimal token id. e.g. 0.json, 384510.json, etc

This generator caches files in memory the first time they’re opened. If NFT metadata changes, the server will need to be re-booted to clear the cache. In addition, if you’re serving an egregious number of NFTs (or have large image-data properties), you may run out of memory as the cache grows

Implementations

impl LocalJson

pub fn new(location: PathBuf) -> Result<Self>

Instantiate a LocalJson metadata generator. Creates directories up to the specified path

Errors

• If the location exists and is not a directory
• If the directory can’t be created

Trait Implementations

impl Debug for LocalJson

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MetadataGenerator for LocalJson

type Error = LocalJsonError

Associated Error type

fn metadata_for<'life0, 'async_trait>( &'life0 self, token_id: U256, ) -> Pin<Box<dyn Future<Output = Result<Option<NftMetadata>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generate metadata for a specific token

fn contract_metadata<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<ContractMetadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generate contract-level metadata (in the OpenSea format). See ContractMetadata.