@fireblocks/fireblocks-web3-provider - npm Package Compare versions

Comparing version 0.0.9 to 1.0.0

dist/types.d.ts

@@ -38,7 +38,7 @@ import { FeeLevel } from "fireblocks-sdk";
 export declare type FireblocksProviderConfig = {
+    apiKey: string;
     privateKey: string;
-    apiKey: string;
-    vaultAccountIds?: number | number[] | string | string[];
     chainId?: ChainId;
     rpcUrl?: string;
+    vaultAccountIds?: number | number[] | string | string[];
     fallbackFeeLevel?: FeeLevel;
@@ -45,0 +45,0 @@ note?: string;

package.json

 {
   "name": "@fireblocks/fireblocks-web3-provider",
-  "version": "0.0.9",
+  "version": "1.0.0",
   "description": "EIP-1193 Compatible Ethereum provider for Fireblocks",
@@ -5,0 +5,0 @@ "repository": "github:fireblocks/fireblocks-web3-provider",

README.md

 [![npm version](https://badge.fury.io/js/@fireblocks%2Ffireblocks-web3-provider.svg)](https://badge.fury.io/js/@fireblocks%2Ffireblocks-web3-provider)
 
 # Fireblocks Web3 Provider
-> **Warning**  
-> This package is in a beta stage and should be used at your own risk.  
-> The provided interfaces might go through backwards-incompatibale changes.  
-> For a more stable library (with a different paradigm) you can use the DeFi SDK (https://github.com/fireblocks/fireblocks-defi-sdk)
 
-
 Fireblocks [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Compatible Ethereum JavaScript Provider
@@ -42,1 +37,45 @@
 ```
+
+## API Documentation
+
+### new FireblocksWeb3Provider(config)
+
+- `config` [FireblocksProviderConfig](#FireblocksProviderConfig)
+
+This 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/)
+
+### FireblocksProviderConfig
+
+```ts
+export type FireblocksProviderConfig = {
+  // # Mandatory fields
+
+  // Learn more about creating API users here: 
+  // https://support.fireblocks.io/hc/en-us/articles/4407823826194-Adding-new-API-users
+  apiKey: string,
+  privateKey: string,
+  
+  // Either chainId or rpcUrl must be provided
+  chainId?: ChainId, // If not provided, it is inferred from the rpcUrl
+  rpcUrl?: string, // If not provided, it is inferred from the chainId
+  
+  // # Optional fields
+
+  // By default, the first 20 vault accounts are dynamically loaded from the Fireblocks API
+  // It is recommended to provide the vault account ids explicitly because it helps avoid unnecessary API calls
+  vaultAccountIds?: number | number[] | string | string[],
+  // By default, the fallback fee level is set to FeeLevel.MEDIUM
+  fallbackFeeLevel?: FeeLevel,
+  // By default, the note is set to "Created by Fireblocks Web3 Provider"
+  note?: string,
+  // By default, the polling interval is set to 1000ms (1 second)
+  // It is the interval in which the Fireblocks API is queried to check the status of transactions
+  pollingInterval?: number,
+  // By default, it is assumed that one time addresses are enabled in your workspace
+  // If they're not, set this to false
+  oneTimeAddressesEnabled?: boolean,
+  // By default, no externalTxId is associated with transactions
+  // If you want to set one, you can either provide a function that returns a string, or provide a string directly
+  externalTxId?: (() => string) | string,
+}
+```

src/types.ts

@@ -42,12 +42,31 @@ import { FeeLevel } from "fireblocks-sdk";
 export type FireblocksProviderConfig = {
+  // # Mandatory fields
+
+  // Learn more about creating API users here: 
+  // https://support.fireblocks.io/hc/en-us/articles/4407823826194-Adding-new-API-users
+  apiKey: string,
   privateKey: string,
-  apiKey: string,
+  
+  // Either chainId or rpcUrl must be provided
+  chainId?: ChainId, // If not provided, it is inferred from the rpcUrl
+  rpcUrl?: string, // If not provided, it is inferred from the chainId
+  
+  // # Optional fields
+
+  // By default, the first 20 vault accounts are dynamically loaded from the Fireblocks API
+  // It is recommended to provide the vault account ids explicitly because it helps avoid unnecessary API calls
   vaultAccountIds?: number | number[] | string | string[],
-  chainId?: ChainId,
-  rpcUrl?: string,
+  // By default, the fallback fee level is set to FeeLevel.MEDIUM
   fallbackFeeLevel?: FeeLevel,
+  // By default, the note is set to "Created by Fireblocks Web3 Provider"
   note?: string,
+  // By default, the polling interval is set to 1000ms (1 second)
+  // It is the interval in which the Fireblocks API is queried to check the status of transactions
   pollingInterval?: number,
+  // By default, it is assumed that one time addresses are enabled in your workspace
+  // If they're not, set this to false
   oneTimeAddressesEnabled?: boolean,
+  // By default, no externalTxId is associated with transactions
+  // If you want to set one, you can either provide a function that returns a string, or provide a string directly
   externalTxId?: (() => string) | string,
 }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

70738

increased by3.95%

Lines of code

1004

increased by1.52%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

81

increased by92.86%

No dependency changes