@fordefi/web3-provider - npm Package Compare versions

Comparing version 0.1.0-dev.292fdb9 to 0.1.0-dev.43d557b

dist/index.d.ts

@@ -1,4 +0,16 @@
-import { Eip1193Provider } from 'web3-utils';
-import { Web3EthExecutionAPI, Web3APIMethod, Web3APIReturnType, Web3APIPayload, JsonRpcResponseWithResult, Web3ProviderStatus } from 'web3-types';
+import { EIP1474Methods, TypedDataDefinition, Hex, EIP1193Provider, Address as Address$1, EIP1193EventMap, EIP1193Events, ProviderDisconnectedError } from 'viem';
+import { Address } from 'abitype';
+import { EventEmitter } from 'node:events';
 
+type OmitFromArray<T extends any[], Condition> = {
+    [K in keyof T]: T[K] extends Condition ? never : T[K];
+} extends infer R ? {
+    [K in keyof R]: R[K];
+} : never;
+type PickFromArray<T extends any[], Condition> = {
+    [K in keyof T]: T[K] extends Condition ? T[K] : never;
+} extends infer R ? {
+    [K in keyof R]: R[K];
+} : never;
+
 /**
@@ -43,30 +55,266 @@ * Fordefi API
 
+/**
+ * Fordefi API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ */
+declare const EvmChainUniqueId: {
+    readonly _1: "evm_1";
+    readonly _5: "evm_5";
+    readonly _10: "evm_10";
+    readonly _56: "evm_56";
+    readonly _100: "evm_100";
+    readonly _137: "evm_137";
+    readonly _250: "evm_250";
+    readonly _324: "evm_324";
+    readonly _1030: "evm_1030";
+    readonly _1100: "evm_1100";
+    readonly _1101: "evm_1101";
+    readonly _2222: "evm_2222";
+    readonly _5000: "evm_5000";
+    readonly _7700: "evm_7700";
+    readonly _8453: "evm_8453";
+    readonly _80001: "evm_80001";
+    readonly _42161: "evm_42161";
+    readonly _43114: "evm_43114";
+    readonly _59144: "evm_59144";
+    readonly _11155111: "evm_11155111";
+    readonly ethereumMainnet: "evm_ethereum_mainnet";
+    readonly ethereumGoerli: "evm_ethereum_goerli";
+    readonly optimismMainnet: "evm_optimism_mainnet";
+    readonly bscMainnet: "evm_bsc_mainnet";
+    readonly gnosisMainnet: "evm_gnosis_mainnet";
+    readonly polygonMainnet: "evm_polygon_mainnet";
+    readonly fantomMainnet: "evm_fantom_mainnet";
+    readonly arbitrumMainnet: "evm_arbitrum_mainnet";
+    readonly avalancheChain: "evm_avalanche_chain";
+    readonly kavaMainnet: "evm_kava_mainnet";
+    readonly polygonMumbai: "evm_polygon_mumbai";
+    readonly ethereumSepolia: "evm_ethereum_sepolia";
+    readonly polygonZkevmMainnet: "evm_polygon_zkevm_mainnet";
+    readonly zksyncEraMainnet: "evm_zksync_era_mainnet";
+    readonly baseMainnet: "evm_base_mainnet";
+    readonly lineaMainnet: "evm_linea_mainnet";
+    readonly cantoMainnet: "evm_canto_mainnet";
+    readonly confluxMainnet: "evm_conflux_mainnet";
+    readonly mantleMainnet: "evm_mantle_mainnet";
+    readonly dymensionMainnet: "evm_dymension_mainnet";
+};
+type EvmChainUniqueId = typeof EvmChainUniqueId[keyof typeof EvmChainUniqueId];
+
+/**
+ * Fordefi API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ */
+declare const SignerType: {
+    readonly initiator: "initiator";
+    readonly apiSigner: "api_signer";
+    readonly endUser: "end_user";
+};
+type SignerType = typeof SignerType[keyof typeof SignerType];
+
+/**
+ * Fordefi API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ */
+declare const ChainUniqueId: {
+    readonly cosmosAkashnet2: "cosmos_akashnet-2";
+    readonly cosmosArchway1: "cosmos_archway-1";
+    readonly cosmosAxelarDojo1: "cosmos_axelar-dojo-1";
+    readonly cosmosCelestia: "cosmos_celestia";
+    readonly cosmosCosmoshub4: "cosmos_cosmoshub-4";
+    readonly cosmosDydxMainnet1: "cosmos_dydx-mainnet-1";
+    readonly cosmosDydxTestnet4: "cosmos_dydx-testnet-4";
+    readonly cosmosDymension11001: "cosmos_dymension_1100-1";
+    readonly cosmosNoble1: "cosmos_noble-1";
+    readonly cosmosOsmosis1: "cosmos_osmosis-1";
+    readonly cosmosPacific1: "cosmos_pacific-1";
+    readonly cosmosStride1: "cosmos_stride-1";
+    readonly evm1: "evm_1";
+    readonly evm5: "evm_5";
+    readonly evm10: "evm_10";
+    readonly evm56: "evm_56";
+    readonly evm100: "evm_100";
+    readonly evm137: "evm_137";
+    readonly evm250: "evm_250";
+    readonly evm324: "evm_324";
+    readonly evm1030: "evm_1030";
+    readonly evm1100: "evm_1100";
+    readonly evm1101: "evm_1101";
+    readonly evm2222: "evm_2222";
+    readonly evm5000: "evm_5000";
+    readonly evm7700: "evm_7700";
+    readonly evm8453: "evm_8453";
+    readonly evm80001: "evm_80001";
+    readonly evm42161: "evm_42161";
+    readonly evm43114: "evm_43114";
+    readonly evm59144: "evm_59144";
+    readonly evm11155111: "evm_11155111";
+    readonly evmEthereumMainnet: "evm_ethereum_mainnet";
+    readonly evmEthereumGoerli: "evm_ethereum_goerli";
+    readonly evmOptimismMainnet: "evm_optimism_mainnet";
+    readonly evmBscMainnet: "evm_bsc_mainnet";
+    readonly evmGnosisMainnet: "evm_gnosis_mainnet";
+    readonly evmPolygonMainnet: "evm_polygon_mainnet";
+    readonly evmFantomMainnet: "evm_fantom_mainnet";
+    readonly evmArbitrumMainnet: "evm_arbitrum_mainnet";
+    readonly evmAvalancheChain: "evm_avalanche_chain";
+    readonly evmKavaMainnet: "evm_kava_mainnet";
+    readonly evmPolygonMumbai: "evm_polygon_mumbai";
+    readonly evmEthereumSepolia: "evm_ethereum_sepolia";
+    readonly evmPolygonZkevmMainnet: "evm_polygon_zkevm_mainnet";
+    readonly evmZksyncEraMainnet: "evm_zksync_era_mainnet";
+    readonly evmBaseMainnet: "evm_base_mainnet";
+    readonly evmLineaMainnet: "evm_linea_mainnet";
+    readonly evmCantoMainnet: "evm_canto_mainnet";
+    readonly evmConfluxMainnet: "evm_conflux_mainnet";
+    readonly evmMantleMainnet: "evm_mantle_mainnet";
+    readonly evmDymensionMainnet: "evm_dymension_mainnet";
+    readonly solanaMainnet: "solana_mainnet";
+    readonly solanaDevnet: "solana_devnet";
+    readonly bitcoinMainnet: "bitcoin_mainnet";
+    readonly bitcoinTestnet: "bitcoin_testnet";
+};
+type ChainUniqueId = typeof ChainUniqueId[keyof typeof ChainUniqueId];
+
+/**
+ * Fordefi API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ */
+declare const UserType: {
+    readonly person: "person";
+    readonly apiSigner: "api_signer";
+    readonly apiUser: "api_user";
+};
+type UserType = typeof UserType[keyof typeof UserType];
+
+type SignTypedDataV4 = {
+    Method: 'eth_signTypedData_v4';
+    Parameters: [address: Address, message: TypedDataDefinition];
+    ReturnType: Hex;
+};
+type SignTypedDataV3 = Omit<SignTypedDataV4, 'Method'> & {
+    Method: 'eth_signTypedData_v3';
+};
+type SignTypedData = Omit<SignTypedDataV4, 'Method'> & {
+    Method: 'eth_signTypedData';
+};
+type Methods = [
+    ...OmitFromArray<EIP1474Methods, {
+        Method: 'eth_signTypedData_v4';
+    }>,
+    SignTypedData,
+    SignTypedDataV3,
+    SignTypedDataV4
+];
+type Method = Methods[number]['Method'];
+type RequestArgs<M extends Method | undefined = Method | undefined> = M extends Method ? {
+    method: M;
+} & (Extract<Methods[number], {
+    Method: M;
+}>['Parameters'] extends never | undefined ? {
+    params?: unknown | undefined;
+} : {
+    params: Extract<Methods[number], {
+        Method: M;
+    }>['Parameters'];
+}) : {
+    method: string;
+    params?: unknown | undefined;
+};
+type MethodReturnType<M extends Method | undefined = Method | undefined> = M extends Method ? PickFromArray<Methods, {
+    Method: M;
+}>[number]['ReturnType'] : unknown;
+type FordefiEIP1193Provider = Omit<EIP1193Provider, 'request'> & {
+    request<M extends Method>(args: RequestArgs<M>): Promise<MethodReturnType<M>>;
+};
+interface UserInfo {
+    id: string;
+    userType: UserType;
+    signerType: SignerType;
+}
+
 interface FordefiProviderConfig {
-    /** Fallback rpc provider url */
-    rpcUrl: string;
-    /** Fordefi organization ID managing this address' vault */
-    organizationId: string;
-    /** Chain ID as a number, see https://chainid.network/chains_mini.json */
-    chainId: EvmChainId;
-    /** EVM address */
-    address: string;
-    /** Fordefi API base url, used for development, default is the production url */
-    apiBaseUrl?: string;
-    /** Fordefi API user token issued via the Fordefi Web Console */
+    /** Chain ID as a number or a named chain. For example for sepolia use `11155111` or `EvmChainId.NUMBER_11155111` or `EvmChainUniqueId.ethereumSepolia` */
+    chainId: EvmChainId | EvmChainUniqueId;
+    /** EVM address. For example `'0x1234567890123456789012345678901234567890'` */
+    address: Address$1;
+    /** Fordefi API user token (base64 encoded) issued via the Fordefi Web Console */
     apiUserToken: string;
-    /** Private key used to sign the body of requests to the Fordefi API */
+    /** Private key in PEM format used to sign the body of requests sent to the Fordefi API - the content of the private key `.pem`, see {@link https://docs.fordefi.com/reference/pair-an-api-client-with-the-api-signer).} */
     apiPayloadSignKey: string;
+    /** Fordefi API base url (used for development), defaults to production url. For example 'https://api.fordefi.com' */
+    apiBaseUrl?: string;
+    /** Fallback JSON-RPC HTTP node url. Methods not implemented by this provider will pass through to this node. For example 'https://rpc.sepolia.org' */
+    rpcUrl?: string;
 }
