Web Libraries

EthersV5

The ethers.js library is a comprehensive and concise library for engaging with the Ethereum Blockchain and its surrounding ecosystem.

Available on:

Works on All SKALE Chains

Some of the main features are:

• Import and export JSON wallets (Geth, Parity and crowdsale)
• Import and export BIP 39 mnemonic phrases (12 word backup phrases) and HD Wallets
• Meta-classes create JavaScript objects from any contract ABI, including ABIv2 and Human-Readable ABI Connect to Ethereum nodes over JSON-RPC, INFURA, Etherscan, Alchemy or Metamask

Implementation Example

1. Package Install

   npm

   npm install ethers@5.7.2

   yarn

   yarn add ethers@5.7.2

2. Contract Call

   import { ethers, BigNumber } from 'ethers';
   import { abi } from "./contract";
   import { chains } from "./chains"
   import dotenv from 'dotenv';
   dotenv.config();
   
   //Select the SKALE chain you want to use
   const selectedChain = chains.nebula;
   
   const provider = new ethers.providers.JsonRpcProvider(selectedChain.chainInfo.testnet.rpcUrl);
   
   const pk = process.env.PRIVATE_KEY || "";
   const signer = new ethers.Wallet(pk, provider);
   
   const contract = new ethers.Contract(selectedChain.chainInfo.testnet.contracts[0].address, abi, signer);
   
   // Send transaction to smart contract to update message
   async function ContractSendTx() {
       const data = await contract.populateTransaction.mintTest(signer.address);
       data.gasLimit = BigNumber.from(100000);
       data.gasPrice = BigNumber.from(100000);
       data.nonce = await provider.getTransactionCount(signer.address);
   
       const approveTxSigned = await signer.signTransaction(data);
       const submittedTx = await provider.sendTransaction(approveTxSigned);
       const approveReceipt = await submittedTx.wait();
       console.log(approveReceipt.transactionHash);
   }

Additional EthersV5 Documentation

Click here for the official documentation.

EthersV6

The ethers.js library is a comprehensive and concise library for engaging with the Ethereum Blockchain and its surrounding ecosystem.

Available on:

Works on All SKALE Chains

Some of the main features are:

• Import and export JSON wallets (Geth, Parity and crowdsale)
• Import and export BIP 39 mnemonic phrases (12 word backup phrases) and HD Wallets
• Meta-classes create JavaScript objects from any contract ABI, including ABIv2 and Human-Readable ABI Connect to Ethereum nodes over JSON-RPC, INFURA, Etherscan, Alchemy or Metamask

The biggest difference between v5 and v6 is in the use of modern ES6 features. The major changes can been seen on:

• BigNumbers
• Contracts
• Importing
• Providers
• Signatures
• Transactions
• Utilities
• Removed Items

Implementation Example

1. Package Install

   npm

   npm install ethers

   yarn

   yarn add ethers

2. Contract Call

   import { ethers } from 'ethers';
   import { abi } from "./contract";
   import { chains } from "./chains"
   import dotenv from 'dotenv';
   dotenv.config();
   
   //Select which SKALE chain you want to use
   const selectedChain = chains.nebula;
   
   const provider = new ethers.JsonRpcProvider(selectedChain.chainInfo.testnet.rpcUrl);
   
   const pk = process.env.PRIVATE_KEY || "";
   const signer = new ethers.Wallet(pk, provider);
   
   const contract = new ethers.Contract(selectedChain.chainInfo.testnet.contracts[0].address, abi, signer);
   
   // Send transaction to smart contract to update message
   async function ContractSendTx() {
   
       const request = await contract.mintTest.populateTransaction(signer.address);
       const tx = await signer.sendTransaction(request);
       const receipt = await tx.wait();
   
       console.log(receipt);
   
   }

Additional EthersV6 Documentation

Click here for the official documentation.

Web3.js

Set of Javascript libraries enabling interaction with a local or remote Ethereum node through HTTP, IPC, or WebSocket protocols.

Available on:

Works on All SKALE Chains

Some of the features are:

• Complete implementation of Ethereum’s JSON-RPC client API over HTTP and IPC
• Create accounts, process and sign transactions.
• Get block and state information from Ethereum nodes.

Implementation Example

1. Package install

   npm

   npm install web3

   yarn

   yarn add web3

