Wallact

This TypeScript library provides a simplified interface for interacting with smart contracts on the Ethereum blockchain. It abstracts the complexities of read and write operations, making it easier for developers to work with smart contracts within their applications.

Features

• Simplified Contract Interaction: Offers easy-to-use methods for reading from and writing to smart contracts.
• Flexible Contract Management: Supports multiple contract instances, allowing interactions with various entities and contracts through a single interface.
• Error Handling: Implements try-catch blocks for robust error handling during contract interactions.

Getting Started

Prerequisites

• Node.js (v14 or higher recommended)
• npm (v6 or higher recommended)
• An Ethereum wallet with some ETH for transactions
• Access to an Ethereum node (via services like Infura or Alchemy)

Installation

1. Install with npm:

npm i wallact

Usage

Creating Keys for Wallet

To create keys for a new wallet, use the createWallet method. This method generates a new wallet including a private key and address.

import { Wallact } from "wallact";

const wallet = Wallact.createWallet();
console.log(`Wallet Address: \${wallet.address}`);
console.log(`Private Key: \${wallet.privateKey}`);

Get Wallet Address from Key

To get wallet address from private key, use the getWalletAddress method. This will return the address.

import { Wallact } from "wallact";

const address = Wallact.getWalletAddress("0xYOUR_PRIVATE_KEY");
console.log(`Wallet Address: \${.address}`);

Reading from a Smart Contract

To read data from a smart contract, use the readContract method. This method requires the name of the contract method you wish to call and an array of arguments for that method.

import { Wallact } from "wallact";

async function readData() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi
  );
  try {
    const data = await contractInterface.readContract("methodName", [
      "arg1",
      "arg2",
    ]);
    console.log("Contract data:", data);
  } catch (error) {
    console.error("Error reading from contract:", error);
  }
}

Writing to a Smart Contract

To write data to a smart contract, use the writeContract method. This method requires the name of the contract method you wish to call, an array of arguments for that method, and optionally the entity (contract instance) to use for the write operation.

import { Wallact } from "wallact";

async function writeData() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi,
    "0xYourPrivateKey"
  );
  try {
    const receipt = await contractInterface.writeContract("methodName", [
      "arg1",
      "arg2",
    ]);
    console.log("Transaction receipt:", receipt);
  } catch (error) {
    console.error("Error writing to contract:", error);
  }
}

Writing to a Smart Contract with transaction Confirmation

To write data to a smart contract, use the writeContractWithConfirmations method. This method requires the name of the contract method you wish to call, an array of arguments for that method, and optionally the entity (contract instance) to use for the write operation.

import { Wallact } from "wallact";

async function writeData() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi,
    "0xYourPrivateKey"
  );
  try {
    const receipt = await contractInterface.writeContractWithConfirmations(
      "methodName",
      ["arg1", "arg2"],
      5
    );
    console.log("Transaction receipt:", receipt);
  } catch (error) {
    console.error("Error writing to contract:", error);
  }
}

Writing to a Smart Contract with multiple entities

To write data to a smart contract with different entity, use the addEntityWallet method. This method requires the name of the entity and key for that entity.

import { Wallact } from "wallact";

async function writeData() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi,
    "0xYourPrivateKey",
    "ownerEntity"
  );

  contractInterface.addEntityWallet("verifier", "0xVerifierPrivateKey");

  try {
    const receipt = await contractInterface.writeContract(
      "methodName",
      ["arg1", "arg2"],
      "verifier"
    );
    console.log("Transaction receipt:", receipt);
  } catch (error) {
    console.error("Error writing to contract:", error);
  }
}

Converting Ether to Wei

To convert Ether to Wei, which is necessary for many contract interactions requiring value transactions, use the convertToWei static method. This method takes the amount in Ether as an argument and returns its equivalent in Wei.

import { Wallact } from "wallact";

const etherAmount = 1; // Example amount in Ether
const weiAmount = Wallact.convertToWei(etherAmount);
console.log(`${etherAmount} Ether is equivalent to ${weiAmount} Wei.`);

Converting Wei to Ether

Conversely, to convert Wei back to Ether, perhaps for displaying balances in a more readable format, use the convertToEth static method. This method takes the amount in Wei as an argument and returns its equivalent in Ether.

import { Wallact } from "wallact";

const weiAmount = BigInt("1000000000000000000"); // Example amount in Wei
const etherAmount = Wallact.convertToEth(weiAmount.toString());
console.log(`${weiAmount} Wei is equivalent to ${etherAmount} Ether.`);

Validate an Ethereum Address

To check if an Ethereum address is valid, use the isValidEthereumAddress static method. This method takes an Ethereum address as a string argument and returns a boolean indicating whether the address is valid.

import { Wallact } from "wallact";

const address = "0x49A6F7Ece315a56C097c4Fc72F5aA2886B9c260a"; // Example Ethereum address
const isValid = Wallact.isValidEthereumAddress(address);
console.log(`Is the address valid? ${isValid}`);

Fetch Wallet Balance

To retrieve the balance of a wallet, use the fetchWalletBalance method. This method takes an Ethereum address as a string argument and returns the balance of the wallet in Wei.

import { Wallact } from "wallact";

async function getWalletBalance(address: string) {
  const wallactInstance = new Wallact("https://rpc-url/", abi); // Initialize with your provider URL
  try {
    const balanceWei = await wallactInstance.fetchWalletBalance(address);
    console.log(`Balance for ${address}: ${balanceWei} Wei`);
  } catch (error) {
    console.error("Failed to fetch wallet balance:", error);
  }
}

Fetch the Latest Block Number

To fetch the latest block number from the blockchain, use the fetchLatestBlock method. This method returns the latest block number.

import { Wallact } from "wallact";

async function fetchLatestBlockNumber() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi
  );
  try {
    const data = await fetchLatestBlock();
    console.log("Latest Block Number:", data);
  } catch (error) {
    console.error("Error reading latest Block number:", error);
  }
}

Get Transaction Receipt

To get the transaction receipt for a given transaction hash, use the getTransactionReceipt method. This method returns the transaction receipt.

import { Wallact } from "wallact";

async function getTxReceipt() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi
  );
  try {
    const data = await getTransactionReceipt("0xTRANSACTION_HASH");
    console.log("Latest Block Number:", data);
  } catch (error) {
    console.error("Error reading transaction Receipt:", error);
  }
}

Wait for Transaction Confirmation

To wait for a transaction to be confirmed a specified number of times, use the waitForTransaction method. This does not return a value but waits until the transaction has the specified number of confirmations (5 in this case).

import { Wallact } from "wallact";

async function getTxReceipt() {
  const contractInterface = new Wallact(
    "https://rpc-url/",
    "0xContractddress",
    contractAbi
  );
  try {
    await waitForTransaction("0xTRANSACTION_HASH", 5);
  } catch (error) {
    console.error("Error reading from contract:", error);
  }
}

Contributing

Contributions are welcome! Please feel free to submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.