@white-matrix/blindbox-sdk

SDK Package

• SDK Package
• Install
• Browser with Metamask
• Node with Ethers Provider
• API Reference:
  • Interface
    • RiverBox Interface
  • MockClient Example
• SDK-Package:
  • Build:
  • Test:
  • Publish:

Install

yarn add blindbox-sdk
yarn upgrade blindbox-sdk

Browser with Metamask

import React from "react";
import logo from "./logo.svg";
import "./App.css";
import { BigNumber, ethers, Signer } from "ethers";
import { Web3Provider } from "@ethersproject/providers";
import detectEthereumProvider from "@metamask/detect-provider";
import {
  riverBoxProvider,
  RiverBoxClient,
  ContractBuyResult,
  ContractFuseResult,
  ContractTokenDetail,
  ContractDealDetail,
  DeploymentInfo,
  Network
} from "blindbox-sdk";

const RIVERBOX_CONTRACT_ADDRESS = DeploymentInfo[Network.bscTest].riverBox.address;
function App() {
  const [sym, setSym] = React.useState("");
  // eslint-disable-next-line react-hooks/exhaustive-deps
  React.useEffect(() => {
    const fetchSym = async () => {
      const winProvider: any = await detectEthereumProvider();
      if (winProvider) {
        const provider: Web3Provider = new ethers.providers.Web3Provider(
          winProvider as any
        );

        // onchain client
        const client: RiverBoxClient = riverBoxProvider(false);

        // call read only methods
        client.connectProvider(RIVERBOX_CONTRACT_ADDRESS, provider);

        try {
          console.log(await provider.getSigner().getAddress());
        } catch (error) {
          // throw error when no account is connected
          console.log(error);
        }

        try {
          const sym = (await client.symbol()) + (await client.totalSupply());
          setSym(sym);
          console.log(sym);
        } catch (error) {
          console.log(error);
        }

        //  sand transaction requires a void signer
        client.setWaitConfirmations(1); // set number of confirmations to wait default is 5 blocks
        await winProvider.request({ method: "eth_requestAccounts" }); // metamask API - ask for connecting an account

        console.log(await provider.getSigner().getAddress());
        const signer: Signer = provider.getSigner();

        try {
          const currentPrice = await client.connectSigner(signer).boxPrice();
          console.log("currentPrice:", currentPrice.toString(), "wei");
          // without referrer
          let ret: ContractBuyResult = await client
            .connectSigner(signer)
            .buy(BigNumber.from(2), undefined, { value: currentPrice.mul(2) });
          console.log(ret);

          // with referrer account address
          ret = await client
            .connectSigner(signer)
            .buy(BigNumber.from(10), await signer.getAddress(), { value: currentPrice.mul(10) });
          console.log(ret);

          const currentPaidBoxes = await client
            .connectSigner(signer)
            .paidBoxes(await signer.getAddress());
          console.log("currentPaidBoxes:", currentPaidBoxes.toString());

          // debugMint, MINT PAWN Token Only!!!!
          const debugTokenId = await client.connectSigner(signer).debugMint(BigNumber.from(10), await signer.getAddress());
          console.log(await client.tokenDetail(debugTokenId));

          // post a deal
          const tokenId = ret.newTokenIds[0];
          console.log(postDealResult);
        } catch (error) {
          console.log(error);
        }
      }
    };
    fetchSym();
  }, []);
  return (
    <div className="App">
      <header className="App-header">
        <img src={logo} className="App-logo" alt="logo" />
        <p>
          Edit <code>src/App.tsx</code> and save to reload.
        </p>
        <a
          className="App-link"
          href="https://reactjs.org"
          target="_blank"
          rel="noopener noreferrer"
        >
          Learn React {sym}
        </a>
      </header>
    </div>
  );
}

export default App;

Node with Ethers Provider

JsonRpcProvider or WebSocketProvider or APIProviders: Use low-level etherjs contract interface directly

import {
  RiverBox,
  RiverBox__factory,
  DeploymentInfo,
  Network
} from "blindbox-sdk";
import { JsonRpcProvider } from "@ethersproject/providers";
import { ethers, Signer, Wallet } from "ethers";

const RIVERBOX_CONTRACT_ADDRESS = DeploymentInfo[Network.bscTest].riverBox.address;

const PRIVATE_KEY =
  "c1c9223e46ba4b7e3c5bc221fa92cba079999f853d6fb683b95579007fd8c873";

const provider: JsonRpcProvider = new ethers.providers.JsonRpcProvider(
  "https://data-seed-prebsc-1-s1.binance.org:8545/"
);
const signer: Wallet = new Wallet(PRIVATE_KEY).connect(provider);

