🚀 Web5js SDK – Your Gateway to Blockchain

The Web5js SDK is a comprehensive TypeScript/JavaScript library designed to simplify blockchain application development. Whether you're monitoring blockchain addresses, making RPC calls, managing NFTs, or querying wallet balances and transactions, Web5js SDK streamlines the process with its robust features:

• 🕵️‍♂️ Blockchain Monitoring: Easily track activities on any blockchain address.
• 📞 RPC Calls Simplified: Interact with various blockchains through simplified RPC calls.
• 🖼️ NFT Insights: Access detailed information on NFT balances, transactions, and ownership.
• 💰 Wallet Intelligence: Get precise data on wallet balances and transaction history.

Tailored for Developers

Engineered with a developer-first approach, Web5js SDK accelerates your blockchain application development, regardless of your experience level. Explore our Documentation and Getting Started Guide to jumpstart your projects:

• Super fast development: Start building blockchain applications in no time.
• No previous blockchain experience required: Perfect for beginners and experts alike.
• One line of code: Perform complex tasks with minimal effort.

Need help or want to contribute? Report Bugs, join our community, or collaborate on improvements.

🔌 Perform Native RPC Calls

Interact seamlessly with various blockchains through native RPC calls. Say goodbye to the hassle of juggling separate RPC clients for each blockchain.

| Documentation | | --------------------------------------------------------------------------------------------------------- | | EVM Blockchains | | Ethereum RPC | | Polygon RPC | | Flare RPC | | Haqq RPC | | Optimism RPC | | Horizen EON RPC | | Arbitrum One RPC | | Chiliz RPC | | Ethereum Classic RPC | | Klaytn RPC | | Avalanche RPC | | Celo RPC | | XinFin RPC | | UTXO Blockchains | | Bitcoin RPC | | Litecoin RPC | | Dogecoin RPC | | ZCash RPC | | Bitcoin Cash RPC | | Other Blockchains | | Solana RPC | | XPR RPC | | Tron RPC | | Eos RPC | | Tezos RPC | | Agorand RPC | | Cardano RPC | | Stellar RPC |

🔔 Create Notifications

Effortlessly monitor wallet activities. Set up real-time notifications for events like:

| Documentation | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | Start monitoring of the address | | Stop monitoring of the address | | Get all sent notifications | | Get all existing monitoring subscriptions |

👛 Access Wallet Information

Through a single interface, obtain crucial wallet details such as balances, transaction history, and other pertinent information.

| Documentation | | ----------------------------------------------------------------------------------------------------------------------------- | | Get all assets the wallet holds | | Get all transactions on the wallet |

🖼️ NFT Actions

Dive into a comprehensive suite of actions related to non-fungible tokens (NFTs).

| Documentation | | ------------------------------------------------------------------------------------------------------------------ | | Get all NFTs the wallet holds | | Get all NFTs in the NFT collection | | Trace the history of a specific NFT | | Show the NFT history of a wallet | | Create NFT Collection | | Create MultiToken NFT Collection | | Retrieve the owner of the NFT | | Check if the wallet owns a specific NFT | | Get the metadata of a specific NFT |

🪙 Fungible Tokens

Explore the world of fungible tokens, manage their properties, and track your assets seamlessly.

| Documentation | | ------------------------------------------------------------------------------------------------------------------------------- | | Get all fungible tokens the wallet holds | | Show fungible token history of a wallet | | Get metadata of a fungible token | | Create a fungible token |

📁 IPFS

Enables you as a developer to use IPFS to store and retrieve your media.

| Documentation | | ------------------------------------------------------------------ | | Upload file to IPFS |

⛽ Fee Estimation

Stay updated with real-time fee insights and ensure smooth transactions without overpaying.

| Documentation | | ----------------------------------------------------------------------------------- | | Fetch real-time fee data |

💻 Wallet Provider

Integrate, transact, and manage assets using a secure and user-friendly wallet provider interface.

