@definer-org/definer-hodler
v1.0.5
Published
Definer HODLer market SDK
Downloads
11
Maintainers
mouad.eljamilReadme
definer-hodler.js - Definer Hodler Market SDK
Javascript SDK for definer-hodler
Overview
This npm package provides a utilities to read the HODLer market's data and also utilities for transacting with a HODLer market.
Installation
Node
npm i @definer-org/definer-hodlerPure javascript
Use the prebuilt dist/definer-hodler.min.js, or build using the definer-hodler-sdk git repository.
npm run buildInclude dist/definer-hodler.min.js in your html file. This will expose MarketDataReaderFactory, MarketTransManagerFactory and CHAINS object.
<script src="https://domain-name.com/definer-hodler.min.js"></script>Usage
This npm package exports the class: MarketDataReaderFactory, the class: MarketTransManagerFactory, and the object: CHAINS that are essential for interacting with the smart contracts for a given hodler market.
//In Node.js
import {
MarketDataReaderFactory,
MarketTransManagerFactory,
CHAINS,
} from "definer-hodler.js";
(async function task() {
//Reader
const bnbMainnet = "https://bsc-dataseed.binance.org";
const web3Obj = new Web3(new Web3.providers.HttpProvider(bnbMainnet));
const readerObj = await MarketDataReaderFactory.getNewInstance(
CHAINS.BNB,
2,
web3Obj
);
const stakingAPR = readerObj.getMarketBaseTokenStakingAPR();
const depositMiningAPR = readerObj.getMarketBaseTokenDepositMiningAPR();
const totalDeposit = readerObj.getMarketBaseTokenTotalDeposit();
//TransManager
const account_pkey = "ACCOUNT_KEY";
const account = web3Obj.eth.accounts.privateKeyToAccount(account_pkey);
web3Obj.eth.accounts.wallet.add(account);
const transManagerObj = await MarketTransManagerFactory.getNewInstance(
CHAINS.BNB,
2,
web3Obj
);
const result = await transManagerObj.deposit(
2,
"0x55d398326f99059fF775485246999027B3197955"
);
})();<!-- In Browser -->
<html>
...
<script src="https://domain-name.com/definer-hodler.min.js"></script>
<script>
(async function () {
const bnbMainnet = "https://bsc-dataseed.binance.org";
const web3Obj = new Web3(new Web3.providers.HttpProvider(bnbMainnet));
//Reader
const readerObj =
await definerHodler.MarketDataReaderFactory.getNewInstance(
definerHodler.CHAINS.BNB,
2,
web3Obj
);
const stakingAPR = readerObj.getMarketBaseTokenStakingAPR();
const depositMiningAPR =
await readerObj.getMarketBaseTokenDepositMiningAPR();
const totalDeposit = readerObj.getMarketBaseTokenTotalDeposit();
//TransManager
const account_pkey = "ACCOUNT_KEY";
const account = web3Obj.eth.accounts.privateKeyToAccount(account_pkey);
const transManagerObj =
await definerHodler.MarketTansManagerFactory.getNewInstance(
CHAINS.BNB,
2,
web3Obj
);
web3Obj.eth.accounts.wallet.add(account);
const depositResult = await transManagerObj.deposit(
3,
"0x770f030fdbf63ebf1c939de8bcff8943c2c2d454"
);
})();
</script>
...
</html>CHAINS has all the chains supported on the Definer platform.
Note: For better performance the HODLer market data is fetched only once from the smart contract and stored in the object created. If the hodler market data needs to be refetched from the smart contract a new object would need to be created.
Documentation
Documentation can be found at docs.
Building
Requirements
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npmBuilding (webpack)
Build the definer-hodler-js parckage:
npm install
npm run build