@0xsequence/relayer 1.2.9 → 1.4.0

package/dist/0xsequence-relayer.cjs.dev.js

@@ -602,10 +602,41 @@ function isRpcRelayerOptions(obj) {
   return obj.url !== undefined && typeof obj.url === 'string' && obj.provider !== undefined && ethers.ethers.providers.Provider.isProvider(obj.provider);
 }
 const fetch = typeof global === 'object' ? global.fetch : window.fetch;
+
+// TODO: rename to SequenceRelayer
 class RpcRelayer {
   constructor(options) {
-    this.service = new Relayer(options.url, fetch);
-    this.provider = ethers.ethers.providers.Provider.isProvider(options.provider) ? options.provider : new ethers.ethers.providers.StaticJsonRpcProvider(utils.getDefaultConnectionInfo(options.provider.url));
+    this._fetch = (input, init) => {
+      // automatically include jwt and access key auth header to requests
+      // if its been set on the api client
+      const headers = {};
+      const {
+        jwtAuth,
+        projectAccessKey
+      } = this.options;
+      if (jwtAuth && jwtAuth.length > 0) {
+        headers['Authorization'] = `BEARER ${jwtAuth}`;
+      }
+      if (projectAccessKey && projectAccessKey.length > 0) {
+        headers['X-Access-Key'] = projectAccessKey;
+      }
+
+      // before the request is made
+      init.headers = _extends({}, init.headers, headers);
+      return fetch(input, init);
+    };
+    this.options = options;
+    this.service = new Relayer(options.url, this._fetch);
+    if (ethers.ethers.providers.Provider.isProvider(options.provider)) {
+      this.provider = options.provider;
+    } else {
+      const {
+        jwtAuth,
+        projectAccessKey
+      } = this.options;
+      const providerConnectionInfo = utils.getEthersConnectionInfo(options.provider.url, projectAccessKey, jwtAuth);
+      this.provider = new ethers.ethers.providers.StaticJsonRpcProvider(providerConnectionInfo);
+    }
   }
   async waitReceipt(metaTxnId, delay = 1000, maxFails = 5, isCancelled) {
     if (typeof metaTxnId !== 'string') {

package/dist/0xsequence-relayer.cjs.prod.js

@@ -602,10 +602,41 @@ function isRpcRelayerOptions(obj) {
   return obj.url !== undefined && typeof obj.url === 'string' && obj.provider !== undefined && ethers.ethers.providers.Provider.isProvider(obj.provider);
 }
 const fetch = typeof global === 'object' ? global.fetch : window.fetch;
+
+// TODO: rename to SequenceRelayer
 class RpcRelayer {
   constructor(options) {
-    this.service = new Relayer(options.url, fetch);
-    this.provider = ethers.ethers.providers.Provider.isProvider(options.provider) ? options.provider : new ethers.ethers.providers.StaticJsonRpcProvider(utils.getDefaultConnectionInfo(options.provider.url));
+    this._fetch = (input, init) => {
+      // automatically include jwt and access key auth header to requests
+      // if its been set on the api client
+      const headers = {};
+      const {
+        jwtAuth,
+        projectAccessKey
+      } = this.options;
+      if (jwtAuth && jwtAuth.length > 0) {
+        headers['Authorization'] = `BEARER ${jwtAuth}`;
+      }
+      if (projectAccessKey && projectAccessKey.length > 0) {
+        headers['X-Access-Key'] = projectAccessKey;
+      }
+
+      // before the request is made
+      init.headers = _extends({}, init.headers, headers);
+      return fetch(input, init);
+    };
+    this.options = options;
+    this.service = new Relayer(options.url, this._fetch);
+    if (ethers.ethers.providers.Provider.isProvider(options.provider)) {
+      this.provider = options.provider;
+    } else {
+      const {
+        jwtAuth,
+        projectAccessKey
+      } = this.options;
+      const providerConnectionInfo = utils.getEthersConnectionInfo(options.provider.url, projectAccessKey, jwtAuth);
+      this.provider = new ethers.ethers.providers.StaticJsonRpcProvider(providerConnectionInfo);
+    }
   }
   async waitReceipt(metaTxnId, delay = 1000, maxFails = 5, isCancelled) {
     if (typeof metaTxnId !== 'string') {

package/dist/0xsequence-relayer.esm.js

@@ -1,5 +1,5 @@
 import { ethers, providers, Signer } from 'ethers';
-import { logger, getDefaultConnectionInfo } from '@0xsequence/utils';
+import { logger, getEthersConnectionInfo } from '@0xsequence/utils';
 import { walletContracts } from '@0xsequence/abi';
 import { commons } from '@0xsequence/core';
 
@@ -598,10 +598,41 @@ function isRpcRelayerOptions(obj) {
   return obj.url !== undefined && typeof obj.url === 'string' && obj.provider !== undefined && ethers.providers.Provider.isProvider(obj.provider);
 }
 const fetch = typeof global === 'object' ? global.fetch : window.fetch;
+
+// TODO: rename to SequenceRelayer
 class RpcRelayer {
   constructor(options) {
-    this.service = new Relayer(options.url, fetch);
-    this.provider = ethers.providers.Provider.isProvider(options.provider) ? options.provider : new ethers.providers.StaticJsonRpcProvider(getDefaultConnectionInfo(options.provider.url));
+    this._fetch = (input, init) => {
+      // automatically include jwt and access key auth header to requests
+      // if its been set on the api client
+      const headers = {};
+      const {
+        jwtAuth,
+        projectAccessKey
+      } = this.options;
+      if (jwtAuth && jwtAuth.length > 0) {
+        headers['Authorization'] = `BEARER ${jwtAuth}`;
+      }
+      if (projectAccessKey && projectAccessKey.length > 0) {
+        headers['X-Access-Key'] = projectAccessKey;
+      }
+
+      // before the request is made
+      init.headers = _extends({}, init.headers, headers);
+      return fetch(input, init);
+    };
+    this.options = options;
+    this.service = new Relayer(options.url, this._fetch);
+    if (ethers.providers.Provider.isProvider(options.provider)) {
+      this.provider = options.provider;
+    } else {
+      const {
+        jwtAuth,
+        projectAccessKey
+      } = this.options;
+      const providerConnectionInfo = getEthersConnectionInfo(options.provider.url, projectAccessKey, jwtAuth);
+      this.provider = new ethers.providers.StaticJsonRpcProvider(providerConnectionInfo);
+    }
   }
   async waitReceipt(metaTxnId, delay = 1000, maxFails = 5, isCancelled) {
     if (typeof metaTxnId !== 'string') {

package/dist/declarations/src/rpc-relayer/index.d.ts

@@ -8,12 +8,16 @@ export interface RpcRelayerOptions {
         url: string;
     };
     url: string;
+    projectAccessKey?: string;
+    jwtAuth?: string;
 }
 export declare function isRpcRelayerOptions(obj: any): obj is RpcRelayerOptions;
 export declare class RpcRelayer implements Relayer {
+    options: RpcRelayerOptions;
     private readonly service;
     readonly provider: ethers.providers.Provider;
     constructor(options: RpcRelayerOptions);
+    _fetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
     waitReceipt(metaTxnId: string | commons.transaction.SignedTransactionBundle, delay?: number, maxFails?: number, isCancelled?: () => boolean): Promise<proto.GetMetaTxnReceiptReturn>;
     simulate(wallet: string, ...transactions: commons.transaction.Transaction[]): Promise<SimulateResult[]>;
     getFeeOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/relayer",
-  "version": "1.2.9",
+  "version": "1.4.0",
   "description": "relayer sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/relayer",
   "source": "src/index.ts",
@@ -9,9 +9,9 @@
   "author": "Horizon Blockchain Games",
   "license": "Apache-2.0",
   "dependencies": {
-    "@0xsequence/abi": "1.2.9",
-    "@0xsequence/utils": "1.2.9",
-    "@0xsequence/core": "1.2.9"
+    "@0xsequence/abi": "1.4.0",
+    "@0xsequence/core": "1.4.0",
+    "@0xsequence/utils": "1.4.0"
   },
   "peerDependencies": {
     "ethers": ">=5.5 < 6"
@@ -19,8 +19,8 @@
   "devDependencies": {
     "@0xsequence/wallet-contracts": "^1.10.0",
     "ethers": "^5.7.2",
-    "@0xsequence/signhub": "1.2.9",
-    "@0xsequence/tests": "1.2.9"
+    "@0xsequence/signhub": "1.4.0",
+    "@0xsequence/tests": "1.4.0"
   },
   "files": [
     "src",

package/src/rpc-relayer/index.ts

@@ -2,7 +2,7 @@ import { ethers } from 'ethers'
 import { FeeOption, FeeQuote, Relayer, SimulateResult } from '..'
 import * as proto from './relayer.gen'
 import { commons } from '@0xsequence/core'
-import { getDefaultConnectionInfo, logger } from '@0xsequence/utils'
+import { getEthersConnectionInfo, logger } from '@0xsequence/utils'
 
 export { proto }
 
@@ -18,6 +18,8 @@ const FAILED_STATUSES = [proto.ETHTxnStatus.DROPPED, proto.ETHTxnStatus.PARTIALL
 export interface RpcRelayerOptions {
   provider: ethers.providers.Provider | { url: string }
   url: string
+  projectAccessKey?: string
+  jwtAuth?: string
 }
 
 export function isRpcRelayerOptions(obj: any): obj is RpcRelayerOptions {
@@ -31,15 +33,42 @@ export function isRpcRelayerOptions(obj: any): obj is RpcRelayerOptions {
 
 const fetch = typeof global === 'object' ? global.fetch : window.fetch
 
+// TODO: rename to SequenceRelayer
 export class RpcRelayer implements Relayer {
   private readonly service: proto.Relayer
   public readonly provider: ethers.providers.Provider
 
-  constructor(options: RpcRelayerOptions) {
-    this.service = new proto.Relayer(options.url, fetch)
-    this.provider = ethers.providers.Provider.isProvider(options.provider)
-      ? options.provider
-      : new ethers.providers.StaticJsonRpcProvider(getDefaultConnectionInfo(options.provider.url))
+  constructor(public options: RpcRelayerOptions) {
+    this.service = new proto.Relayer(options.url, this._fetch)
+
+    if (ethers.providers.Provider.isProvider(options.provider)) {
+      this.provider = options.provider
+    } else {
+      const { jwtAuth, projectAccessKey } = this.options
+      const providerConnectionInfo = getEthersConnectionInfo(options.provider.url, projectAccessKey, jwtAuth)
+      this.provider = new ethers.providers.StaticJsonRpcProvider(providerConnectionInfo)
+    }
+  }
+
+  _fetch = (input: RequestInfo, init?: RequestInit): Promise<Response> => {
+    // automatically include jwt and access key auth header to requests
+    // if its been set on the api client
+    const headers: { [key: string]: any } = {}
+
+    const { jwtAuth, projectAccessKey } = this.options
+
+    if (jwtAuth && jwtAuth.length > 0) {
+      headers['Authorization'] = `BEARER ${jwtAuth}`
+    }
+
+    if (projectAccessKey && projectAccessKey.length > 0) {
+      headers['X-Access-Key'] = projectAccessKey
+    }
+
+    // before the request is made
+    init!.headers = { ...init!.headers, ...headers }
+
+    return fetch(input, init)
   }
 
   async waitReceipt(