| Documentation | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Connect a wallet | | Transfer native assets | | Transfer your NFT | | Create your NFT Collection | | Create your Fungible Token | | Create your NFT (ERC-1155 MultiToken) Collection | | Transfer fungible tokens like USDT | | Approve the transfer of a fungible token like USDT | | Build your own custom transaction |

💲 Exchange Rates

Access the latest crypto exchange rates and supported currency information to stay ahead in the market.

| Documentation | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | Get current exchange rate of the crypto asset | | Get current rates for multiple crypto assets at once | | Supported Crypto Currencies | | Supported Fiats |

📘 Getting Started with Web5jsSDK

This guide will lead you step by step, from basic setup and installation to harnessing the immense capabilities of our library. For a detailed walkthrough, check out the Getting Started page.

📊 Web5jsSDK Dashboard

Experience powerful insights into your application's usage with the Web5js Dashboard. It provides real-time analytics, user engagement metrics, and an intuitive interface, seamlessly integrating with Web5jsSDK for optimal app monitoring.

🌱 Always Evolving

Our library is on a continuous journey of growth. We regularly add new features and extend support for more blockchains. It's the go-to choice for developers aiming to craft robust, scalable, and efficient blockchain apps without the overwhelming intricacies of diverse blockchain protocols.

Prerequisites

Before diving into Web5jsSDK, ensure that you have the following prerequisites installed:

• Node.js: Ensure you have the latest LTS version installed.
• npm: npm is bundled with Node.js, so installing Node.js should automatically install npm.

Installation

To install Web5jsSDK, simply run the following command in your terminal or command prompt:

Install using npm

npm install @web5nexus/web5js

Install using yarn

yarn add @web5nexus/web5js

Install using pnpm

pnpm install @web5nexus/web5js

Getting started

Basic Usage

Here's a brief overview of how to utilize Web5jsSDK for RPC calls and subscribing to notifications.

Initialization

Start by importing the Web5jsSDK library and initializing Ethereum client as follows:

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Get started documentation.

RPC Calls

To make RPC calls, use the available methods to interact with Ethereum blockchain. For example, to fetch the balance of a specific Ethereum address:

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })

const { result } = await web5js.rpc.getBalance('0x742d35Cc6634C0532925a3b844Bc454e4438f44e')
console.log(`Balance: ${result}`)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the RPC documentation.

Subscribing to Notifications

To subscribe to notifications for events related to a specified Ethereum address, choose a type of event you want to be notified about. We are going to use addressEvent as an example, which sends you notification about any transfer on the address - native ones, ERC20 tokens or NFTs. To subscribe to this event, use the following code:

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })

const response = await web5js.notification.subscribe.addressEvent({
  url: 'https://<YOUR_WEBHOOK_URL>',
  address: '0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990',
})

console.log(response)
// 🎉  Now your address is subscribed for any events!

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Notifications documentation.

Get NFT balance of a wallet

Using Web5jsSDK, obtain the NFT balance of an address by calling the getNFTBalance method within the NFT submodule and passing the target address as an argument. This streamlined process efficiently retrieves the total number of NFTs owned by the specified address. To achieve this, use the following code:

import { Web5jsSDK, Network, Ethereum, NftAddressBalance } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })

const balances: NftAddressBalance[] = await web5js.nft.getBalance({
  addresses: ['0x53e8577c4347c365e4e0da5b57a589cb6f2ab849'],
})

console.log(balances)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the NFTs documentation.

Connect to MetaMask and send transaction

Using Web5jsSDK, it's possible to connect your browser application to MetaMask and perform transactions using it. To achieve this, use the following code:

import { Web5jsSDK, Network, Ethereum, MetaMask } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })

const account: string = await web5js.walletProvider.use(MetaMask).getWallet()
const txId: string = await web5js.walletProvider
  .use(MetaMask)
  .transferNative('0x53e8577C4347C365E4e0DA5B57A589cB6f2AB848', '1')

console.log(txId)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Wallet Provider documentation.

Get exchange rates

Using Web5jsSDK, obtain current fiat/crypto exchange rates To achieve this, use the following code:

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })

const res = await web5js.rates.getCurrentRate('BTC', 'EUR')

