bitski-provider - npm Package Compare versions

Comparing version 3.4.0 to 3.5.0

CHANGELOG.md

 # bitski-provider
 
+## 3.5.0
+
+### Minor Changes
+
+- [#470](https://github.com/BitskiCo/bitski-js/pull/470) [`4b8ba8ae9556c77c7c1e404802c32e2e282a2f1d`](https://github.com/BitskiCo/bitski-js/commit/4b8ba8ae9556c77c7c1e404802c32e2e282a2f1d) Thanks [@chronicIntrovert](https://github.com/chronicIntrovert)! - Expose additional signing context in SDK; change type to Record<string, unknown>
+
 ## 3.4.0
@@ -4,0 +10,0 @@

dist/bitski-provider.js

@@ -54,2 +54,3 @@ import SafeEventEmitter from '@metamask/safe-event-emitter';
         else if (clientId) {
+            // eslint-disable-next-line no-console
             console.warn('clientId is deprecated, please use appId instead');
@@ -78,6 +79,7 @@ }
         if (apiBaseUrl.endsWith('/v1')) {
+            // eslint-disable-next-line no-console
             console.warn('apiBaseUrl should not end with /v1 in new versions, please remove the trailing /v1');
             apiBaseUrl = apiBaseUrl.slice(0, -3);
         }
-        this.config = Object.assign(Object.assign({}, config), { fetch: (_b = config.fetch) !== null && _b !== void 0 ? _b : fetch, additionalHeaders: Object.assign({ 'X-API-KEY': appId, 'X-CLIENT-ID': appId, 'X-CLIENT-VERSION': "bitski-provider-v3.4.0" }, ((_c = config.additionalHeaders) !== null && _c !== void 0 ? _c : {})), apiBaseUrl, signerBaseUrl: (_d = config.signerBaseUrl) !== null && _d !== void 0 ? _d : BITSKI_SIGNER_BASE_URL, store: (_e = config.store) !== null && _e !== void 0 ? _e : new LocalStorageStore(), sign });
+        this.config = Object.assign(Object.assign({}, config), { fetch: (_b = config.fetch) !== null && _b !== void 0 ? _b : fetch, additionalHeaders: Object.assign({ 'X-API-KEY': appId, 'X-CLIENT-ID': appId, 'X-CLIENT-VERSION': "bitski-provider-v3.5.0" }, ((_c = config.additionalHeaders) !== null && _c !== void 0 ? _c : {})), apiBaseUrl, signerBaseUrl: (_d = config.signerBaseUrl) !== null && _d !== void 0 ? _d : BITSKI_SIGNER_BASE_URL, store: (_e = config.store) !== null && _e !== void 0 ? _e : new LocalStorageStore(), sign });
         this.store = new BitskiProviderStateStore(this.config.store);
@@ -84,0 +86,0 @@ // Setup the engine

lib/bitski-provider.js

@@ -60,2 +60,3 @@ "use strict";
         else if (clientId) {
+            // eslint-disable-next-line no-console
             console.warn('clientId is deprecated, please use appId instead');
@@ -84,6 +85,7 @@ }
         if (apiBaseUrl.endsWith('/v1')) {
+            // eslint-disable-next-line no-console
             console.warn('apiBaseUrl should not end with /v1 in new versions, please remove the trailing /v1');
             apiBaseUrl = apiBaseUrl.slice(0, -3);
         }
-        this.config = Object.assign(Object.assign({}, config), { fetch: (_b = config.fetch) !== null && _b !== void 0 ? _b : fetch, additionalHeaders: Object.assign({ 'X-API-KEY': appId, 'X-CLIENT-ID': appId, 'X-CLIENT-VERSION': "bitski-provider-v3.4.0" }, ((_c = config.additionalHeaders) !== null && _c !== void 0 ? _c : {})), apiBaseUrl, signerBaseUrl: (_d = config.signerBaseUrl) !== null && _d !== void 0 ? _d : constants_1.BITSKI_SIGNER_BASE_URL, store: (_e = config.store) !== null && _e !== void 0 ? _e : new store_1.LocalStorageStore(), sign });
+        this.config = Object.assign(Object.assign({}, config), { fetch: (_b = config.fetch) !== null && _b !== void 0 ? _b : fetch, additionalHeaders: Object.assign({ 'X-API-KEY': appId, 'X-CLIENT-ID': appId, 'X-CLIENT-VERSION': "bitski-provider-v3.5.0" }, ((_c = config.additionalHeaders) !== null && _c !== void 0 ? _c : {})), apiBaseUrl, signerBaseUrl: (_d = config.signerBaseUrl) !== null && _d !== void 0 ? _d : constants_1.BITSKI_SIGNER_BASE_URL, store: (_e = config.store) !== null && _e !== void 0 ? _e : new store_1.LocalStorageStore(), sign });
         this.store = new store_1.BitskiProviderStateStore(this.config.store);
@@ -90,0 +92,0 @@ // Setup the engine

lib/types.d.ts

@@ -29,3 +29,3 @@ import { EthChainDefinition, EthEvent, EthEventParams, EthMethod, EthMethodParams, EthRequest, EthResult } from 'eth-provider-types';
     disableValidation?: boolean;
-    additionalSigningContext?: Record<string, string>;
+    additionalSigningContext?: Record<string, unknown>;
     appId?: string;
@@ -32,0 +32,0 @@ /** @deprecated switch to appId */

lib/utils/transaction.d.ts

@@ -43,2 +43,2 @@ import { EthTransactionSend, TypedData } from 'eth-provider-types';
  */
-export declare const createBitskiTransaction: <T extends EthSignMethod>(method: T, params: EthSignMethodParams[T], chain: EthChainDefinitionWithRpcUrl, paymaster?: PaymasterDefinition | PaymasterDefinition[], additionalContext?: Record<string, string>) => Transaction;
+export declare const createBitskiTransaction: <T extends EthSignMethod>(method: T, params: EthSignMethodParams[T], chain: EthChainDefinitionWithRpcUrl, paymaster?: PaymasterDefinition | PaymasterDefinition[], additionalContext?: Record<string, unknown>) => Transaction;

package.json

@@ -12,3 +12,3 @@ {
   },
-  "version": "3.4.0",
+  "version": "3.5.0",
   "scripts": {
@@ -15,0 +15,0 @@ "test": "jest",

README.md

@@ -50,3 +50,3 @@ # Bitski Provider
   // that is attempting to sign
-  additionalSigningContext?: Record<string, string>;
+  additionalSigningContext?: Record<string, unknown>;
 
@@ -53,0 +53,0 @@ // The API base URL for RPC and other API requests. Defaults to

src/bitski-provider.ts

@@ -84,2 +84,3 @@ import SafeEventEmitter from '@metamask/safe-event-emitter';
     } else if (clientId) {
+      // eslint-disable-next-line no-console
       console.warn('clientId is deprecated, please use appId instead');
@@ -115,2 +116,3 @@ }
     if (apiBaseUrl.endsWith('/v1')) {
+      // eslint-disable-next-line no-console
       console.warn(
@@ -117,0 +119,0 @@ 'apiBaseUrl should not end with /v1 in new versions, please remove the trailing /v1',

src/types.ts

@@ -53,3 +53,3 @@ import {
   disableValidation?: boolean;
-  additionalSigningContext?: Record<string, string>;
+  additionalSigningContext?: Record<string, unknown>;
 
@@ -56,0 +56,0 @@ appId?: string;

src/utils/transaction.ts

@@ -59,3 +59,3 @@ import { EthMethod, EthTransactionSend, TypedData } from 'eth-provider-types';
   paymaster?: PaymasterDefinition | PaymasterDefinition[],
-  additionalContext?: Record<string, string>,
+  additionalContext?: Record<string, unknown>,
 ): Transaction => {
@@ -78,3 +78,3 @@ const context = createContext(method, params, chain, paymaster, additionalContext);
   paymaster?: PaymasterDefinition | PaymasterDefinition[],
-  additionalContext?: Record<string, string>,
+  additionalContext?: Record<string, unknown>,
 ): TransactionContext => {
@@ -81,0 +81,0 @@ switch (method) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

404023

increased by0.17%

Lines of code

8323

increased by0.07%

No dependency changes