\n\n\n# Fireblocks Web3 Provider\n\nFireblocks [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Compatible Ethereum JavaScript Provider\n\n## Installation\n```bash\nnpm install @fireblocks/fireblocks-web3-provider\n```\n\n## Setup\n```js\nimport { FireblocksWeb3Provider, ChainId, ApiBaseUrl } from \"@fireblocks/fireblocks-web3-provider\";\n\nconst eip1193Provider = new FireblocksWeb3Provider({\n // apiBaseUrl: ApiBaseUrl.Sandbox // If using a sandbox workspace\n privateKey: process.env.FIREBLOCKS_API_PRIVATE_KEY_PATH,\n apiKey: process.env.FIREBLOCKS_API_KEY,\n vaultAccountIds: process.env.FIREBLOCKS_VAULT_ACCOUNT_IDS,\n chainId: ChainId.GOERLI,\n\n logTransactionStatusChanges: true, // Verbose logging\n})\n```\n\n## Usage with ethers.js\n```sh\nnpm install ethers\n```\n\n```js\nimport * as ethers from \"ethers\"\n\nconst provider = new ethers.BrowserProvider(eip1193Provider); \n\n// Or like this if you're using ethers v5:\n// const provider = new ethers.providers.Web3Provider(eip1193Provider); \n```\n\n## Usage with web3.js\n```sh\nnpm install web3\n```\n\n```js\nimport Web3 from \"web3\";\n\nconst web3 = new Web3(eip1193Provider);\n```\n\n## API Documentation\n\n### new FireblocksWeb3Provider(config)\n\n- `config` [FireblocksProviderConfig](#FireblocksProviderConfig)\n\nThis class is an [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Compatible Ethereum JavaScript Provider powered by the [Fireblocks API](https://docs.fireblocks.com/api/)\n\n### FireblocksProviderConfig\n\n```ts\ntype FireblocksProviderConfig = {\n // ------------- Mandatory fields -------------\n /** \n * Learn more about creating API users here: \n * https://developers.fireblocks.com/docs/quickstart#api-user-creation\n */\n\n /** \n * Fireblocks API key\n */\n apiKey: string,\n\n /** \n * Fireblocks API private key for signing requests\n */\n privateKey: string,\n\n // Either chainId or rpcUrl must be provided\n /** \n * If not provided, it is inferred from the rpcUrl \n */\n chainId?: ChainId,\n /** \n * If not provided, it is inferred from the chainId \n */\n rpcUrl?: string,\n\n // ------------- Optional fields --------------\n\n /** \n * By default, the first 20 vault accounts are dynamically loaded from the Fireblocks API\n * It is recommended to provide the vault account ids explicitly because it helps avoid unnecessary API calls\n */\n vaultAccountIds?: number | number[] | string | string[],\n /** \n * By default, it uses the Fireblocks API production endpoint\n * When using a sandbox workspace, you should provide the ApiBaseUrl.Sandbox value\n */\n apiBaseUrl?: ApiBaseUrl | string,\n /**\n * By default, the fallback fee level is set to FeeLevel.MEDIUM\n */\n fallbackFeeLevel?: FeeLevel,\n /**\n * By default, the note is set to \"Created by Fireblocks Web3 Provider\"\n */\n note?: string,\n /**\n * By default, the polling interval is set to 1000ms (1 second)\n * It is the interval in which the Fireblocks API is queried to check the status of transactions\n */\n pollingInterval?: number,\n /**\n * By default, it is assumed that one time addresses are enabled in your workspace\n * If they're not, set this to false\n */\n oneTimeAddressesEnabled?: boolean,\n /**\n * By default, no externalTxId is associated with transactions\n * If you want to set one, you can either provide a function that returns a string, or provide a string directly\n */\n externalTxId?: (() => string) | string,\n /**\n * If you want to prepend an additional product string to the User-Agent header, you can provide it here\n */\n userAgent?: string,\n /**\n * If you are using a private/custom EVM chain, you can provide its Fireblocks assetId here\n */\n assetId?: string,\n /**\n * Default: false\n * By setting to true, every transaction status change will be logged to the console\n * Same as setting env var `DEBUG=fireblocks-web3-provider:status`\n */\n logTransactionStatusChanges?: boolean,\n /**\n * Default: false\n * By setting to true, every request and response processed by the provider will be logged to the console\n * Same as setting env var `DEBUG=fireblocks-web3-provider:req_res`\n */\n logRequestsAndResponses?: boolean,\n /**\n * Default: true\n * By setting to true, every failed transaction will print additional information\n * helpful for debugging, such as a link to simulate the transaction on Tenderly\n * Same as setting env var `DEBUG=fireblocks-web3-provider:error`\n */\n enhancedErrorHandling?: boolean,\n /**\n * Proxy path in the format of `http(s)://user:pass@server`\n */\n proxyPath?: string\n}\n```\n","readmeFilename":"README.md"}
![\"accessibility](\"./logo.svg\"){kind=logo}
\n