@anchor-protocol/anchor.js
v5.1.1
Published
Anchor.js is a client SDK for building applications that can interact with Anchor Protocol from within JavaScript runtimes, such as web browsers, server backends, and on mobile through React Native.
Downloads
477
Keywords
Readme
Anchor.js
Anchor.js is a client SDK for building applications that can interact with Anchor Protocol from within JavaScript runtimes, such as web browsers, server backends, and on mobile through React Native.
You can find a reference of the Anchor.js API here.
Getting Anchor.js
Anchor.js is available as a package on NPM and is intended to be used alongside Terra.js.
Add both:
@terra-money/terra.js
@anchor-protocol/anchor.js
To your JavaScript project's package.json
as dependencies using your preferred package manager:
$ npm install -S @terra-money/terra.js @anchor-protocol/anchor.js
Usage
Using Facades
Anchor.js provides class wrapper facade for the usual operations available on webapp.
import { LCDClient, MnemonicKey, Fee, Wallet } from '@terra-money/terra.js'
import { Anchor, columbus5, AddressProviderFromJson, MARKET_DENOMS, OperationGasParameters } from '@anchor-protocol/anchor.js'
const addressProvider = new AddressProviderFromJson(columbus5)
const lcd = new LCDClient({ URL: 'https://lcd.terra.dev', chainID: 'columbus-5' })
const key = new MnemonicKey({
mnemonic: 'your key'
})
const wallet = new Wallet(lcd, key)
const anchor = new Anchor(lcd, addressProvider)
// you can generate message only, using your wallet
const msgs = anchor.earn.depositStable(MARKET_DENOMS.UUSD, "100.5000").generateWithWallet(wallet)
// you can ALSO generate message only, using your address in string
const msgs = anchor.earn.depositStable(MARKET_DENOMS.UUSD, "100.5000").generateWithAddress("terra1...")
// or, you can broadcast the tx using your wallet
// below is the recommended default setting for gas parameters.
// of course you can tailor it to your needs
const gasParameters: OperationGasParameters = {
gasAdjustment: 1.4,
gasPrices: "0.15uusd",
// or if you want to fixate gas, you can use `fee`
fee: new Fee(gasToSpend, "100000uusd")
}
const txResult = await anchor.earn.depositStable(MARKET_DENOMS.UUSD, "100.5000").execute(wallet, gasParameters)
When working with bAsset's, they can be loaded in one of two ways.
import { LCDClient, MnemonicKey, Fee, Wallet } from '@terra-money/terra.js'
import { Anchor, columbus5, bAssetColumbus5, AddressProviderFromJson, MARKET_DENOMS } from '@anchor-protocol/anchor.js'
const addressProvider = new AddressProviderFromJson(columbus5)
const lcd = new LCDClient({ URL: 'https://lcd.terra.dev', chainID: 'columbus-5' })
const key = new MnemonicKey({
mnemonic: 'your key'
})
const wallet = new Wallet(lcd, key)
const anchor = new Anchor(lcd, addressProvider)
// load the bAsset from the available whitelisted collateral
const collaterals = await anchor.moneyMarket.getCollateralWhitelist({
market: MARKET_DENOMS.UUSD,
});
const [collateral] = collaterals.filter(
(collateral) => collateral.symbol === 'BETH',
);
const bAsset = await anchor.bAsset(collateral);
// alternatively, the bAsset can be loaded with the symbol and market demons
const bAsset = await anchor.bAsset({ symbol: 'BETH', market: MARKET_DENOMS.UUSD });
// once you have the bAsset, you can then perform operations
const operation = bAsset.claim({ recipient: 'terra1...' });
Using Message Fabricators
Anchor.js provides facilities for 2 main use cases:
- query: runs smart contract queries through LCD
- execute: creates proper
MsgExecuteContract
objects to be used in transactions
Both of these functions are accessible through the Message Fabricators
.
To Use the message fabricators:
Note: Please note that market
is a different variable from the coin denom. The denomination for the coins in the example is set to be uusd
.
import {fabricateRedeemStable, fabricateDepositStableCoin} from '@anchor-protocol/anchor.js';
import {AddressProviderFromJson} from "@anchor-protocol/anchor.js";
// default -- uses bombay core contract addresses
const addressMap = somehowGetAddresses();
const addressProvider = new AddressProviderFromJson(addressMap);
const redeemMsg = fabricateRedeemStable({
address: 'terra123...',
market: 'usd',
amount: '10000',
})(addressProvider);
const depositMsg = fabricateDepositStableCoin({
address: 'terra123...',
market: 'usd',
amount: '10',
})(addressProvider);
Executing
A message fabricator contains functions for generating proper MsgExecuteContract
messages to be included in a transaction and broadcasted.
import { LCDClient, Wallet, MnemonicKey, Fee} from '@terra-money/terra.js';
const anchor = new LCDClient({ URL: 'https://bombay-lcd.terra.dev', chainID:'bombay-12' });
const owner = new MnemonicKey({ mnemonic: "...."});
const wallet = new Wallet(anchor, owner);
async function depositStable() {
const tx = await wallet.createAndSignTx({
msgs: depositMsg,
fee: new Fee(2_000_000, { uluna: 2_000_000 })
});
return await anchor.tx.broadcast(tx);
}
async function main() {
await depositStable()
.then((result) => {
console.log(result);
})
.catch(console.error);
}
main();
List of contract addresses deployed to networks
columbus-5
:{ bLunaHub: 'terra1mtwph2juhj0rvjz7dy92gvl6xvukaxu8rfv8ts', bLunaToken: 'terra1kc87mu460fwkqte29rquh4hc20m54fxwtsx7gp', bLunaReward: 'terra17yap3mhph35pcwvhza38c2lkj7gzywzy05h7l0', bLunaAirdrop: 'terra199t7hg7w5vymehhg834r6799pju2q3a0ya7ae9', bEthReward: 'terra1939tzfn4hn960ychpcsjshu8jds3zdwlp8jed9', bEthToken: 'terra1dzhzukyezv0etz22ud940z7adyv7xgcjkahuun', mmInterestModel: 'terra1kq8zzq5hufas9t0kjsjc62t2kucfnx8txf547n', mmOracle: 'terra1cgg6yef7qcdm070qftghfulaxmllgmvk77nc7t', mmMarket: 'terra1sepfj7s0aeg5967uxnfk4thzlerrsktkpelm5s', mmOverseer: 'terra1tmnqgvg567ypvsvk6rwsga3srp7e3lg6u0elp8', mmCustody: 'terra1ptjp2vfjrwh0j0faj9r6katm640kgjxnwwq9kn', mmCustodyBEth: 'terra10cxuzggyvvv44magvrh3thpdnk9cmlgk93gmx2', mmLiquidation: 'terra1w9ky73v4g7v98zzdqpqgf3kjmusnx4d4mvnac6', mmDistributionModel: 'terra14mufqpr5mevdfn92p4jchpkxp7xr46uyknqjwq', aTerra: 'terra1hzh9vpxhsk8253se0vv5jj6etdvxu3nv8z07zu', terraswapblunaLunaPair: 'terra1jxazgm67et0ce260kvrpfv50acuushpjsz2y0p', terraswapblunaLunaLPToken: 'terra1nuy34nwnsh53ygpc4xprlj263cztw7vc99leh2', terraswapAncUstPair: 'terra1gm5p3ner9x9xpwugn9sp6gvhd0lwrtkyrecdn3', terraswapAncUstLPToken: 'terra1gecs98vcuktyfkrve9czrpgtg0m3aq586x6gzm', gov: 'terra1f32xyep306hhcxxxf7mlyh0ucggc00rm2s9da5', distributor: 'terra1mxf7d5updqxfgvchd7lv6575ehhm8qfdttuqzz', collector: 'terra14ku9pgw5ld90dexlyju02u4rn6frheexr5f96h', community: 'terra12wk8dey0kffwp27l5ucfumczlsc9aned8rqueg', staking: 'terra1897an2xux840p9lrh6py3ryankc6mspw49xse3', ANC: 'terra14z56l0fp2lsf86zy3hty2z47ezkhnthtr9yq76', airdrop: 'terra146ahqn6d3qgdvmj8cj96hh03dzmeedhsf0kxqm', team_vesting: 'terra1pm54pmw3ej0vfwn3gtn6cdmaqxt0x37e9jt0za', investor_vesting: 'terra10evq9zxk2m86n3n3xnpw28jpqwp628c6dzuq42' }
bombay-12
:{ bLunaHub: 'terra1fflas6wv4snv8lsda9knvq2w0cyt493r8puh2e', bLunaToken: 'terra1u0t35drzyy0mujj8rkdyzhe264uls4ug3wdp3x', bLunaReward: 'terra1ac24j6pdxh53czqyrkr6ygphdeftg7u3958tl2', bLunaAirdrop: 'terra1334h20c9ewxguw9p9vdxzmr8994qj4qu77ux6q', bEthReward: 'terra1ja3snkedk4t0zp7z3ljd064hcln8dsv5x004na', bEthToken: 'terra19mkj9nec6e3y5754tlnuz4vem7lzh4n0lc2s3l', mmInterestModel: 'terra1m25aqupscdw2kw4tnq5ql6hexgr34mr76azh5x', mmOracle: 'terra1p4gg3p2ue6qy2qfuxtrmgv2ec3f4jmgqtazum8', mmMarket: 'terra15dwd5mj8v59wpj0wvt233mf5efdff808c5tkal', mmOverseer: 'terra1qljxd0y3j3gk97025qvl3lgq8ygup4gsksvaxv', mmCustody: 'terra1ltnkx0mv7lf2rca9f8w740ashu93ujughy4s7p', mmCustodyBEth: 'terra1j6fey5tl70k9fvrv7mea7ahfr8u2yv7l23w5e6', mmLiquidation: 'terra16vc4v9hhntswzkuunqhncs9yy30mqql3gxlqfe', mmDistributionModel: 'terra1u64cezah94sq3ye8y0ung28x3pxc37tv8fth7h', aTerra: 'terra1ajt556dpzvjwl0kl5tzku3fc3p3knkg9mkv8jl', terraswapblunaLunaPair: 'terra13e4jmcjnwrauvl2fnjdwex0exuzd8zrh5xk29v', terraswapblunaLunaLPToken: 'terra1tj4pavqjqjfm0wh73sh7yy9m4uq3m2cpmgva6n', terraswapAncUstPair: 'terra1wfvczps2865j0awnurk9m04u7wdmd6qv3fdnvz', terraswapAncUstLPToken: 'terra1vg0qyq92ky9z9dp0j9fv5rmr2s80sg605dah6f', gov: 'terra16ckeuu7c6ggu52a8se005mg5c0kd2kmuun63cu', distributor: 'terra1z7nxemcnm8kp7fs33cs7ge4wfuld307v80gypj', collector: 'terra1hlctcrrhcl2azxzcsns467le876cfuzam6jty4', community: 'terra17g577z0pqt6tejhceh06y3lyeudfs3v90mzduy', staking: 'terra19nxz35c8f7t3ghdxrxherym20tux8eccar0c3k', ANC: 'terra1747mad58h0w4y589y3sk84r5efqdev9q4r02pc', airdrop: 'terra1u5ywhlve3wugzqslqvm8ks2j0nsvrqjx0mgxpk', investor_vesting: 'not available in testnet', team_vesting: 'not available in testnet', }
License
This software is licensed under the Apache 2.0 license. Read more about it here.
© 2021 Anchor Protocol