@zoidpay-tech/zoidcore-web3-toolkit
v0.9.27
Published
<div align="center"> </a> <h1 align="center"> ZoidCore Web3 ToolKit </h1> <a href="https://apidocs.zoidcore.com/" target="_blank"> <img alt="Check the docs" src="https://img.shields.io/badge/Docs-Full Documentation-21BF96?style=flat&logo
Downloads
7
Maintainers
Readme
@zoidpay-tech/zoidcore-web3-toolkit
Introduction
ZoidCore, a developer toolkit of APIs and SDKs, will let any company transition from Web 2.0 to Web 3.0 easily and effectively.
At this moment, the supported chains are MultiversX, Polygon, Binance and Ethereum
🌟 Highlights
- Web3 transaction payload creation
- Smart contract build
- Integrated compile process
- Consistent data types
- Utility API calls for contract verification, status and more
Installation
Run the following command:
npm i @zoidpay-tech/zoidcore-web3-toolkit
🪄 Get your API Key
- Go the the ZoidCore Dashboard: https://www.zoidcore.com/
- Log in or Sign Up
- Go to the 'API KEYS' section and generate your key
Usage
Import the package into your project:
import { ZoidCore } from '@zoidpay-tech/zoidcore-web3-toolkit';
Once the package has been insalled, instantiate ZoidCore with your api key:
const zoid = new ZoidCore(process.env.MY_API_KEY as string);
Then, with only one line of code, access one of the classes (ethereum, multivesX, binance or polygon) and the desired function:
const response = await zoid.ethereum.ethCreateToken(ethCreatePayload);
Types
Your payload can be typed. The package exports types as ZoidModels, import as follows:
import { ZoidModels } from '@zoidpay-tech/zoidcore-web3-toolkit';
Full transaction code snippet should look like this:
import { ZoidCore } from '@zoidpay-tech/zoidcore-web3-toolkit';
import { ZoidModels } from '@zoidpay-tech/zoidcore-web3-toolkit';
const ethCreatePayload: ZoidModels.EthTokenCreate = {
address: '0x365f14a97a16b380dd64b677ea0a92bafa6f606e',
chainId: 11155111,
currentAddress: '0x365f14a97a16b380dd64b677ea0a92bafa6f606e',
supply: 100,
tokenName: 'MyAmazingToken',
tokenSymbol: 'AMZG',
networkProvider: 'https://rpc.sepolia.org',
numberOfDecimals: 10,
canMint: true,
canBurn: true,
environment: "testnet"
}
const zoid = new ZoidCore(process.env.MY_API_KEY as string);
const response = await zoid.ethereum.ethCreateToken(ethCreatePayload);
Other Utility Functions
| Function | Description |
| --- | --- |
| Get Tx Status |
| zoid.multiversx.multiversXstatus
| Get the status of a multiversx transaction |
| zoid.polygon.polygonGetTxStatus
| Get the status of a polygon transaction |
| zoid.ethereum.ethTxStatus
| Get the status of a ethereum transaction |
| zoid.bsc.bscTxStatus
| Get the status of a binance transaction |
| Verify smart contract |
| zoid.ethereum.ethVerifyToken
| Verifies an ethereum token smart contract |
| zoid.ethereum.ethVerifyNft
| Verifies an ethereum nft smart contract |
| zoid.polygon.polygonVerifyToken
| Verifies polygon token smart contract |
| zoid.polygon.polygonVerifyNft
| Verifies polygon nft smart contract |
| zoid.bsc.bscVerifySmartContractToken
| Verifies a binance token smart contract |
| zoid.bsc.bscVerifySmartContractNft
| Verifies a binance nft smart contract |
✨ This is just a brief presentation and does not encompass all the features of ZoidCore ToolKit. For more information, please check the complete documentation here: https://apidocs.zoidcore.com/
Conclusion
The ZoidCore Web3 Toolkit package provides a convenient way to build or migrate to web3. By following the steps outlined in this documentation, you can easily integrate this package into your applications.