Media-sdk NPM | npm.io

Media SDK 🚀

The Media SDK is a comprehensive toolkit designed for seamless interaction with the Media Protocol's contracts. Developed in JavaScript, it harnesses the power of the viem library, providing an intuitive interface for engaging with the Media Protocol.

⚠️ Important Note: The contract addresses provided are currently from testnets and are subject to change. Always refer to the official documentation for the most up-to-date and valid contract addresses before any interactions.

📥 Installation

From GitHub

git clone git@github.com:mediafoundation/media-sdk.git
cd media-sdk
npm install

From NPM

npm install media-sdk

🛠️ Usage

Initializing the SDK

To initialize an instance of the Media SDK, use the initSdk function. This function takes in an object with the following optional parameters:

chain: A chain object. See Viem's Chains for more details. If nothing is provided, the default chain will be used, which is Ethereum Goerli until mainnet launch.
privateKey: A ECP256K1 private key as a hex string to create a wallet client. Example: 'afdfd9c3d2095ef696594f6cedcae59e72dcd697e2a7521b1578140422a4f890'.
mnemonic: A BIP39 mnemonic phrase to create a wallet client. Example: 'degree tackle suggest window test behind mesh extra cover prepare oak script'.
walletClient: A wallet client. See Viem's Wallet Client for more details.

All parameters are optional. If all three privateKey, mnemonic, and walletClient are absent, only view functions will be available.

Examples

Using a private key. (Useful for backend applications)

import { initSdk, MarketplaceViewer, Marketplace, Resources, Helper } from 'media-sdk'

// initialize the sdk using a private key.
initSdk({ privateKey: 'afdfd9c3d2095ef696594f6cedcae59e72dcd697e2a7521b1578140422a4f890' })

Using a browser wallet and Ethereum Goerli:

import { initSdk } from 'media-sdk'
import { createWalletClient, http } from 'viem'
import { goerli } from 'viem/chains'

const [account] = await window.ethereum.request({method: 'eth_requestAccounts'})

const walletClient = createWalletClient({
    account: account,
    chain: goerli,
    transport: custom(window.ethereum)
})

// initialize the SDK using a Viem walletClient. 
initSdk({ chain: goerli, walletClient: walletClient });

Using it without signer just for view functions with a custom chain:

import { initSdk, MarketplaceViewer } from 'media-sdk'
import { baseGoerli } from 'viem/chains'

initSdk({ chain: baseGoerli })

const marketplaceViewer = new MarketplaceViewer()

const result = await marketplaceViewer.getPaginatedOffers({
  marketplaceId: 1, 
  start: 0, 
  count: 100
})
console.log(result)

Initializing a new Marketplace

Anybody can initialize a new marketplace. The marketplace will be initialized with the address of the caller as the owner. The owner can then transfer ownership to another address.

import { initSdk, Marketplace, config } from 'media-sdk'

// initialize the sdk using your mnemonic
initSdk({ mnemonic: 'degree tackle suggest window test behind mesh extra cover prepare oak script' })

// instanciate the marketplace contract
const marketplace = new Marketplace()

//initialize a new marketplace
const hash = await marketplace.initializeMarketplace({
  requiredStake: 100,  // marketplace min required staked liquidity 
  marketFeeTo: config().walletClient.account.address, // market fee recipient address 
  marketFeeRate: 5000 // market fee rate %
})

// wait for the transaction to be mined
const transaction = await config().publicClient.waitForTransactionReceipt( 
  { hash: hash }
)

//get the id of the new marketplace from the transaction logs
console.log(transaction.logs[0].topics[1])

Fetching Resources

// import the sdk
import { initSdk, Resources, walletClient } from 'media-sdk'

// initialize the sdk using your mnemonic
initSdk({ mnemonic: 'degree tackle suggest window test behind mesh extra cover prepare oak script' })
const resources = new Resources()
const result = await resources.getPaginatedResources({
   userAddress: walletClient.account.address, 
   start: 0, 
   steps: 20 
})
console.log(result)

📚 More Information

For more details and a deep dive into our features, check out the official Media SDK documentation at https://www.mediaprotocol.net/sdk/overview.

Front-End Boilerplate

If you're looking for an example to get started with a front-end application, check out our Media Protocol Frontend Boilerplate. It's a great way to get started with the Media Protocol and the Media SDK.