SynthetixJs library
The Synthetix-JS Library provides a simple pre-packaged API to communicate with Synthetix on ethereum. You can use it to contribute to DeFi's growing synthetic asset ecosystem.
This is particularly useful for hackathon teams to quickly npm install synthetix-js
and start building in just a few minutes.
Under the hood, SynthetixJs uses ethers.js library and its concept of providers and transaction signers.
Install via npm
npm install synthetix-js
Developer Docs
Example for getting the total sUSD stablecoin in circulation
const SynthetixJs = ;const snxjs = ; //uses default ContractSettings - ethers.js default provider, mainnet { const totalSUSD = await snxjssUSD; const totalSUSDSupply = snxjsutils; console;};
Default settings don't use any signer. That means that constants can be viewed from the contract but executing a transaction will fail. To execute transactions, set up signer.
4 signers are included in the library - Metamask (compatible with Dapp browsers), Trezor, Ledger and PrivateKey. Custom ethers.js compatible signers can be used too.
Example using a metamask signer
const SynthetixJs = ;const metaMaskSigner = ;const snxjs = signer: metaMaskSigner ; //uses Metamask signer and default infura.io provider on mainnet
Example of minting stablecoin(sUSD) with private key signer
const SynthetixJs = ;//parameters: default provider, default networkId, private key as a stringconst signer = null 0 '0x0123456789012345678901234567890123456789012345678901234567890123';const snxjs = signer ; { const totalSupply = await snxjsSynthetix; const snxTotalSupply = snxjsutils; console; //issue 100 synths (will throw if insufficient funds for gas) try const txObj = await snxjsSynthetix; //execute transaction (requires gas) console; catch e console; } ;