async function main() {
  const riverBox: RiverBox = RiverBox__factory.connect(
    RIVERBOX_CONTRACT_ADDRESS,
    signer
  );
  console.log(`total balance ${await riverBox.totalSupply()}`);
}
main();

API Reference:

Interface

RiverBox Interface

riverbox-client.ts

export interface RiverBoxClient extends ERC721Client {
  connectProvider(address: string, provider: Provider): RiverBoxClient;

  connectSigner(signer: Signer): RiverBoxClient;

  /* Backup interface
   * @return RiverBox typechain interface for RiverBox contract
   */
  riverBoxContract?(): Promise<RiverBoxImpl>;

  /*======== RiverBox specific ======*/

  /* view */
  /**
   * Check current stock
   */
  stock(config?: PayableOverrides): Promise<BigNumber>;

  /**
   * Return on current box price
   */
  boxPrice(config?: PayableOverrides): Promise<BigNumber>;
  /* view */

  /**
   * Return on chain item detail information
   * @param tokenId
   * @param config ethers PayableOverrides
   * @returns produceDetail on chain item detail data structure
   */
  tokenDetail(
    tokenId: BigNumber,
    config?: PayableOverrides
  ): Promise<RiverBoxTokenDetail>;

  /**
   * Fetch number of paid boxes
   * @param address
   * @return number of paid boxes
   */
  paidBoxes(account: string, config?: PayableOverrides): Promise<BigNumber>;

  /**
   * Fetch number of claimable amount
   * @param address
   * @return number of claimable amount
   */
  claimableAmount(
    account: string,
    config?: PayableOverrides
  ): Promise<BigNumber>;

  /* transactions */

  /**
   * Buy N boxes (N <= 10 for current setup)
   * @param quality number of boxes, will trigger Web3Provider to send transaction in browser
   * @param referrer account address, empty for address(0) in default
   * @param config ethers PayableOverrides
   * @return BuyResult including transactionHash and a list of awarded tokenIds
   */
  buy(
    quality: BigNumber,
    referrer?: string,
    config?: PayableOverrides
  ): Promise<ContractBuyResult>;

  /**
   * Claim N boxes (N <= 10 for current setup)
   * @param amount number of boxes, will trigger Web3Provider to send transaction in browser
   * @param config ethers PayableOverrides
   * @return BuyResult including transactionHash and a list of awarded tokenIds
   */
  claim(
    amount?: BigNumber,
    config?: PayableOverrides
  ): Promise<ContractBuyResult>;

  tokenOfOwnerByIndex(
    owner: string,
    index: BigNumber,
    config?: PayableOverrides
  ): Promise<BigNumber>;
  totalSupply(config?: PayableOverrides): Promise<BigNumber>;
  tokenByIndex(index: BigNumber, config?: PayableOverrides): Promise<BigNumber>;
}

export interface RivermenScrollsClient extends ERC721Client {
  connectProvider(address: string, provider: Provider): RivermenScrollsClient;

  connectSigner(signer: Signer): RivermenScrollsClient;

  /* Backup interface
   * @return RiverBox typechain interface for RiverBox contract
   */
  riverBoxContract?(): Promise<RiverBoxImpl>;

  /**
   * Verify if a given list of tokenId can be used to fuse a new item
   * @param tokenIds list of tokenId
   * @param config ethers PayableOverrides
   * @return boolean
   */
  verifyFusion(
    tokenIds: BigNumber[],
    isPawn: boolean,
    config?: PayableOverrides
  ): Promise<boolean>;

  /**
   * Return on chain item detail information
   * @param tokenId
   * @param config ethers PayableOverrides
   * @returns produceDetail on chain item detail data structure
   */
  tokenDetail(
    tokenId: BigNumber,
    config?: PayableOverrides
  ): Promise<RivermenScrollsTokenDetail>;

  fusionCount(
    tokenId: BigNumber,
    isPawn: boolean,
    config?: PayableOverrides
  ): Promise<BigNumber>;

  /**
   * Fuse a set of items
   * @param tokenIds a list of tokenId
   * @param config ethers PayableOverrides
   * @return FuseResult including transactionHash and tokenId of new fused item
   */
  fuse(
    tokenIds: BigNumber[],
    isPawn: boolean,
    config?: PayableOverrides
  ): Promise<ContractFuseResult>;

  tokenOfOwnerByIndex(
    owner: string,
    index: BigNumber,
    config?: PayableOverrides
  ): Promise<BigNumber>;
  totalSupply(config?: PayableOverrides): Promise<BigNumber>;
  tokenByIndex(index: BigNumber, config?: PayableOverrides): Promise<BigNumber>;
}

export interface ERC721Client {
  connectProvider(address: string, provider: Provider): ERC721Client;

