Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@horizon-protocol/contracts-interface
Advanced tools
Readme
The official JavaScript library for interacting with Synthetix protocol contracts.
This library can be used in 2 different environments:
// For node environments:
const { synthetix } = require('@synthetixio/contracts-interface');
// For single page applications:
import { synthetix } from '@synthetixio/contracts-interface';
// For browsers you can use a CDN of the minified files
// E.g. <script src="https://cdn.jsdelivr.net/npm/@synthetixio/contracts-interface/build/index.min.js"></script>
// then you can access synthetix on the window object:
const { synthetix } = window;
// Instantiate the library with or without a provider
const hznjs = synthetix({ network: 'mainnet' });
// Note: for typescript applications
import { synthetix, Network } from '@synthetixio/contracts-interface';
const hznjs = synthetix({ network: Network.Mainnet });
const hznjs = synthetix({ network: 'mainnet' });
// If you want to interact with a contract, simply follow the convention:
// await hznjs[contractName].methodName(arguments)
const owner = await hznjs.contracts.Synthetix.owner();
// many arguments require being formatted toBytes32, which we also provide with the library
const { toBytes32 } = snx;
const totalIssuedSynths = await hznjs.contracts.Synthetix.totalIssuedSynths(toBytes32('sUSD'));
// We also expose ethers utils which provides handy methods for formatting responses to queries.
const { formatEther } = hznjs.utils;
formatEther(await hznjs.contracts.SynthsUSD.totalSupply());
formatEther(await hznjs.contracts.ExchangeRates.rateForCurrency(hznjs.toBytes32('SNX')));
// Note can optionally pass in a { blockTag: someBlockNumber } to get data from a specific block instead of {}
const snxAtBlock12m = await hznjs.contracts.ExchangeRates.rateForCurrency(hznjs.toBytes32('SNX'), {
blockTag: 12e6,
});
// any old provider will do
const provider = ethers.providers.getDefaultProvider('kovan');
// create a signer with a provider attached
const signer = new ethers.Wallet(
// just a dummy kovan wallet with a little keth from the faucet
'0xa0d951c494421559c63089093b020cf2f7aac003c916967dc36e989bc695222e',
provider
);
// and then instantiate synthetix with the signer
const hznjs = synthetix({ network: 'mainnet', signer });
// mint 0.01 sETH via the NativeEtherWrapper
const response = await hznjs.contracts.NativeEtherWrapper.mint({
value: parseEther('0.01'),
gasPrice: parseUnits('5', 'gwei'),
gasLimit: 500e3,
});
console.log('Submitted', response.hash);
await response.wait();
console.log('Mined', `https://etherscan.io/tx/${response.hash}`);
See the examples folder for more usage details.
FAQs
A library for interacting with Horizon smart contracts
The npm package @horizon-protocol/contracts-interface receives a total of 63 weekly downloads. As such, @horizon-protocol/contracts-interface popularity was classified as not popular.
We found that @horizon-protocol/contracts-interface demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.