@ton-community/gamefi-sdk

gamefi-sdk

GameFi SDK provides developer friendly APIs to help interact game developers with different GameFi assets on TON, such as NFTs/SBTs and jettons (fungible tokens). An example game using it can be found here.

Installation

npm i @ton-community/gamefi-sdk

or

yarn add @ton-community/gamefi-sdk

Usage

In order to start using this SDK, you need to acquire an instance of GameFiSDK in your code. That will require specifying a storage (we currently support Pinata and S3 out of the box, but you can implement your own using our interface), an API (mainnet or testnet), and a wallet (V4 is supported out of the box). For example:

const sdk = await GameFiSDK.create({
    storage: {
        pinataApiKey: process.env.PINATA_API!,
        pinataSecretKey: process.env.PINATA_SECRET!,
    },
    api: 'testnet',
    wallet: await createWalletV4(process.env.MNEMONIC!),
});

(This is taken directly out of our example, and you can find more in that directory)

Here, you would pass your Pinata keys and the wallet mnemonic (space separated) as env variables.

After you do that, you can:

• create a jetton minter or an NFT/SBT collection (as in the example mentioned above) using the methods createJetton or createNftCollection/createSbtCollection
• open an existing jetton minter, jetton wallet, NFT/SBT collection or NFT/SBT item in order to perform some action on them (mint, transfer, burn, etc)

Jettons

Creating a jetton minter

Call the createJetton method on the SDK instance, passing JettonContent (all possible fields are uri, name, description, image, imageData, symbol, decimals, amountStyle, renderType, see TEP-64 for their description), and any options, such as onchainContent (to put the metadata onchain), adminAddress (to make a different address the admin), premint (to mint some tokens immediately on deploy), and value (to specify the amount of TON sent as fee). For example:

const jetton = await sdk.createJetton({
    name: 'Test jetton',
    decimals: 9,
    description: 'Test jetton description',
    symbol: 'TEST',
}, {
    premint: {
        to: sdk.sender?.address!,
        amount: toNano('100'),
    },
});

Open an existing jetton minter

Call the openJetton method with the address of the jetton that you wish to open, for example:

const jetton = sdk.openJetton(Address.parse('EQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAM9c'));

Using the jetton minter instance

Once you have a Jetton instance acquired by either creating it or opening one, you can perform the following actions:

• getWalletAddress - get a user's jetton wallet address
• getWallet - same as above, but immediately opens the address as a jetton wallet
• getData - gets the raw onchain data of the jetton
• sendDeploy - sends a deploy message; this method is mostly for internal use
• sendMint - sends a mint message; this method requires you to be the admin of the jetton
• sendChangeAdmin - sends a message to change the admin; this method requires you to be the admin of the jetton
• sendChangeContent - sends a message to change the content of the jetton; this method requires you to be the admin of the jetton

Using the jetton wallet instance

You can acquire a JettonWallet instance either by calling the openJettonWallet on the SDK instance with the address of a known jetton wallet, or by calling getWallet on a Jetton minter instance.

You can then use it to perform the following actions:

• getData - get the raw onchain data of the wallet
• sendTransfer - send a message to transfer some tokens to another user; this method requires you to be the owner of the jetton wallet
• sendBurn - send a message to burn some tokens; this method requires you to be the owner of the jetton wallet

You can also use the JettonWallet class itself to do the following:

• parseTransferBody - parse the body of a transfer transaction to retrieve the parameters of the transfer
• parseTransfer - same as the above, but parse the entire transaction instead of just its body to retrieve additional parameters

NFTs

Creating an NFT/SBT collection

Call the createNftCollection/createSbtCollection, specifying in the first argument the collectionContent (all possible fields are uri, name, description, image, imageData, see TEP-64 for their descriptions), passing any options (same as with jettons) as the second argument. For example:

const collection = await sdk.createNftCollection({
    collectionContent: {
        name: 'Test collection',
        description: 'Test collection description',
    },
    commonContent: 'https://example.com/nft-items/',
});

Open an existing NFT/SBT collection

Call the openNftCollection/openSbtCollection method with the address of the collection that you wish to open, for example:

const collection = sdk.openNftCollection(Address.parse('EQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAM9c'));

Using the NFT/SBT collection instance

Once you have an NftCollection/SbtCollection instance, you can perform the following actions:

• getItemAddress - get the item's address by its index
• getItem - same as above, but open the acquired address as an NftItem instance
• sendMint - send a message to mint an item; this method requires you to be the collection admin
• sendBatchMint - send a message to mint multiple items; this method requires you to be the collection admin
• sendDeploy - send a message to deploy the collection, regular users should not normally use this method
• sendChangeAdmin - send a message to change the admin of the collection; this method requires you to be the collection admin
• sendChangeContent - send a message to change the content of the collection; this method requires you to be the collection admin
• getData - get raw onchain data of the jetton minter
• getItemContent - get the full item content using the item index and individual item content

Using the NFT/SBT item instance

You can acquire an NftItem instance either by calling the getItem method on a collection instance, or by calling openNftItem on the SDK instance.

Using the instance, you can do the following:

• sendTransfer - send a message to transfer the item; requires you to be the owner of the item, will not work on an SBT item
• getData - get the raw onchain data of the item

You can also use the NftItem class to do the following:

• parseTransferBody - parse the transfer transaction message body to retrieve its parameters
• parseTransfer - same as the above, but parse the whole transaction to retrieve additional parameters

License

MIT