-type FordefiProviderWeb3API = Web3EthExecutionAPI;
-type JsonRpcResultType<M extends Web3APIMethod<FordefiProviderWeb3API>> = M extends FordefiHandledMethod ? Web3APIReturnType<FordefiProviderWeb3API, M> : Web3APIReturnType<FordefiProviderWeb3API, M> | unknown;
-type FordefiHandledMethod = keyof FordefiProviderWeb3API & ('eth_chainId' | 'eth_accounts' | 'eth_requestAccounts' | 'personal_sign' | 'eth_signTypedData' | 'eth_signTypedData_v4' | 'eth_signTransaction' | 'eth_sendTransaction');
 
-declare class FordefiWeb3Provider extends Eip1193Provider<FordefiProviderWeb3API> {
+/**
+ * Helper to promisify waiting for given emitter's emitted event
+ *
+ * @param eventEmitter - instance of an {@link EventEmitter}
+ */
+declare const waitForEmittedEvent: (eventEmitter: EventEmitter) => <Event extends keyof EIP1193EventMap>(event: Event, timeoutMs?: number) => Promise<Parameters<EIP1193EventMap[Event]>[number]>;
+
+/**
+ * Web3 provider that implements EIP-1193.
+ *
+ * Auto connects after construction and emits a 'connect' event.
+ * To wait until connected either pass a callback to `provider.on('connect', cb)` or use the helper `await provider.waitForEmittedEvent('connect')`.
+ * Notice: register any event listeners immediately after creating a new instance, and before any asynchronous operations
+ * or event loop tasks are scheduled.
+ */
+declare class FordefiWeb3Provider implements FordefiEIP1193Provider {
+    readonly on: EIP1193Events['on'];
+    readonly removeListener: EIP1193Events['removeListener'];
+    readonly waitForEmittedEvent: ReturnType<typeof waitForEmittedEvent>;
+    private readonly eventEmitter;
+    private readonly apiClient;
+    private readonly config;
     private chain;
     private vault;
-    private readonly address;
-    private readonly chainId;
-    private readonly apiPayloadSignKey;
-    private readonly jsonRpcProvider;
-    private readonly apiClient;
+    private status;
     constructor(config: FordefiProviderConfig);
@@ -76,15 +324,9 @@ /**
      *
-     * @see {@link FordefiHandledMethod} for methods handled by Fordefi
-     * @see {@link FordefiProviderWeb3API} for the full list of methods
-     * @see {@link https://ethereum.github.io/execution-apis/api-documentation/} for Ethereum JSON RPC methods
-     * @see {@link https://eips.ethereum.org/EIPS/eip-1102} for EIP-1102 `eth_requestAccounts` method
+     * @param args json rpc request payload
+     * @returns a promise with a response
      *
-     * @param payload - the json rpc request payload
-     * @returns a promise with the response from the provider as a json rpc response object
-     *
-     * @throws FordefiProviderError if a failure originated from failure on methods implemented by Fordefi
-     * @throws FallbackProviderError if a failure originated from failure on an external fallback rpc node
-     * Errors are
+     * @throws RpcError with error codes defined in {@link RpcErrorCode} and {@link ProviderRpcErrorCode}
      */
-    request<Method extends Web3APIMethod<FordefiProviderWeb3API>>(payload: Web3APIPayload<FordefiProviderWeb3API, Method>): Promise<JsonRpcResponseWithResult<JsonRpcResultType<Method>>>;
+    request<M extends Method>(args: RequestArgs<M>): Promise<MethodReturnType<M>>;
+    private jsonRpcHttpRequestFn;
     private ethChainId;
@@ -98,15 +340,31 @@ private ethAccounts;
     private _invokeCreateTransaction;
-    private _getConnectedEntities;
-    private _throwIfDisconnected;
-    connect(): void;
+    private _getFordefiChainVault;
+    private _throwIfNotConnected;
+    /**
+     * Connects the provider and emits a 'connect' event.
+     * If already connected, does nothing.
+     * If connecting, waits for the connection to be established.
+     *
+     * @returns a promise of that resolves once connected
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnects the provider and emits a 'disconnect' event.
+     */
     disconnect(): void;
-    getStatus(): Web3ProviderStatus;
-    supportsSubscriptions(): boolean;
-    reset(): void;
-    on(): void;
-    removeListener(): void;
-    removeAllListeners(): void;
-    once(): void;
+    _onDisconnect(): ProviderDisconnectedError;
+    /**
+     * Returns the current status of the provider
+     *
+     * @returns 'connected' if the provider is connected, 'connecting' if trying to connect, 'disconnected' otherwise.
+     */
+    getStatus(): "connected" | "connecting" | "disconnected";
+    /**
+     * Returns the user info of the API user associated with this provider
+     *
+     * @returns API user info
+     */
+    getUserInfo(): UserInfo;
 }
 
-export { EvmChainId, type FordefiProviderConfig, type FordefiProviderWeb3API, FordefiWeb3Provider };
+export { ChainUniqueId, EvmChainId, type FordefiProviderConfig, FordefiWeb3Provider, type Method, type MethodReturnType, type Methods, type RequestArgs, SignerType, type UserInfo, UserType };

package.json

 {
   "name": "@fordefi/web3-provider",
-  "version": "0.1.0-dev.292fdb9",
+  "version": "0.1.0-dev.43d557b",
   "description": "Web3 Provider and signer compatible with EIP-1193",
@@ -9,3 +9,3 @@ "author": "Gil Meir <[e-mail]>",
     "type": "git",
-    "url": "[e-mail]:fordefihq/web3-provider.git"
+    "url": "[e-mail]:FordefiHQ/web3-provider.git"
   },
@@ -20,3 +20,2 @@ "private": false,
   ],