2. Contract Call

   import Web3 from "web3";
   import { abi } from "./contract";
   import { chains } from "./chains"
   import dotenv from 'dotenv';
   dotenv.config();
   
   //Select which SKALE chain to use
   const selectedChain = chains.nebula;
   
   var web3 = new Web3(selectedChain.chainInfo.testnet.rpcUrl);
   
   const pk = process.env.PRIVATE_KEY || "";
   
   const accountAddress = web3.eth.accounts.privateKeyToAccount(`0x${pk}`)
   
   const contract = new web3.eth.Contract(abi, selectedChain.chainInfo.testnet.contracts[0].address);
   
   const functionData = contract.methods.mintTest(accountAddress.address).encodeABI();
   
   // Send transaction to smart contract to update message
   async function ContractSendTx() {
       web3.eth.accounts.signTransaction(
           {
             from: accountAddress.address,
             to: contract_address,
             gas: 100000,
             gasPrice: 100000,
             data: functionData,
           },
           pk)
           .then((signedTransaction) => {
             return web3.eth.sendSignedTransaction(signedTransaction.rawTransaction || "");
           })
           .then((receipt) => {
             console.log("Transaction receipt:", receipt);
           })
           .catch((error) => {
             console.error("Error sending transaction:", error);
           });
   }

Additional Web3.js Documentation

Click here for the official documentation.

Viem

Viem is a TypeScript interface for Ethereum that provides low-level stateless primitives for interacting with Ethereum.

Available on:

Works on All SKALE Chains

Some of the main features are:

• Abstractions over the JSON-RPC API
• APIs for interacting with Smart Contracts
• Utilities for working with ABIs

Implementation Example

1. Package Install

   npm

   npm install viem

   yarn

   yarn add viem

2. Contract Call

   import { createWalletClient , custom , http , createPublicClient } from 'viem'
   import { privateKeyToAccount } from 'viem/accounts'
   import { skaleNebulaTestnet } from "viem/chains";
   import { abi } from "./contract";
   import dotenv from 'dotenv';
   dotenv.config();
   
   const publicClient = createPublicClient({
       chain: skaleNebulaTestnet,
       transport: http()
     })
   
   const pk = process.env.PRIVATE_KEY || "";
   const account = privateKeyToAccount(`0x${pk}`);
   
   //Place here the contract address you deployed
   const contract_address = "0x4487AF7f18044A99927e81CC628F558F3D091419";
   
   const walletClient = createWalletClient({
       chain: skaleNebulaTestnet,
       transport: http(),
     })
   
   
   // Send transaction to smart contract to update message
   async function ContractSendTx() {
   
       const { request } = await publicClient.simulateContract({
           address: contract_address,
           abi: abi,
           functionName: 'mintTest',
           args: [account.address],
           account
         })
       const tx =  await walletClient.writeContract(request)
       console.log(tx);
   }

Additional Viem Documentation

Click here for the official documentation.

JSON-RPC Calls

When some platforms or frameworks don't have any quality web3 library or SDK, there's always the possibility to make the blockchain calls directly to the JSON-RPC methods supported by the chain.

Available on:

Works on All SKALE Chains

Some of the JSON-RPC methods supported by SKALE chains are:

• eth_getBalance
• eth_blockNumber
• eth_getTransactionCount
• eth_sendTransaction
• eth_call

Implementation Example

Get Balance

import axios from 'axios';

const rpcEndpoint = 'YOUR SKALE RPC ENDPOINT';
const senderAddress = '0x...';


const requestData_balance = {
    jsonrpc: '2.0',
    method: 'eth_getBalance',
    params: [senderAddress, 'latest'],
    id: 1,
  };


async function JSON_RPC_CALL() {
    try {
        const response = await axios.post(rpcEndpoint,requestData_balance);
        return console.log(response.data);
      } catch (error) {
        console.error(error);
        return [[],[]];
      }
}

JSON_RPC_CALL();

Additional JSON-RPC Calls Documentation

Click here for the official documentation.

SKALE.js

(Maybe move to SKALE folder or under SKALE libraries)

SKALE.js is a community run project designed to offer abstraction over the core SKALE network smart contracts.

Available on:

Works on All SKALE Chains

Some of the available packages are:

• @skaleproject/ima: provide content to help using IMA, the SKALE native bridge
• @skaleproject/pow-ethers: SKALE proof of work mechanism written with Ethers library
• @skaleproject/pow-web3: SKALE proof of work mechanism written with web3 library
• @skaleproject/utils: package with utility scripts, such as, interaction with SKALE access_control predeployed contract

Additional SKALE.js Documentation

Click here for the official documentation.