console.log(res.data)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Exchange Rates documentation.

Get current fees

Using Web5jsSDK, you can obtain recommended fee/gas price for a blockchain.

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({
  network: Network.ETHEREUM_SEPOLIA,
  verbose: true,
  retryDelay: 1000,
  retryCount: 2,
  version: ApiVersion.V3,
})

const result = await web5js.fee.getCurrentFee()

console.log(result.data)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Fee Estimation documentation.

Get token balance

Using Web5jsSDK, obtain all fungible token balances of an address by calling the getBalance method within the token submodule and passing the target address as an argument. This streamlined process efficiently retrieves all balances for fungible tokens that specified address holds. To achieve this, use the following code:

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM_SEPOLIA })

const { data: balances } = await web5js.token.getBalance({
  addresses: ['0x2cbaf358c0af93096bd820ce57c26f0b7c6ec7ab'],
})

console.log(balances)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Fungible Tokens documentation.

Get all transactions on the wallet

Using Web5jsSDK, you can obtain transaction history of the wallet.

import { Web5jsSDK, Network, Ethereum } from '@web5nexus/web5js'

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM_SEPOLIA })

const { data: txs } = await web5js.address.getTransactions({
  address: '0x514d547c8ac8ccbec29b5144810454bd7d3625ca',
})

console.log(txs)

// Destroy Web5js SDK - needed for stopping background jobs
await web5js.destroy()

For more details, check out the Wallet address operations documentation.

RPC calls

All RPC calls are implemented in the web5js.rpc.* submodule.

See the RPC API Reference for more about supported chains and methods.

Distinguishing Between Archive and Full Nodes

When interacting with the blockchain, it's essential to know whether a JSON RPC call requires an archive node or can be serviced by a full node. The distinction hinges on the type of data requested and the historical depth of that data. Here's a breakdown of the conditions under which a call is classified for an archive or a full node:

Archive Node Calls

Archive nodes store the entire history of the blockchain, including the state of all accounts at every block. Calls that require an archive node typically involve querying historical states. Conditions include:

1. Calls to Methods getCode or call: Always require an archive node because they may query the state at any block height.

2. Calls Including debug or trace Methods: These methods require historical data not available on full nodes.

3. Parameters Indicating a Specific Block Number: For following methods, if the call specifies a block number, it requires an archive node. This includes:

• getStorageAt with a specific block number.
• getBalance with a specific block number.
• getBlockByNumber when a block number is specified.
• getLogs calls where fromBlock or toBlock specify a block number other than the latest.

Full Node Calls

Any other calls not meeting the conditions for archive node calls can be serviced by a full node. These calls typically involve querying the current state of the blockchain.

Load Balancer

Load balancer is used managing RPC calls to nodes in a blockchain network. It maintains a list of available nodes and their status, and it automatically selects the most responsive node for subsequent RPC calls.

For use of the Load Balancer, you don't need to know how it is working!. Load Balancer works automatically in the background and selects the most responsive node for subsequent RPC calls. You can use the SDK without any knowledge of the Load Balancer.

Load Balancer implementation is available in LoadBalancerRpc.ts

Using a load balancer to distribute traffic across multiple nodes, as opposed to routing all traffic to a single node, has several advantages:

• Improved Performance and Responsiveness: Load balancers can distribute network or application traffic across several servers, which can help prevent any single server from becoming a bottleneck. As a result, users often experience faster response times.

• Scalability: Load balancers enable you to handle larger amounts of traffic by simply adding more servers to the pool. This makes it easier to scale your infrastructure as your needs grow.

• Redundancy and High Availability: If a server goes down, a load balancer can automatically reroute traffic to the remaining online servers. This ensures that your service remains available even in the face of hardware failures or other issues.

• Prevents Overloading of Nodes: Load balancers can prevent any single server from being overloaded with too many requests, which can degrade the performance of the server and impact user experience.

• Efficient Use of Resources: By distributing the load, you can make sure that all your servers are being used efficiently, rather than having some servers idle while others are overloaded.

