hsv2js v0.2.13
hs2v2js
hsv2js is a JavaScript library for interacting with HumbleSwapV2 tokens on the AVM blockchains. It provides a convenient interface for interacting with the HumbleSwapV2 AMM.
Features
- Interaction with HumbleSwapV2 AMM.
- Comprehensive methods for performing swaps and liquidity provision.
Installation
Install hsv2js in your project with:
npm install hsv2jsImplementations
hsv2js is spit into multiple implementations for each class of smart contract making up the HumbleSwapV2 AMM. The following implementations are available:
ann- HumbleSwapV2 Announcer for staking poolsnetTok- HumbleSwapV2 Network-Token liquidity pooltokTok- HumbleSwapV2 Token-Token liquidity pooltri- HumbleSwapV2 Announcer for liquidity pools
Usage
Import and initialize the hsv2js library in your project:
import algosdk from "algosdk";
import Contract from "hsv2js";
// Initialize Algod client
const algodClient = new algosdk.Algodv2(algodToken, algodServer, algodPort);
const indexerClient = new algosdk.Indexer(
indexerToken,
indexerServer,
indexerPort
);
// Initialize ARC200 Contract instance
const tokenId = 123456; // Replace with your token ID
const contract = new Contract.netTok(tokenId, algodClient, indexerClient);Event queries
The query argument may be used to retrieve matching events:
const { minRound, maxRound, address, round, txid } = query || {};minRound and maxRound may be used to specify a range of rounds to query events from. address may be used to filter events by address. round and txid may be used to retrieve events from a specific round or transaction ID.
The following events are available for extended ARC200 token functionalities:
getEvents
Retrieve all events of the ARC200 token.
await contract.getEvents();
//{
// arc200_Transfer: {
// name: "arc200_Transfer",
// signature: "...",
// selector: "...",
// events: [
// [
// "WR4C7PMYKZ45ZWFWHTQRWHL424VDYXKYH4X2BX4J6KZ7BD3IQD4Q",
// 1519106,
// 1699029707,
// "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ",
// "VIAGCPULN6FUTHUNPQZDRQIHBT7IUVT264B3XDXLZNX7OZCJP6MEF7JFQU",
// 10000000000000000n,
// ],
// ...
// ]
// },
// arc200_Approval: {
// name: "arc200_Approval",
// signature: "...",
// selector: "...",
// events: [
// [
// "WR4C7PMYKZ45ZWFWHTQRWHL424VDYXKYH4X2BX4J6KZ7BD3IQD4Q",
// 1519106,
// 1699029707,
// "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ",
// "VIAGCPULN6FUTHUNPQZDRQIHBT7IUVT264B3XDXLZNX7OZCJP6MEF7JFQU",
// 10000000000000000n,
// ],
// ...
// ]
// }
//}standard methods
The following methods are available for standard ARC200 token functionalities:
API Reference
Each method provided by arc200js offers specific functionalities:
getEvents(): Retrieves all events of the ARC200 token.
Contributing
Contributions to hsv2js are welcome. Please adhere to the existing code style and ensure all tests pass.
License
hsv2js is MIT licensed.
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago