@two-point-five/web3-sdk

Web3 SDK

This is an official 2p5 Web3 SDK for connecting to blockchain networks.

Table of Contents

• Web3 SDK
• Table of Contents
  • Prerequisite
  • How to setup
  • What's inside?
    • Apps and Packages
      • Apps
      • Packages
    • Utilities
    • Build
    • Develop
    • Remote Caching
  • Useful Links
• How to use
  • With Web3.js

Prerequisite

• NodeJS 18
• 2p5 Wallet

How to setup

• Run npm install

What's inside?

This turborepo uses npm as a package manager. It includes the following packages/apps:

Apps and Packages

Apps

• docs: a Next.js app for creating web3-sdk documentation.
• example-election: another Next.js app for experimenting web3-sdk package.
• example-smartcontract: a Hardhat project for contract development in example-election project.

Packages

• ~web3-sdk: Main Package.
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd web3-sdk
npm run build

Develop

To develop all apps and packages, run the following command:

cd web3-sdk
npm run dev

if you want to test the package, you should start the project 2p5 Wallet first. and make sure the variable TPF_BASEURL_DEVELOPMENT in file packages/~web3-sdk/src/modules/widgets/WidgetManager.ts is same as the url in 2p5 Wallet project that you start before.

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

npx turbo link

Useful Links

Learn more about the power of Turborepo:

• Pipelines
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage

How to use

With Web3.js

import Web3 from 'web3';
import TPFWeb, { withTPFProvider } from '@two-point-five/web3-sdk';

function initiateWeb3() {
  /**
   * string `test` is your dApp ID, but we haven't implemented it for now, so just fill it freely
   * string `goerli` is blockchain network. we have: "mainnet" | "goerli" | "sandbox2p5". choose one.
   * */
  const tpf = new TPFWeb('test', 'goerli', {
    environment: 'staging'
  });

  // pass the provider into Web3 instance
  const web3 = new Web3(tpf.provider);
  web3.eth.handleRevert = true;
  return web3;
}

/** example to get public address and balance */
async function getAccounts() {
  const web3 = initiateWeb3();
  try {
    const accounts = await web3.eth.getAccounts();
    const balance = await web3.eth.getBalance(accounts[0]);
    console.log({ accounts, balance });
  } catch (err) {
    console.error({ err });
  }
}
/**
 * of course, you can use `web3` instance like usual.
 * @see: https://web3js.readthedocs.io/en/v1.10.0/web3.html#example-local-geth-node
*/

// get TPF Provider
const provider = withTPFProvider(web3.currentProvider)
console.log(provider.isWalletConnected());
console.log(provider.getAccessToken());