diff --git a/README.md b/README.md index 2fb8cb2..7a5e6c9 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,19 @@ This is a library providing convenient and fast access to oracles for Tornado-sp
-* Create `.npmrc` file in project root with content `@tornado:registry=https://git.tornado.ws/api/packages/tornado-packages/npm/` -* Run `npm i @tornado/tornado-oracles` - - +- Create `.npmrc` file in project root with content `@tornado:registry=https://git.tornado.ws/api/packages/tornado-packages/npm/` +- Run `npm i @tornado/tornado-oracles` ### Import
```typescript -const {TornadoFeeOracleV5, TornadoFeeOracleV5, TokenPriceOracle} = require('@tornado/tornado-oracles') +const { TornadoFeeOracleV5, TornadoFeeOracleV5, TokenPriceOracle } = require('@tornado/tornado-oracles'); or -import {TornadoFeeOracleV5, TornadoFeeOracleV5, TokenPriceOracle} from '@tornado/tornado-oracles' +import { TornadoFeeOracleV5, TornadoFeeOracleV5, TokenPriceOracle } from '@tornado/tornado-oracles'; ``` - - ### Usage
@@ -30,31 +26,31 @@ import {TornadoFeeOracleV5, TornadoFeeOracleV5, TokenPriceOracle} from '@tornado ##### Estimate withdrawal gas costs ```typescript -import { TornadoFeeOracleV5 } from '@tornado/tornado-oracles' +import { TornadoFeeOracleV5 } from '@tornado/tornado-oracles'; const tx: TransactionData = { - to: tornadoProxyLightAddress, - data: poolInstance.methods.withdraw(...params).encodeABI(), - value: withdrawalProofArgs[5] -} + to: tornadoProxyLightAddress, + data: poolInstance.methods.withdraw(...params).encodeABI(), + value: withdrawalProofArgs[5], +}; -const feeOracle = new TornadoFeeOracleV5(1, "https://eth.llamarpc.com"); // First parameter - chain ID -const withdrawalGas = await feeOracle.getGas(tx, "relayer_withdrawal"); +const feeOracle = new TornadoFeeOracleV5(1, 'https://eth.llamarpc.com'); // First parameter - chain ID +const withdrawalGas = await feeOracle.getGas(tx, 'relayer_withdrawal'); ``` ##### Estimate gas price and gas limit to send transaction ```typescript -import { TornadoFeeOracleV5 } from '@tornado/tornado-oracles' +import { TornadoFeeOracleV5 } from '@tornado/tornado-oracles'; const incompleteTx: TransactionData = { - to: tornadoProxyLightAddress, - data: poolInstance.methods.withdraw(...params).encodeABI(), - value: withdrawalProofArgs[5] -} + to: tornadoProxyLightAddress, + data: poolInstance.methods.withdraw(...params).encodeABI(), + value: withdrawalProofArgs[5], +}; -const feeOracle = new TornadoFeeOracleV5(1, "https://eth.llamarpc.com"); -const transactionType: TxType = "relayer_withdrawal"; +const feeOracle = new TornadoFeeOracleV5(1, 'https://eth.llamarpc.com'); +const transactionType: TxType = 'relayer_withdrawal'; const gasPrice = await feeOracle.getGasPriceInHex(transactionType); const gasLimit = await feeOracle.getGasLimit(incompleteTx, transactionType); @@ -64,9 +60,9 @@ const tx: TransactionData = Object.assign({ gasPrice, gasLimit }, incompleteTx); ##### Get token prices (rate to ETH) for tokens that used in Tornado ```typescript -import { TokenPriceOracle } from '@tornado/tornado-oracles' +import { TokenPriceOracle } from '@tornado/tornado-oracles'; -const priceOracle = new TokenPriceOracle("https://eth.llamarpc.com"); +const priceOracle = new TokenPriceOracle('https://eth.llamarpc.com'); const tokenPrices = await priceOracle.fetchPrices(); console.log(tokenPrices); // All prices in WEI @@ -84,4 +80,4 @@ console.log(tokenPrices); // All prices in WEI ### License -[MIT](LICENSE) \ No newline at end of file +[MIT](LICENSE)