-  "license": "MIT",
   "keywords": [
@@ -30,21 +29,23 @@ "Web3",
     "MPC",
-    "Fordefi"
+    "Fordefi",
+    "Cryptocurrency"
   ],
   "scripts": {
     "clean": "rm -rf dist",
-    "typecheck": "tsc --noEmit",
-    "lint": "yarn eslint . --max-warnings=0",
-    "lint:fix": "yarn lint --fix",
+    "ts:check": "tsc --noEmit",
+    "lint:check": "yarn eslint . --max-warnings=0 --no-warn-ignored",
+    "lint:fix": "yarn lint:check --fix",
     "build": "yarn clean && tsup-node src/index.ts --format cjs,esm --dts",
     "test": "jest",
-    "publish-beta": "exit 1 && yarn build && yarn publish --no-git-tag-version --tag beta",
-    "publish-latest": "exit 1 && yarn build && yarn publish --tag latest",
+    "publish:dev": "yarn build && yarn publish --no-git-tag-version --tag beta",
+    "publish:latest": "yarn build && yarn publish --tag latest",
     "version-beta": "echo \"${npm_package_version}-dev.$(git rev-parse --short HEAD)\""
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.0.2",
-    "@eslint/js": "^9.0.0",
+    "@changesets/cli": "^2.27.1",
+    "@eslint/eslintrc": "^2.1.4",
+    "@eslint/js": "^8.57.0",
     "@types/eslint": "^8.56.8",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/parser": "^7.6.0",
+    "@typescript-eslint/parser": "~7.2.0",
     "dotenv": "^16.4.5",
@@ -57,3 +58,3 @@ "eslint": "^8.0.1",
     "eslint-plugin-jest": "^28.2.0",
-    "eslint-plugin-markdown": "^4.0.1",
+    "eslint-plugin-markdown": "^3.0.1",
     "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
@@ -72,17 +73,10 @@ "eslint-plugin-prettier": "^5.1.3",
     "typescript": "^5.4.3",
-    "typescript-eslint": "^7.6.0"
+    "typescript-eslint": "~7.2.0"
   },
   "dependencies": {
-    "ethers": "^6.11.1",
-    "viem": "^2.9.6",
-    "web3-providers-http": "^4.1.0"
+    "viem": "^2.8.6"
   },
