NftLand.js

NFT LAND is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a JavaScript library intended to make interfacing with the contract reasonable and easy.

• Synopsis
• Installation
• Getting Started
  • Use Cases
• Contributing

Target Versions

| Software | Version | | -------- | -------- | | node | v20.9.0 | | npm | v10.2.3 | | yarn | v1.22.22 |

Package Manager

• Use yarn, do NOT use npm.

Synopsis

This is a JavaScript library to help interface with NftLand. It includes various helper methods and constants that makes interfacing with NftLand easier. These include creating orders, fulfilling orders, doing the necessary balance and approval checks, and more.

Installation

• NftLand.js is private git repository, so add this library under dependencies in your package.json, then run yarn install.
• Please specify the latest release tag

  "dependencies": {
    "@t2-web/nft_land_js": "git+ssh://[email protected]:t2-web/nft_land_js.git#v2.1.0",
    ...
  }

Getting Started

Instantiate your instance of NftLand using your ethers provider:

Examples

Through a browser provider (i.e. Metamask)

import { NftLand } from "@t2-web/nft_land_js";
import { ethers } from "ethers";

const provider = new ethers.providers.Web3Provider(window.ethereum);

const nftLand = new NftLand(provider);

Through a RPC Provider (i.e. Alchemy)

import { NftLand } from "@t2-web/nft_land_js";
import { ethers } from "ethers";

const provider = new ethers.providers.JsonRpcProvider(
  "https://<network>.alchemyapi.io/v2/YOUR-API-KEY"
);

const nftLand = new NftLand(provider);

With custom signer

import { NftLand } from "@t2-web/nft_land_js";
import { ethers } from "ethers";

// Provider must be provided to the signer when supplying a custom signer
const provider = new ethers.providers.JsonRpcProvider(
  "https://<network>.alchemyapi.io/v2/YOUR-API-KEY"
);

const signer = new ethers.Wallet("YOUR_PK", provider);

const nftLand = new NftLand(signer);

Look at the relevant definitions in nftLand.ts in order to see the different functionality this library offers.

Use Cases

Many of the main core flows return use cases. What this means is that if you were to create an order (a la createOrder), the library helps perform the necessary balance and approval checks based on the offer of the order being created. If the offerer requires approvals on one asset contract, the actions field of the use case would contain an approval action that the user should execute first in order for the trade to succeed in the future.

Examples

Listing an ERC-721 for 10 ETH and fulfilling it

const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
const { executeAllActions } = await nftLand.createOrder(
  {
    offer: [
      {
        itemType: ItemType.ERC721,
        token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
        identifier: "1",
      },
    ],
    consideration: [
      {
        amount: ethers.utils.parseEther("10").toString(),
        recipient: offerer,
      },
    ],
  },
  offerer
);

const order = await executeAllActions();

const { executeAllActions: executeAllFulfillActions } =
  await nftLand.fulfillOrder({
    order,
    accountAddress: fulfiller,
  });

const transaction = executeAllFulfillActions();

Making an offer for an ERC-721 for 10 WETH and fulfilling it

const offerer = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266";
const fulfiller = "0x70997970c51812dc3a010c7d01b50e0d17dc79c8";
const { executeAllActions } = await nftLand.createOrder(
  {
    offer: [
      {
        amount: parseEther("10").toString(),
        // WETH
        token: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
      },
    ],
    consideration: [
      {
        itemType: ItemType.ERC721,
        token: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
        identifier: "1",
        recipient: offerer,
      },
    ],
  },
  offerer
);

const order = await executeAllActions();

const { executeAllActions: executeAllFulfillActions } =
  await nftLand.fulfillOrder({
    order,
    accountAddress: fulfiller.address,
  });

const transaction = executeAllFulfillActions();