@rarcifa/cronos-evm-client

Cronos EVM Client

The Cronos EVM Client is a TypeScript/JavaScript library designed to facilitate easy and efficient interactions with the Cronos Ethereum Virtual Machine (EVM). This client library provides methods to interact with CRC20 and CRC721 tokens, allowing developers to fetch balances, token metadata, and perform other contract interactions seamlessly.

Features

Simple and intuitive API for interacting with the Cronos blockchain. Supports both CRC20 and CRC721 token standards. Configurable client instances tailored to your specific blockchain endpoint and security needs.

Installation

To install the package, run the following command in your project directory:

npm install @rarcifa/cronos-evm-client

Usage

Here’s how you can use the Cronos EVM Client in your project:

Configuring the Client

import { createClient } from 'cronos-evm-client';

const client = createClient({
  endpoint: 'CRONOS_RPC_ENDPOINT',
  apiKey: 'OPPTIONAL_API_KEY', // optional
});

Fetching CRC20 Token Balance

const fetchCrc20Balance = async (accountAddress, contractAddress) => {
  try {
    const balance = await client.crc20.getBalanceOf(
      accountAddress,
      contractAddress
    );
    console.log('CRC20 Token Balance:', balance);
  } catch (error) {
    console.error('Error fetching CRC20 balance:', error);
  }
};

Interacting with CRC721 Tokens

const fetchCrc721Owner = async (contractAddress) => {
  try {
    const owner = await client.crc721.getOwnerOf(contractAddress);
    console.log('CRC721 Owner Address:', owner);
  } catch (error) {
    console.error('Error fetching CRC721 owner:', error);
  }
};

API

CRC20 Methods

• getBalance(accountAddress): Fetches the balance of the main token for an account.
• getBalanceOf(accountAddress, contractAddress): Fetches the balance of a specified CRC20 token for an account.
• getName(contractAddress): Fetches the name of the CRC20 token.
• getSymbol(contractAddress): Fetches the symbol of the CRC20 token.
• getTotalSupply(contractAddress): Fetches the total supply of the CRC20 token.

CRC721 Methods

• getBalanceOf(accountAddress, contractAddress): Fetches the balance of specified CRC721 tokens for an account.
• getOwnerOf(contractAddress): Fetches the owner address of a specific CRC721 token.
• getTokenUri(contractAddress): Fetches the URI pointing to the metadata of the CRC721 token.

Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

Licensing

The code in this project is licensed under MIT license.

Contact

If you have any questions or comments about the library, please feel free to open an issue or a pull request on our GitHub repository.