Skip to content
Smart Layer Network

Migrating to tokenscript-project.json from a legacy project

This guide will help you add the tokenscript-project.json file which will help you add environment variable support to your TokenScript project. This will allow you to switch to different chains or environments without editing any config.

  1. Add tokenscript-project.json

    Add tokenscript-project.json into the root of your TokenScript project:

    {
        "$schema": "https://tokenscript.org/schemas/project/tokenscript-project.schema.json",
        "environment": {
            "default": {
                "CONTRACT_CHAIN": "11155111",
                "NFT_CONTRACT_ADDRESS": "0x2d46915606580080C6c9032ed041e6FF21a5C8a6",
                "GAME_CONTRACT_ADDRESS": "0xfF3CDc910F77f65f0322FB1A10cEc651c7A8315F"
            },
            "polygon": {
                "CONTRACT_CHAIN": "137",
                "NFT_CONTRACT_ADDRESS": "0xB48f53010Acbc0E24D3D12D892E2215879e6fD13",
                "GAME_CONTRACT_ADDRESS": "0xBAB028f7ac84EB4A90BC4eE5c3725437fFbA806e"
            }
        }
    }

  2. Update tokenscript.xml

    Add placeholder tokens into the tokenscript.xml that refer to those environment variables. In example

    <ts:token>
        <ts:contract interface="erc721" name="Token">
            <ts:address network="$tst{CONTRACT_CHAIN}">$tst{NFT_CONTRACT_ADDRESS}</ts:address>
        </ts:contract>
        <ts:contract name="MorchiScore">
            <ts:address network="$tst{CONTRACT_CHAIN}">$tst{GAME_CONTRACT_ADDRESS}</ts:address>
        </ts:contract>
        <ts:abi>
            <!-- Content omitted -->
        </ts:abi>
    </ts:token>

  3. Update package.json

    Then we need to modify the build scripts in package.json. Since TokenScript CLI now invokes the web build rather than it being run independently, the build command is now simply tokenscript build. Any web build required is put in the ts:buildWeb command instead:

      {
        "scripts": {
          "build": "tokenscript build",
          "ts:buildWeb": "vite build"
        }
      }

    Note: Use the appropriate build command for your template. It’s either vite build or webpack build

You can add additional environment variables into ts:meta which are made available via the Card SDK: https://sln-doc.vercel.app/framework/card-sdk/introduction#environmentVariables

Contract info is already accessible via the card SDK method tokenscript.eth.getContractInfo("ContractName").

Once you have configured your environments, you can run or emulate a specific environment like so:

Terminal window
tokenscript build polygon
tokenscript emulate polygon