Use Openfort with Node.js

Learn how to get started with Openfort and mint an asset with NodeJS.

What you'll learn:#

How to manage third-party dependencies using the npm or yarn package manager.
How to install the latest Openfort Node SDK.
How to send your first SDK request.

Set up a Openfort Node.js SDK

Open your project in the Openfort Dashboard.

The latest version of the Openfort Node.js server-side SDK supports Node.js versions 14+.

Terminal

 mkdir openfort-tutorial
 cd openfort-tutorial
 npm init -y
 npm install @openfort/openfort-node --save
 touch index.js

Declare Openfort Environment Variables

After your project is ready, grab your secret_key and public_key from the project.

Create a .env file and populate with your project's secret key.

Also make sure to add the package.json file.

.env

  YOUR_SECRET_KEY=sk_test_...

package.json

{
  "name": "node",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "dev": "node index.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@openfort/openfort-node": "^0.6.10"
  }
}

Add a contract to Openfort

In this tutorial, we'll use a simple ERC-721 contract on the Mumbai network deployed at 0x380...AC0.

Once added, Openfort will return a contract id that you can use to interact with the contract. It starts with con_.

Terminal

curl https://api.openfort.xyz/v1/contracts \
  -H "Authorization: Bearer $YOUR_SECRET_KEY" \
  -d chainId=80001 \
  -d address="0x38090d1636069c0ff1Af6bc1737Fb996B7f63AC0" \
  -d name="Simple NFT"

Prepare gas sponsorship

To offer gasless transaction (sponsor gas) in Openfort, your need to create a policy and a policy rule.

The policy rule will define the contract functions that you want to sponsor. In this example, we create a simple policy rule to pay for all user's interactions with the contract.

Grab your contract id and the policy id to include on your call.

Terminal

curl https://api.openfort.xyz/v1/policies \
-H "Authorization: Bearer $YOUR_SECRET_KEY" \
-d chainId=80001 \
-d name="simple sponsor" \
-d "strategy[sponsorSchema]=pay_for_user"

Terminal

curl https://api.openfort.xyz/v1/policies/:id/policy_rules \
  -H "Authorization: Bearer $YOUR_SECRET_KEY" \
  -d type="contract_functions" \
  -d functionName="All functions" \
  -d contract="con_..."

Mint an NFT

Now mint an NFT using the contract id and the player id that you created in the previous steps.

Openfort will encode the transaction based on the provided information in the interaction.

The smart account will be created and deployed automatically for you on the Mumbai network.

Because optimistic is set to false, the response from creating the transactionIntents will contain a response.

Remember to replace the policy, contract and player ids with your own.

index.js

const Openfort = require('@openfort/openfort-node').default;
const openfort = new Openfort(process.env.YOUR_SECRET_KEY);
const main = async () => {
  const player = await openfort.players.create({
    "name":"John Doe",
    "description":"Tutorial created account"
  });
  console.log("Success! Here is your player id: " + player.id);
  const contractId = "con_...";
  const policyId = "pol_...";
  const chainId = 80001;
  const optimistic = false;
  const interaction_mint = {
    contract: contractId,
    functionName: "mint",
    functionArgs: [player.id],
  };
  const transactionIntent = await openfort.transactionIntents.create({
    "player":player.id,
    "chainId":chainId,
    "optimistic":optimistic,
    "interactions":[interaction_mint],
    "policy":policyId
  });
  console.log("Success! Here is your transactionIntent id: " + transactionIntent.id);
}
main().then(() => process.exit(0))

Run the script

You're all set! Run the development server on your Terminal.

You can check the logs and events of the transaction intent in your dashboard.

Terminal

npm run dev