# @dfares/network > This package contains functions and classes useful for communicating with the blockchain. Latest version **7.1.4** (published 2024-08-11) · MIT license · 0 weekly downloads ## Install ```sh npm install @dfares/network pnpm add @dfares/network yarn add @dfares/network bun add @dfares/network ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 7.1.4 | | Published | 2024-08-11 | | First published | 2023-07-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=16 | | Dependencies | 15 | | Unpacked size | 177.3 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Author | 0xPARC | | Maintainers | cherryblue1024, bitddy | ## Links - npm: https://www.npmjs.com/package/@dfares/network - npm.io page: https://npm.io/package/@dfares/network ## Dependencies (15) - [uuid](https://npm.io/package/uuid.md) ^8.3.2 - [ethers](https://npm.io/package/ethers.md) ^5.5.1 - [lodash](https://npm.io/package/lodash.md) ^4.17.15 - [p-defer](https://npm.io/package/p-defer.md) ^3.0.0 - [p-retry](https://npm.io/package/p-retry.md) ^4.6.1 - [mnemonist](https://npm.io/package/mnemonist.md) ^0.38.1 - [p-timeout](https://npm.io/package/p-timeout.md) ^4.0.0 - [async-mutex](https://npm.io/package/async-mutex.md) ^0.3.2 - [@dfares/serde](https://npm.io/package/@dfares/serde.md) 7.1.4 - [@dfares/types](https://npm.io/package/@dfares/types.md) 7.1.4 - [just-debounce](https://npm.io/package/just-debounce.md) ^1.1.0 - [@dfares/events](https://npm.io/package/@dfares/events.md) 7.1.4 - [@dfares/constants](https://npm.io/package/@dfares/constants.md) 7.1.4 - [@dfares/contracts](https://npm.io/package/@dfares/contracts.md) 7.1.4 - [json-stable-stringify](https://npm.io/package/json-stable-stringify.md) ^1.0.1 ## Recent versions - 7.1.4 (latest) — 2024-08-11 - 6.8.14 — 2024-05-06 - 6.8.13 — 2024-04-27 - 6.8.12 — 2024-04-12 - 6.8.11 — 2024-04-12 - 6.8.10 — 2024-03-22 - 6.8.9 — 2024-03-22 - 6.8.8 — 2024-03-22 - 6.8.7 — 2024-03-19 - 6.8.6 — 2024-01-24 - 6.8.5 — 2023-11-17 - 6.8.4 — 2023-07-19 - 6.8.3 — 2023-07-19 - 6.8.2 — 2023-07-18 - 6.8.1 — 2023-07-15 ## README # @dfares/network This package contains functions and classes useful for communicating with the blockchain. ## Installation You can install this package using [`npm`](https://www.npmjs.com) or [`yarn`](https://classic.yarnpkg.com/lang/en/) by running: ```bash npm install --save @dfares/network ``` ```bash yarn add @dfares/network ``` When using this in a plugin, you might want to load it with [skypack](https://www.skypack.dev) ```js import * as network from 'http://cdn.skypack.dev/@dfares/network'; ``` ## Table of contents ### Classes - [ContractCaller](classes/ContractCaller.md) - [EthConnection](classes/EthConnection.md) - [ThrottledConcurrentQueue](classes/ThrottledConcurrentQueue.md) - [TxCollection](classes/TxCollection.md) - [TxExecutor](classes/TxExecutor.md) ### Interfaces - [ConcurrentQueueConfiguration](interfaces/ConcurrentQueueConfiguration.md) - [Queue](interfaces/Queue.md) ### Type aliases - [AfterTransaction](README.md#aftertransaction) - [BeforeQueued](README.md#beforequeued) - [BeforeTransaction](README.md#beforetransaction) - [ContractLoader](README.md#contractloader) - [GasPriceSettingProvider](README.md#gaspricesettingprovider) - [RetryErrorHandler](README.md#retryerrorhandler) ### Functions - [aggregateBulkGetter](README.md#aggregatebulkgetter) - [assertProperlySigned](README.md#assertproperlysigned) - [callWithRetry](README.md#callwithretry) - [createContract](README.md#createcontract) - [createEthConnection](README.md#createethconnection) - [ethToWei](README.md#ethtowei) - [getAutoGasPrices](README.md#getautogasprices) - [getGasSettingGwei](README.md#getgassettinggwei) - [gweiToWei](README.md#gweitowei) - [isPurchase](README.md#ispurchase) - [makeProvider](README.md#makeprovider) - [neverResolves](README.md#neverresolves) - [verifySignature](README.md#verifysignature) - [waitForTransaction](README.md#waitfortransaction) - [weiToEth](README.md#weitoeth) - [weiToGwei](README.md#weitogwei) ## Type aliases ### AfterTransaction Ƭ **AfterTransaction**: (`transactionRequest`: `Transaction`, `performanceMetrics`: `unknown`) => `Promise`<`void`\> #### Type declaration ▸ (`transactionRequest`, `performanceMetrics`): `Promise`<`void`\> [TxExecutor](classes/TxExecutor.md) calls this after executing a transaction. ##### Parameters | Name | Type | | :------------------- | :------------ | | `transactionRequest` | `Transaction` | | `performanceMetrics` | `unknown` | ##### Returns `Promise`<`void`\> --- ### BeforeQueued Ƭ **BeforeQueued**: (`id`: `TransactionId`, `intent`: `TxIntent`, `overrides?`: `providers.TransactionRequest`) => `Promise`<`void`\> #### Type declaration ▸ (`id`, `intent`, `overrides?`): `Promise`<`void`\> [TxExecutor](classes/TxExecutor.md) calls this before queueing a function to determine whether or not that function should be queued. If this function rejects, a transaction is not queued. ##### Parameters | Name | Type | | :----------- | :----------------------------- | | `id` | `TransactionId` | | `intent` | `TxIntent` | | `overrides?` | `providers.TransactionRequest` | ##### Returns `Promise`<`void`\> --- ### BeforeTransaction Ƭ **BeforeTransaction**: (`transactionRequest`: `Transaction`) => `Promise`<`void`\> #### Type declaration ▸ (`transactionRequest`): `Promise`<`void`\> [TxExecutor](classes/TxExecutor.md) calls this before executing a function to determine whether or not that function should execute. If this function rejects, the transaction is cancelled. ##### Parameters | Name | Type | | :------------------- | :------------ | | `transactionRequest` | `Transaction` | ##### Returns `Promise`<`void`\> --- ### ContractLoader Ƭ **ContractLoader**<`T`\>: (`address`: `string`, `provider`: `providers.JsonRpcProvider`, `signer?`: `Wallet`) => `Promise`<`T`\> #### Type parameters | Name | Type | | :--- | :----------------- | | `T` | extends `Contract` | #### Type declaration ▸ (`address`, `provider`, `signer?`): `Promise`<`T`\> ##### Parameters | Name | Type | | :--------- | :-------------------------- | | `address` | `string` | | `provider` | `providers.JsonRpcProvider` | | `signer?` | `Wallet` | ##### Returns `Promise`<`T`\> --- ### GasPriceSettingProvider Ƭ **GasPriceSettingProvider**: (`transactionRequest`: `Transaction`) => `AutoGasSetting` \| `string` #### Type declaration ▸ (`transactionRequest`): `AutoGasSetting` \| `string` Returns either a string that represents the gas price we should use by default for transactions, or a string that represents the fact that we should be using one of the automatic gas prices. ##### Parameters | Name | Type | | :------------------- | :------------ | | `transactionRequest` | `Transaction` | ##### Returns `AutoGasSetting` \| `string` --- ### RetryErrorHandler Ƭ **RetryErrorHandler**: (`i`: `number`, `e`: `Error`) => `void` #### Type declaration ▸ (`i`, `e`): `void` ##### Parameters | Name | Type | | :--- | :------- | | `i` | `number` | | `e` | `Error` | ##### Returns `void` ## Functions ### aggregateBulkGetter ▸ **aggregateBulkGetter**<`T`\>(`total`, `querySize`, `getterFn`, `onProgress?`, `offset?`): `Promise`<`T`[]\> A useful utility function that breaks up the proverbial number line (defined by {@code total} and {@code querySize}), and calls {@code getterFn} for each of the sections on the number line. #### Type parameters | Name | | :--- | | `T` | #### Parameters | Name | Type | Default value | Description | | :------------ | :-------------------------------------------------------------- | :------------ | :---------------------------------------------------------------------------------------------------------------------- | | `total` | `number` | `undefined` | the total amount of of items to get | | `querySize` | `number` | `undefined` | the chunk size | | `getterFn` | (`startIdx`: `number`, `endIdx`: `number`) => `Promise`<`T`[]\> | `undefined` | a function that fetches something, given a start index and end index | | `onProgress?` | (`fractionCompleted`: `number`) => `void` | `undefined` | whenever a chunk is loaded, this function is called with the fraction of individual items that have been loaded so far. | | `offset` | `number` | `0` | the index to start fetching, can be used to skip previously fetched elements. | #### Returns `Promise`<`T`[]\> a list of each of the individual items that were loaded. --- ### assertProperlySigned ▸ **assertProperlySigned**(`message`): `void` Ensures that the given message was properly signed. #### Parameters | Name | Type | | :-------- | :-------------------------- | | `message` | `SignedMessage`<`unknown`\> | #### Returns `void` --- ### callWithRetry ▸ **callWithRetry**<`T`\>(`fn`, `args?`, `onError?`, `maxRetries?`, `retryInterval?`): `Promise`<`T`\> Calls the given function, retrying it if there is an error. **`todo`** Get rid of this, and make use of [ContractCaller](classes/ContractCaller.md). #### Type parameters | Name | | :--- | | `T` | #### Parameters | Name | Type | Default value | | :-------------- | :------------------------------------------------- | :------------------------- | | `fn` | (...`args`: `any`[]) => `Promise`<`T`\> | `undefined` | | `args` | `any`[] | `[]` | | `onError?` | [`RetryErrorHandler`](README.md#retryerrorhandler) | `undefined` | | `maxRetries` | `12` | `DEFAULT_MAX_CALL_RETRIES` | | `retryInterval` | `number` | `1000` | #### Returns `Promise`<`T`\> --- ### createContract ▸ **createContract**<`C`\>(`contractAddress`, `contractABI`, `provider`, `signer?`): `C` #### Type parameters | Name | Type | | :--- | :----------------------- | | `C` | extends `Contract`<`C`\> | #### Parameters | Name | Type | Description | | :---------------- | :------------------ | :------------------------------------------------- | | `contractAddress` | `string` | the address of the contract you want to connect to | | `contractABI` | `ContractInterface` | a javacript object representing the ABI | | `provider` | `JsonRpcProvider` | - | | `signer?` | `Wallet` | - | #### Returns `C` --- ### createEthConnection ▸ **createEthConnection**(`rpcUrl`): `Promise`<[`EthConnection`](classes/EthConnection.md)\> #### Parameters | Name | Type | | :------- | :------- | | `rpcUrl` | `string` | #### Returns `Promise`<[`EthConnection`](classes/EthConnection.md)\> --- ### ethToWei ▸ **ethToWei**(`eth`): `BigNumber` Returns the given amount of eth in wei as a big integer. #### Parameters | Name | Type | | :---- | :------- | | `eth` | `number` | #### Returns `BigNumber` --- ### getAutoGasPrices ▸ **getAutoGasPrices**(): `Promise`<`GasPrices`\> Gets the current gas prices from blockchain's price oracle. If the oracle is broken, return some sane defaults. #### Returns `Promise`<`GasPrices`\> --- ### getGasSettingGwei ▸ **getGasSettingGwei**(`setting`, `gasPrices`): `number` \| `undefined` Given the user's auto gas setting, and the current set of gas prices on the network, returns the preferred gas price. If an invalid {@link AutoGasSetting} is provided, then returns undefined. #### Parameters | Name | Type | | :---------- | :--------------- | | `setting` | `AutoGasSetting` | | `gasPrices` | `GasPrices` | #### Returns `number` \| `undefined` --- ### gweiToWei ▸ **gweiToWei**(`gwei`): `BigNumber` Returns the given amount of gwei in wei as a big integer. #### Parameters | Name | Type | | :----- | :------- | | `gwei` | `number` | #### Returns `BigNumber` --- ### isPurchase ▸ **isPurchase**(`tx?`): `boolean` Whether or not some value is being transferred in this transaction. #### Parameters | Name | Type | | :---- | :------------------- | | `tx?` | `TransactionRequest` | #### Returns `boolean` --- ### makeProvider ▸ **makeProvider**(`rpcUrl`): `providers.JsonRpcProvider` Creates a new {@link JsonRpcProvider}, and makes sure that it's connected to blockchain if we're in production. #### Parameters | Name | Type | | :------- | :------- | | `rpcUrl` | `string` | #### Returns `providers.JsonRpcProvider` --- ### neverResolves ▸ **neverResolves**(): `Promise`<`void`\> A function that just never resolves.s #### Returns `Promise`<`void`\> --- ### verifySignature ▸ **verifySignature**(`message`, `signature`, `addr`): `boolean` Returns whether or not the given message was signed by the given address. #### Parameters | Name | Type | | :---------- | :-------------------------- | | `message` | `string` | | `signature` | `string` | | `addr` | `undefined` \| `EthAddress` | #### Returns `boolean` --- ### waitForTransaction ▸ **waitForTransaction**(`provider`, `txHash`): `Promise`<`providers.TransactionReceipt`\> Given a transaction hash and a JsonRpcProvider, waits for the given transaction to complete. #### Parameters | Name | Type | | :--------- | :---------------- | | `provider` | `JsonRpcProvider` | | `txHash` | `string` | #### Returns `Promise`<`providers.TransactionReceipt`\> --- ### weiToEth ▸ **weiToEth**(`wei`): `number` Returns the given amount of wei in gwei as a number. #### Parameters | Name | Type | | :---- | :---------- | | `wei` | `BigNumber` | #### Returns `number` --- ### weiToGwei ▸ **weiToGwei**(`wei`): `number` Returns the given amount of wei in gwei as a number. #### Parameters | Name | Type | | :---- | :---------- | | `wei` | `BigNumber` | #### Returns `number` --- _Source: https://npm.io/package/@dfares/network · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._