@cere/media-sdk-client NPM

@cere/media-sdk-client

@cere/media-sdk-client

Installation

Install the package:

NPM

npm install @cere/media-sdk-client --save

Yarn

yarn add @cere/media-sdk-client

Create an instance

The MediaSdkClient instance can be created using the static create method. It takes two arguments

Arguments

signer - an ethers compatible signer instance
chainNamespace - the Network namespace
chainId - the Network chainId
options - a config object to define the environment and tenant to connect to
- deployment - the deployed environment to connect to
- tenant - the tenant to connect to
logger - whether to enable debug logging for the client

interface MediaClientOptions {
  deployment: Deployment;
  tenant: Tenant;
  logger?: boolean;
}

type Deployment = 'production' | 'staging' | 'development' | 'local';
type Tenant = 'davinci' | 'cerefans';

Example

import { MediaClientOptions } from '@cere/media-sdk-client';

const signer = // Get Signer from currently connected wallet

// With default options
const client = await MediaSdkClient.create(signer)

// With config arguments
const client = await MediaSdkClient.create({ deployment: "development", tenant: "davinci" })

// With logger enabled
const client = await MediaSdkClient.create({ ...options, logger: true })

API

The methods provided by the MediaSdkClient are:

`create()`

Creates and initializes a new instance of MediaSdkClient.

Arguments:

signer (Signer): An ethers compatible signer instance for authentication.
chainNamespace: the Network namespace
chainId: the Network chainId
options (MediaClientOptions): Configuration options including deployment, tenant, and logger settings.

Returns:

MediaSdkClient - A promise that resolves to a new instance of MediaSdkClient.

`getNftMetadata()`

Gets detailed metadata for a specific NFT.

Arguments:

contractAddress (string): The contract address of the NFT collection.
nftId (number): The ID of the NFT within the collection.

Returns:

NftMetadata - An object containing NFT details like name, description, preview, and associated assets.

`getNftAssets()`

Retrieves assets associated with a specific NFT.

Arguments:

contractAddress (string): The contract address of the NFT collection.
nftId (number): The ID of the NFT within the collection.

Returns:

NftAsset[] - An array of NftAsset objects, each detailing an asset associated with the NFT including name, description, asset link, preview link, and content type.

`getCanAccess()`

Checks if a wallet has access to an NFT's content.

Arguments:

collectionAddress (string): The address of the Freeport Collection smart contract.
nftId (number): The ID of the NFT on the Freeport Collection smart contract.
walletAddress (string): The address to check access for. Defaults to the signer's address if not specified.

Returns:

boolean - Returns true if the given wallet address can access the given NFT, false otherwise.