@msquared/web3-metagame-sdk

Msquared Web3 Metagame SDK

A typescript SDK that abstracts the complexity of using web3 tooling for gaming within a browser or server environment

Key features

• User data backed by an on-chain key value store

Usage

Installation

NPM

npm i @msquared/web3-metagame-sdk

Yarn

yarn add @msquared/web3-metagame-sdk

Peer Dependencies

In order to use this SDK, a viem public (and optionally wallet client) is required

The goal with this SDK is to detach any keys / signers from on-chain interactions!

Example - Registering and emitting an event schema without building a contract

import { SDK } from "@msquared/web3-metagame-sdk"

// Instantiate the SDK
const sdk = new SDK({
    public: getPublicClient(),
    wallet: getWalletClient(), // Required to execute transactions
})

// Update register the event
let hash = await sdk.events.registerEventSchema(name, id, eventTopic, args)

await waitForTransactionReceipt({ hash })

// Emit the event referencing name and passing data
hash = await sdk.events.emitEvent(name, topics, data)

await waitForTransactionReceipt({ hash })

// Read data from indexer

Example - Reading Data from chain

import { SDK } from "@msquared/web3-metagame-sdk"

// Instantiate the SDK with just a public viem client
const sdk = new SDK({ public: getPublicClient() })

// Fetch the profile
const profile = await sdk.player.data.getProfile(
    getAddress(wallet),
)

Example - Writing Data on-chain

import { SDK } from "@msquared/web3-metagame-sdk"

// Instantiate the SDK
const sdk = new SDK({
    public: getPublicClient(),
    wallet: getWalletClient(), // Required to execute transactions
})

// Update the profile onchain
const hash = await sdk.player.data.setProfile(profile, account)