• Flexibility and Maintenance: With a load balancer, you can take servers offline for maintenance without disrupting service. The load balancer will simply stop sending traffic to the offline server.

• Better User Experience: Ultimately, all of these benefits can lead to a better user experience, with faster response times and higher availability of services.

Initialization

At start the Load Balancer is initialized with a list of nodes. List of nodes are dynamically fetched from the remote server. There is also option to pass your custom list of nodes instead of the dynamic list. From the list of the nodes is randomly selected one node as a primary node, which is kept as a primary node until first load balancing is performed. The Load Balancer maintain lists of two types of nodes, normal and archive nodes.

Load Balancing

The load balancing process is running in the background and every minute it checks the status of all nodes in the list. The status of each node is determined by making a request to the node's URL and checking the response. The fastest responding node in each category is then selected as the active node for that normal and archive category. The selected nodes are then used for subsequent RPC calls.

Error Handling

If a RPC call fails, failure is logged, and the current active node is marked as failed, and load balancer selects a new active node.

Destroy

When you need to stop load balancer, you should can call destroy method. This method stops the load balancing process on the background.

Usage

Default config

const web5js = await Web5jsSDK.init<Ethereum>({ network: Network.ETHEREUM })
const info = await web5js.rpc.chainId()
web5js.rpc.destroy()

Custom RPC node list

const web5js = await Web5jsSDK.init<Ethereum>({
  network: Network.ETHEREUM,
  rpc: {
    nodes: [
      {
        url: 'https://web5jsapi.web5.nexus/v3/blockchain/node/ethereum-mainnet',
        type: RpcNodeType.NORMAL,
      },
    ],
    allowedBlocksBehind: 20,
    oneTimeLoadBalancing: false,
  },
})
const info = await web5js.rpc.chainId()
web5js.rpc.destroy()

Documentation

• Documentation and Guides to get started with Web5js SDK
• Documentation section for more details.

🌐 Extension Ecosystem

Wallet Providers

Web5js SDK supports wallet provider extensions for various wallets. You can use them to integrate your application with the wallet of your choice.

import { Web5jsSDK, Ethereum, Network, ApiVersion } from '@web5nexus/web5js'
import { EvmWalletProvider } from '@web5nexus/evm-wallet-provider'

const web5jsSdk = await Web5jsSDK.init<Ethereum>({
  network: Network.ETHEREUM_SEPOLIA,
  configureWalletProviders: [EvmWalletProvider],
})

Usage for wallet providers is similar to the extensions.

await web5jsSdk.walletProvider.use(EvmWalletProvider).getWallet()

🔍 Check out our built-in MetaMask wallet provider

📚 Learn more about Web5js SDK Extension ecosystem here - Web5js SDK Extensions

🤝 Contributing

We appreciate your interest in contributing to the Web5js SDK. Here's a guide to help you make meaningful contributions:

Local Testing

Before making a pull request, ensure you've thoroughly tested your changes with a local client.

Unit Tests

Include unit test coverage for any new code you're adding. This helps in maintaining the quality and reliability of our SDK.

Update the Changelog

For every contribution, it's essential to document your changes in the changelog. The changelog keeps track of all the changes, updates, and fixes we make to our SDK. Use the provided format:

## [Version Number] - YYYY.MM.DD

### Added/Updated/Fixed/Changed

- Description of the change

For instance:

## [3.0.10] - 2023.08.11

### Added

- New feature XYZ

Update package.json

Before creating a pull request or releasing a new version, ensure the version in package.json is updated to reflect the new release number.

Release Consideration

Your changes will be released after merging the pull request.

How to add support for new RPC chain

• Add new chain to the Network.ts enum (Check also LOAD_BALANCER_NETWORKS constants)
• Add new class to the web5js.ts file
• Add new chain getClient method in the Utils.ts file
• Add new chain CURRENCY_NAMES and DECIMALS constants in the constants.ts file
• Update README.md with new chain for status page and list.json
• Add E2E test

🙌 Thank you for helping make Web5js SDK better! Your contributions play a crucial role in its continuous improvement and growth.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.