3.4.0 • Published 2 years ago
@liquity/lib-ethers v3.4.0
@liquity/lib-ethers
Ethers-based library for reading Liquity protocol state and sending transactions.
Quickstart
Install in your project:
npm install --save @liquity/lib-base @liquity/lib-ethers ethers@^5.0.0
Connecting to an Ethereum node and sending a transaction:
const { Wallet, providers } = require("ethers");
const { EthersLiquity } = require("@liquity/lib-ethers");
async function example() {
const provider = new providers.JsonRpcProvider("http://localhost:8545");
const wallet = new Wallet(process.env.PRIVATE_KEY).connect(provider);
const liquity = await EthersLiquity.connect(wallet);
const { newTrove } = await liquity.openTrove({
depositCollateral: 5, // ETH
borrowLUSD: 2000
});
console.log(`Successfully opened a Liquity Trove (${newTrove})!`);
}
More examples
See packages/examples in the repo.
Liquity's Dev UI itself contains many examples of @liquity/lib-ethers
use.
API Reference
For now, it can be found in the public Liquity repo.