xbacked-interest-settler v0.1.0

xbacked-interest-settler

This module runs the settleInterest method to distribute interest accrued in the vault to the DAO and stakers. The caller does not get any reward for calling the method.

Install

• Install from NPM: npm i xbacked-interest-settler
• Clone this repository and run npm install from the cloned directory to install the required dependencies

Usage (NPM)

• Import taskRunner from xbacked-interest-settler
• Pass the required parameters to the taskRunner function

Usage (Github clone)

• Create a .env file and specify the required variables using the .env-example file
• Run npm start or npm run dev - for development purposes

env Parameters

• PASS_PHRASE: Mnemonic phrase for the wallet address to be used
• SLEEP_DURATION: How long should the interval between each call should last. Must be in milliseconds e.g 5000 equivalent of 5s. (NB.: 1000 == 1s)
• NETWORK: The network to connect to e.g TestNet, MainNet

Misc.

• Add "type":"module" to your package.json for the package to work

• Sample code (npm installation)

taskRunner({ sleepDuration: process.env.SLEEP_DURATION, network: process.env.NETWORK, passPhrase: process.env.PASS_PHRASE }).catch(e => console.log(e))