-  "lint-staged": [
-    "lint",
-    "typecheck"
-  ],
-  "engines": {
-    "node": "~18.19.1",
-    "yarn": "~1.22.20"
+  "lint-staged": {
+    "*.ts": "yarn lint:fix"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

731990

increased by3.45%

Dependency count

1

decreased by-66.67%

Lines of code

19641

increased by2.33%

Worsened metrics

Dev dependency count

28

increased by3.7%

Dependency changes

• + Added@adraffy/ens-normalize@1.11.0(transitive)

• - Removedethers@^6.11.1

• - Removedweb3-providers-http@^4.1.0

• - Removed@adraffy/ens-normalize@1.10.1(transitive)

• - Removed@noble/curves@1.2.01.4.2(transitive)

• - Removed@noble/hashes@1.3.21.4.0(transitive)

• - Removed@scure/base@1.1.9(transitive)

• - Removed@scure/bip32@1.4.0(transitive)

• - Removed@scure/bip39@1.3.0(transitive)

• - Removed@types/node@22.7.5(transitive)

• - Removedaes-js@4.0.0-beta.5(transitive)

• - Removedavailable-typed-arrays@1.0.7(transitive)

• - Removedcall-bind@1.0.8(transitive)

• - Removedcall-bind-apply-helpers@1.0.2(transitive)

• - Removedcall-bound@1.0.3(transitive)

• - Removedcross-fetch@4.1.0(transitive)

• - Removeddefine-data-property@1.1.4(transitive)

• - Removeddunder-proto@1.0.1(transitive)

• - Removedes-define-property@1.0.1(transitive)

• - Removedes-errors@1.3.0(transitive)

• - Removedes-object-atoms@1.1.1(transitive)

• - Removedethereum-cryptography@2.2.1(transitive)

• - Removedethers@6.13.5(transitive)

• - Removedfor-each@0.3.5(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedget-intrinsic@1.3.0(transitive)

• - Removedget-proto@1.0.1(transitive)

• - Removedgopd@1.2.0(transitive)

• - Removedhas-property-descriptors@1.0.2(transitive)

• - Removedhas-symbols@1.1.0(transitive)

• - Removedhas-tostringtag@1.0.2(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedis-arguments@1.2.0(transitive)

• - Removedis-callable@1.2.7(transitive)

• - Removedis-generator-function@1.1.0(transitive)

• - Removedis-regex@1.2.1(transitive)

• - Removedis-typed-array@1.1.15(transitive)

• - Removedmath-intrinsics@1.1.0(transitive)

• - Removednode-fetch@2.7.0(transitive)

• - Removedpossible-typed-array-names@1.1.0(transitive)

• - Removedsafe-regex-test@1.1.0(transitive)

• - Removedset-function-length@1.2.2(transitive)

• - Removedtr46@0.0.3(transitive)

• - Removedtslib@2.7.0(transitive)

• - Removedundici-types@6.19.8(transitive)

• - Removedutil@0.12.5(transitive)

• - Removedweb3-errors@1.3.1(transitive)

• - Removedweb3-providers-http@4.2.0(transitive)

• - Removedweb3-types@1.10.0(transitive)

• - Removedweb3-utils@4.3.3(transitive)

• - Removedweb3-validator@2.0.6(transitive)

• - Removedwebidl-conversions@3.0.1(transitive)

• - Removedwhatwg-url@5.0.0(transitive)

• - Removedwhich-typed-array@1.1.18(transitive)

• - Removedws@8.17.1(transitive)

• - Removedzod@3.24.2(transitive)

• Updatedviem@^2.8.6