  connectSigner(signer: Signer): ERC721Client;

  setWaitConfirmations(num: number): void;

  /*======== ERC721 standard API ======*/
  /* Refer to https://docs.openzeppelin.com/contracts/3.x/api/token/erc721#ERC721 */
  /* view function */
  balanceOf(owner: string, config?: PayableOverrides): Promise<BigNumber>;
  ownerOf(tokenId: BigNumber, config?: PayableOverrides): Promise<string>;
  name(config?: PayableOverrides): Promise<string>;
  symbol(config?: PayableOverrides): Promise<string>;
  tokenURI(tokenId: BigNumber, config?: PayableOverrides): Promise<string>;
  transferFrom(
    from: string,
    to: string,
    tokenId: BigNumber,
    config?: PayableOverrides
  ): Promise<string>;
}

export interface ContractInfo {
  address: string;
  version: string;
  impl: string;
}

export interface Deployment {
  riverBox: ContractInfo;
  riverBoxRandom: ContractInfo;
  riverMenArt: ContractInfo;
  rivermenScrolls: ContractInfo;
}

export enum Network {
  localhost = 'localhost',
  bscTest = 'bscTest',
  bscMain = 'bscMain',
  rinkeby = 'rinkeby',
  mainnet = 'mainnet',
  whitematrix = 'whitematrix'
}

MockClient Example

Usage - (MockClient (sdk-mock.spec.ts) output shown by test console output)

(base) ➜  sdk git:(main) ✗ yarn run test
yarn run v1.22.10
$ mocha


  RiverBox
    view functions
====================================
{
  locationId: BigNumber { _hex: '0x01', _isBigNumber: true },
  signature: '1111111111111',
  creationTime: BigNumber { _hex: '0x0179c141fdd4', _isBigNumber: true },
  fused: BigNumber { _hex: '0x00', _isBigNumber: true },
  parts: []
}
      ✓ test: tokenDetails(BigNumber.from(0))
====================================
Mock client: ids.length <= 1 -> false, ids.length > 1 -> true
false
      ✓ test: verifyFusion([BigNumber.from(0)])
====================================
Mock client: ids.length <= 1 -> false, ids.length > 1 -> true
true
      ✓ test: verifyFusion([BigNumber.from(0), BigNumber.from(1)])
====================================
[
  BigNumber { _hex: '0x64', _isBigNumber: true },
  BigNumber { _hex: '0x65', _isBigNumber: true },
  BigNumber { _hex: '0x66', _isBigNumber: true },
  BigNumber { _hex: '0x67', _isBigNumber: true },
  BigNumber { _hex: '0x68', _isBigNumber: true }
]
      ✓ test: client.tokenOfIndexPagination(BigNumber.from(0), BigNumber.from(5))
====================================
BigNumber { _hex: '0x64', _isBigNumber: true }
      ✓ test: client.balanceOf(FAKE_ACCOUNT)
====================================
0x000000000000000000000000000000000000000000
      ✓ test: client.ownerOf(BigNumber.from(0))
====================================
RiverBox
      ✓ test: client.name()
====================================
RB
      ✓ test: client.symbol()
====================================
http://metadata.resolve/0
      ✓ test: client.tokenURI(BigNumber.from(0))
====================================
BigNumber { _hex: '0x6e', _isBigNumber: true }
      ✓ test: client.tokenOfOwnerByIndex(FAKE_ACCOUNT, BigNumber.from(10))
====================================
BigNumber { _hex: '0x64', _isBigNumber: true }
      ✓ test: client.totalSupply()
====================================
BigNumber { _hex: '0x6e', _isBigNumber: true }
      ✓ test: client.tokenByIndex(BigNumber.from(10))
====================================
      ✓ clean up
    transactions
====================================
{
  transactionHash: '0x1111111111111111111111111111111111111111111111111111111111111111',
  newTokenIds: [
    BigNumber { _hex: '0xc8', _isBigNumber: true },
    BigNumber { _hex: '0xc9', _isBigNumber: true },
    BigNumber { _hex: '0xca', _isBigNumber: true }
  ]
}
      ✓ test: buy(BigNumber.from(3))
====================================
{
  transactionHash: '0x1111111111111111111111111111111111111111111111111111111111111111',
  newTokenId: BigNumber { _hex: '0xcb', _isBigNumber: true }
}
      ✓ test: fuse([BigNumber.from(0), BigNumber.from(1)])
====================================
      ✓ clean up

SDK-Package:

Build:

yarn run build

Test:

Start local hardhat node first and deploy the contract

CONTRACT_ADDRESS={ADDRESS} yarn run test

Publish:

Recommend to use yarn's publish command to publish the pacakge

yarn publish