decimal-token-processor
v1.1.0
Published
Manipulating token values by adding or removing decimals, compatible with both native and custom tokens
Downloads
7
Maintainers
Readme
Decimal-token-processor Package
The decimal-token-processor npm package simplifies the process of adding and removing decimals from token values. It's designed to handle both standard and custom tokens effortlessly.
Installation
You can install this package using npm:
npm i decimal-token-processor
Usage
To use the package in your Node.js project, import the addDecimal and removeDecimal functions:
const { addDecimal, removeDecimal } = require("decimal-token-processor");
// Example usage for adding decimals
const details = {
chainId: 1,
rpcProvider: "https://custom-rpc-provider-url.com", // Optional: Use custom RPC provider
contractAddress: "0x...", // Provide the contract address for custom tokens; skip for native tokens
value: 0.01, // Amount you want to convert
};
const addedValue = addDecimal(details);
console.log(`Added Decimals Result: ${addedValue}`);
// Example usage for removing decimals
const removedValue = removeDecimal({
chainId: 1,
rpcProvider: "https://custom-rpc-provider-url.com", // Optional: Use custom RPC provider
contractAddress: "0x..", // Provide the contract address for custom tokens; skip for native tokens
value: 1000000000, // Amount you want to convert
});
console.log(`Removed Decimals Result: ${removedValue}`);
Parameters:
chainId
: The identifier for the blockchain network.rpcProvider
: Optional. Custom RPC provider URL. If not provided, the package uses the default RPC provider based on chainId.contractAddress
: The address of the smart contract (for custom tokens).value
: The amount you want to convert.
Default Network Support
The package supports the following default networks:
- Ethereum Mainnet (Chain ID: 1)
- Goerli Testnet (Chain ID: 5)
- Sepolia Testnet (Chain ID: 11155111)
- Binance Mainnet (Chain ID: 56)
- Binance Testnet (Chain ID: 97)
- Polygon Mainnet (Chain ID: 137)
- Mumbai (Chain ID: 80001)
- Avalanche C-Chain Mainnet (Chain ID: 43114)
- Avalanche Fuji Testnet (Chain ID: 43113)
- Optimism Mainnet (Chain ID: 10)
- Optimism Goerli Testnet (Chain ID: 420)
- Arbitrum One Mainnet (Chain ID: 42161)
- Arbitrum Goerli (Chain ID: 421613)
- Torus Testnet (Chain ID: 8194)
If you require custom network support, you can provide a custom RPC provider URL via the rpcProvider parameter and skip chainId.