bboynam99 / sdk

A library to make your life easier. Helps you interact with ReNFT contract with ease.

Welcome to ReNFT SDK

Lend and rent any ERC721s and ERC1155s on Ethereum mainnet. This library will make your life easier with ReNFT.

What is ReNFT?

• lend your ERC721 NFTs
• lend your ERC1155 NFTs
• lend combinations of ERC721 and ERC1155
• lend different amount of ERC1155, along with ERC721 all in one transaction
• gas optimised. Single lend is a single storage slot
• rent the NFTs
• claim collateral if your NFT is not returned in time
• return the NFT before the due date
• automatically re-lends your NFT after it is being returned

This sdk will ease out your journey with ReNFT. Among other things it handles

• price packing of collateral and rent prices
• correctly calling the contract to take advantage of the gas savings

Install

yarn add @renft/sdk

Usage

The below is a simple example of lending an ERC721, note that amount is ignored, you will always lend 1 qty of ERC721 tokenID. This is not the case for ERC1155.

With our protocol, you can also lend ERC1155 in multiple amounts! Moreover, it does not matter in what order you supply the inputs to our lend function, it will call the contract in a way that will save you as much gas as possible. This means a single call per ERC1155 group, moreover, the tokenIDs will be ordered in ascending order.

import { BigNumber, providers, Wallet } from 'ethers';
import { ReNFT, PaymentToken } from '@renft/sdk';

const walletMnemonic = Wallet.fromMnemonic(`<your mnemonic>`);
const provider = new providers.JsonRpcProvider(`<your provider url>`);
let wallet = new Wallet(walletMnemonic);
wallet = wallet.connect(provider);

// alternatively instead of the above, you can instantiate with a private key
// const privKey = "<privateKey>";
// let wallet = new Wallet(privKey);

const main = async () => {
  // you need an instance of ethers.Signer here
  const renft = new ReNFT(wallet);

  // address of the nft contract you are lending
  const E721_ADDR = ['0xCDf60B46Fa88e74DE7e1e613325E386BFe8609ad'];
  // tokenID of the NFT you are lending
  const E721_TOKENID = [BigNumber.from('3')];
  // in the case of 721 this is ignored, since it will always be 1. However, very useful for semi-fungible 1155s
  const lendAmount = [1];
  // maximum number of days anyone will be able to rent your NFT for
  const maxRentDuration = [1];
  // in the scale of the payment token. This means 1.1 WETH per day payment to rent the NFT out
  const dailyRentPrice = [1.1];
  // if the renter does not return your NFT, this is how much you will get back, i.e. 2.2 WETH
  const nftPrice = [2.2];
  const paymentToken = [PaymentToken.WETH];

  const txn = await renft.lend(
    E721_ADDR,
    E721_TOKENID,
    lendAmount,
    maxRentDuration,
    dailyRentPrice,
    nftPrice,
    paymentToken
  );

  const receipt = await txn.wait();
  return receipt;
};

main()
  .then(receipt => {
    console.log(receipt);
  })
  .catch(e => {
    console.warn(e);
  });

For more usage examples, see test/utils.test.ts