Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synthetixio/synthetix-js
[deprecated] Please use https://github.com/Synthetixio/js-monorepo/tree/master/packages/contracts-interface
https://github.com/synthetixio/synthetix-js
blockchain dapp defi ethereum synthetix
Last synced: 6 days ago
JSON representation
[deprecated] Please use https://github.com/Synthetixio/js-monorepo/tree/master/packages/contracts-interface
- Host: GitHub
- URL: https://github.com/synthetixio/synthetix-js
- Owner: Synthetixio
- Created: 2018-08-28T01:53:41.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T14:49:40.000Z (3 months ago)
- Last Synced: 2024-11-01T19:33:26.534Z (12 days ago)
- Topics: blockchain, dapp, defi, ethereum, synthetix
- Language: JavaScript
- Homepage:
- Size: 42.1 MB
- Stars: 63
- Watchers: 22
- Forks: 44
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**This library is now deprecated.** Please use https://github.com/Synthetixio/js-monorepo/tree/master/packages/contracts-interface from our new monorepo.
# SynthetixJs library
[](https://circleci.com/gh/Synthetixio/synthetix-js) [](https://badge.fury.io/js/synthetix-js)
[](https://discordapp.com/channels/413890591840272394/)
[](https://twitter.com/synthetix_io)
The Synthetix-JS Library provides a simple pre-packaged API to communicate with [Synthetix](https://synthetix.io) 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](https://github.com/ethers-io/ethers.js/) library and its concept of [providers](https://docs.ethers.io/ethers.js/html/api-providers.html) and [transaction signers](https://docs.ethers.io/ethers.js/html/api-contract.html#custom-signer).
## Install via npm
`npm install synthetix-js`
## Developer Docs
[developer.synthetix.io](https://developer.synthetix.io)
## Example for getting the total sUSD stablecoin in circulation
```javascript
const { SynthetixJs } = require('synthetix-js');
const snxjs = new SynthetixJs(); //uses default ContractSettings - ethers.js default provider, mainnet
(async function() {
const totalSUSD = await snxjs.sUSD.totalSupply();
const totalSUSDSupply = snxjs.utils.formatEther(totalSUSD);
console.log('sUSDTotalSupply', totalSUSDSupply);
})();
```
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
```javascript
const { SynthetixJs } = require('synthetix-js');
const metaMaskSigner = new SynthetixJs.signers.Metamask();
const snxjs = new SynthetixJs({ signer: metaMaskSigner }); //uses Metamask signer and default infura.io provider on mainnet
```
## Example of minting stablecoin(sUSD) with private key signer
```javascript
const { SynthetixJs } = require('synthetix-js');
//parameters: default provider, default networkId, private key as a string
const signer = new SynthetixJs.signers.PrivateKey(
null,
0,
'0x0123456789012345678901234567890123456789012345678901234567890123'
);
const snxjs = new SynthetixJs({ signer });
async function run() {
const totalSupply = await snxjs.Synthetix.totalSupply();
const snxTotalSupply = snxjs.utils.formatEther(totalSupply);
console.log('snxTotalSupply', snxTotalSupply);
//issue 100 synths (will throw if insufficient funds for gas)
try {
const txObj = await snxjs.Synthetix.issueSynths(snxjs.util.parseEther('100')); //execute transaction (requires gas)
console.log('transaction hash', txObj.hash);
} catch (e) {
console.log(e);
}
}
run();
```
## Live examples
- Get total synth supply [](https://codepen.io/justinjmoses/pen/vMKywz/left?editors=0010)
- Get collateralized state [
](https://codepen.io/justinjmoses/pen/qwqoBR/left?editors=0010)
## Got any questions?
Join our dev community on Discord: [](https://discordapp.com/channels/413890591840272394/)