@0xsequence/relayer 0.35.10 → 0.36.1

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

@@ -5,10 +5,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var ethers = require('ethers');
 var abi = require('@0xsequence/abi');
 var transactions = require('@0xsequence/transactions');
+var utils = require('@0xsequence/utils');
 var providers = require('@ethersproject/providers');
 var config = require('@0xsequence/config');
 var utils$1 = require('ethers/lib/utils');
-var utils = require('@0xsequence/utils');
 var fetchPonyfill = require('fetch-ponyfill');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
@@ -311,11 +311,24 @@ class LocalRelayer extends ProviderRelayer {
     }));
   }
 
-  async gasRefundOptions(_config, _context, ..._transactions) {
-    return [];
+  async getFeeOptions(_config, _context, ..._transactions) {
+    return {
+      options: []
+    };
+  }
+
+  async gasRefundOptions(config, context, ...transactions) {
+    const {
+      options
+    } = await this.getFeeOptions(config, context, ...transactions);
+    return options;
   }
 
-  async relay(signedTxs) {
+  async relay(signedTxs, quote) {
+    if (quote !== undefined) {
+      utils.logger.warn(`LocalRelayer doesn't accept fee quotes`);
+    }
+
     if (!signedTxs.context.guestModule || signedTxs.context.guestModule.length !== 42) {
       throw new Error('LocalRelayer requires the context.guestModule address');
     }
@@ -339,7 +352,7 @@ class LocalRelayer extends ProviderRelayer {
 }
 
 /* eslint-disable */
-// sequence-relayer v0.4.0 7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd
+// sequence-relayer v0.4.0 4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b
 // --
 // This file has been generated by https://github.com/webrpc/webrpc using gen/typescript
 // Do not edit by hand. Update your webrpc schema and re-generate.
@@ -348,7 +361,7 @@ const WebRPCVersion = 'v1'; // Schema version of your RIDL schema
 
 const WebRPCSchemaVersion = 'v0.4.0'; // Schema hash generated from your RIDL schema
 
-const WebRPCSchemaHash = '7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd'; //
+const WebRPCSchemaHash = '4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b'; //
 // Types
 //
 
@@ -515,7 +528,8 @@ class Relayer {
       return this.fetch(this.url('FeeOptions'), createHTTPRequest(args, headers)).then(res => {
         return buildResponse(res).then(_data => {
           return {
-            options: _data.options
+            options: _data.options,
+            quote: _data.quote
           };
         });
       });
@@ -684,7 +698,7 @@ class RpcRelayer extends BaseRelayer {
     return prevNonce === undefined ? modTxns : transactions.appendNonce(modTxns, prevNonce);
   }
 
-  async gasRefundOptions(config$1, context, ...transactions$1) {
+  async getFeeOptions(config$1, context, ...transactions$1) {
     // NOTE/TODO: for a given `service` the feeTokens will not change between execution, so we should memoize this value
     // for a short-period of time, perhaps for 1 day or in memory. Perhaps one day we can make this happen automatically
     // with http cache response for this endpoint and service-worker.. lots of approaches
@@ -692,7 +706,7 @@ class RpcRelayer extends BaseRelayer {
 
     if (feeTokens.isFeeRequired) {
       const symbols = feeTokens.tokens.map(token => token.symbol).join(', ');
-      utils.logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are required, accepted tokens are ${symbols}`);
+      utils.logger.info(`[rpc-relayer/getFeeOptions] relayer fees are required, accepted tokens are ${symbols}`);
       const wallet = config.addressOf(config$1, context);
       let nonce = transactions.readSequenceNonce(...transactions$1);
 
@@ -701,7 +715,7 @@ class RpcRelayer extends BaseRelayer {
       }
 
       if (!this.provider) {
-        utils.logger.warn(`[rpc-relayer/gasRefundOptions] provider not set, needed for stub signature`);
+        utils.logger.warn(`[rpc-relayer/getFeeOptions] provider not set, needed for stub signature`);
         throw new Error('provider is not set');
       }
 
@@ -718,20 +732,36 @@ class RpcRelayer extends BaseRelayer {
       const walletInterface = new ethers.ethers.utils.Interface(abi.walletContracts.mainModule.abi);
       const data = walletInterface.encodeFunctionData(walletInterface.getFunction('execute'), [transactions.sequenceTxAbiEncode(execute.transactions), execute.nonce, execute.signature]);
       const {
-        options
+        options,
+        quote
       } = await this.service.feeOptions({
         wallet,
         to,
         data
       });
-      utils.logger.info(`[rpc-relayer/gasRefundOptions] got refund options ${JSON.stringify(options)}`);
-      return options;
+      utils.logger.info(`[rpc-relayer/getFeeOptions] got refund options ${JSON.stringify(options)}`);
+      return {
+        options,
+        quote: {
+          _tag: 'FeeQuote',
+          _quote: quote
+        }
+      };
     } else {
-      utils.logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are not required`);
-      return [];
+      utils.logger.info(`[rpc-relayer/getFeeOptions] relayer fees are not required`);
+      return {
+        options: []
+      };
     }
   }
 
+  async gasRefundOptions(config, context, ...transactions) {
+    const {
+      options
+    } = await this.getFeeOptions(config, context, ...transactions);
+    return options;
+  }
+
   async getNonce(config$1, context, space) {
     const addr = config.addressOf(config$1, context);
     utils.logger.info(`[rpc-relayer/getNonce] get nonce for wallet ${addr} space: ${space}`);
@@ -746,8 +776,17 @@ class RpcRelayer extends BaseRelayer {
     return nonce;
   }
 
-  async relay(signedTxs) {
-    utils.logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)}`);
+  async relay(signedTxs, quote) {
+    utils.logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)} with quote ${JSON.stringify(quote)}`);
+    let typecheckedQuote;
+
+    if (quote !== undefined) {
+      if (typeof quote._quote === 'string') {
+        typecheckedQuote = quote._quote;
+      } else {
+        utils.logger.warn('[rpc-relayer/relay] ignoring invalid fee quote');
+      }
+    }
 
     if (!this.provider) {
       utils.logger.warn(`[rpc-relayer/relay] provider not set, failed relay`);
@@ -766,7 +805,8 @@ class RpcRelayer extends BaseRelayer {
         walletAddress,
         contract,
         input
-      }
+      },
+      quote: typecheckedQuote
     });
     utils.logger.info(`[rpc-relayer/relay] got relay result ${JSON.stringify(metaTxn)}`);
     return this.wait(metaTxn.txnHash);
@@ -807,7 +847,7 @@ class MetaTransactionResponseException {
 }
 
 function isRelayer(cand) {
-  return cand && cand.estimateGasLimits !== undefined && cand.gasRefundOptions !== undefined && cand.getNonce !== undefined && cand.relay !== undefined;
+  return typeof cand === 'object' && typeof cand.simulate === 'function' && typeof cand.estimateGasLimits === 'function' && typeof cand.getFeeOptions === 'function' && typeof cand.gasRefundOptions === 'function' && typeof cand.getNonce === 'function' && typeof cand.relay === 'function' && typeof cand.wait === 'function';
 }
 
 exports.BaseRelayer = BaseRelayer;

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

@@ -5,10 +5,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var ethers = require('ethers');
 var abi = require('@0xsequence/abi');
 var transactions = require('@0xsequence/transactions');
+var utils = require('@0xsequence/utils');
 var providers = require('@ethersproject/providers');
 var config = require('@0xsequence/config');
 var utils$1 = require('ethers/lib/utils');
-var utils = require('@0xsequence/utils');
 var fetchPonyfill = require('fetch-ponyfill');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
@@ -311,11 +311,24 @@ class LocalRelayer extends ProviderRelayer {
     }));
   }
 
-  async gasRefundOptions(_config, _context, ..._transactions) {
-    return [];
+  async getFeeOptions(_config, _context, ..._transactions) {
+    return {
+      options: []
+    };
+  }
+
+  async gasRefundOptions(config, context, ...transactions) {
+    const {
+      options
+    } = await this.getFeeOptions(config, context, ...transactions);
+    return options;
   }
 
-  async relay(signedTxs) {
+  async relay(signedTxs, quote) {
+    if (quote !== undefined) {
+      utils.logger.warn(`LocalRelayer doesn't accept fee quotes`);
+    }
+
     if (!signedTxs.context.guestModule || signedTxs.context.guestModule.length !== 42) {
       throw new Error('LocalRelayer requires the context.guestModule address');
     }
@@ -339,7 +352,7 @@ class LocalRelayer extends ProviderRelayer {
 }
 
 /* eslint-disable */
-// sequence-relayer v0.4.0 7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd
+// sequence-relayer v0.4.0 4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b
 // --
 // This file has been generated by https://github.com/webrpc/webrpc using gen/typescript
 // Do not edit by hand. Update your webrpc schema and re-generate.
@@ -348,7 +361,7 @@ const WebRPCVersion = 'v1'; // Schema version of your RIDL schema
 
 const WebRPCSchemaVersion = 'v0.4.0'; // Schema hash generated from your RIDL schema
 
-const WebRPCSchemaHash = '7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd'; //
+const WebRPCSchemaHash = '4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b'; //
 // Types
 //
 
@@ -515,7 +528,8 @@ class Relayer {
       return this.fetch(this.url('FeeOptions'), createHTTPRequest(args, headers)).then(res => {
         return buildResponse(res).then(_data => {
           return {
-            options: _data.options
+            options: _data.options,
+            quote: _data.quote
           };
         });
       });
@@ -684,7 +698,7 @@ class RpcRelayer extends BaseRelayer {
     return prevNonce === undefined ? modTxns : transactions.appendNonce(modTxns, prevNonce);
   }
 
-  async gasRefundOptions(config$1, context, ...transactions$1) {
+  async getFeeOptions(config$1, context, ...transactions$1) {
     // NOTE/TODO: for a given `service` the feeTokens will not change between execution, so we should memoize this value
     // for a short-period of time, perhaps for 1 day or in memory. Perhaps one day we can make this happen automatically
     // with http cache response for this endpoint and service-worker.. lots of approaches
@@ -692,7 +706,7 @@ class RpcRelayer extends BaseRelayer {
 
     if (feeTokens.isFeeRequired) {
       const symbols = feeTokens.tokens.map(token => token.symbol).join(', ');
-      utils.logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are required, accepted tokens are ${symbols}`);
+      utils.logger.info(`[rpc-relayer/getFeeOptions] relayer fees are required, accepted tokens are ${symbols}`);
       const wallet = config.addressOf(config$1, context);
       let nonce = transactions.readSequenceNonce(...transactions$1);
 
@@ -701,7 +715,7 @@ class RpcRelayer extends BaseRelayer {
       }
 
       if (!this.provider) {
-        utils.logger.warn(`[rpc-relayer/gasRefundOptions] provider not set, needed for stub signature`);
+        utils.logger.warn(`[rpc-relayer/getFeeOptions] provider not set, needed for stub signature`);
         throw new Error('provider is not set');
       }
 
@@ -718,20 +732,36 @@ class RpcRelayer extends BaseRelayer {
       const walletInterface = new ethers.ethers.utils.Interface(abi.walletContracts.mainModule.abi);
       const data = walletInterface.encodeFunctionData(walletInterface.getFunction('execute'), [transactions.sequenceTxAbiEncode(execute.transactions), execute.nonce, execute.signature]);
       const {
-        options
+        options,
+        quote
       } = await this.service.feeOptions({
         wallet,
         to,
         data
       });
-      utils.logger.info(`[rpc-relayer/gasRefundOptions] got refund options ${JSON.stringify(options)}`);
-      return options;
+      utils.logger.info(`[rpc-relayer/getFeeOptions] got refund options ${JSON.stringify(options)}`);
+      return {
+        options,
+        quote: {
+          _tag: 'FeeQuote',
+          _quote: quote
+        }
+      };
     } else {
-      utils.logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are not required`);
-      return [];
+      utils.logger.info(`[rpc-relayer/getFeeOptions] relayer fees are not required`);
+      return {
+        options: []
+      };
     }
   }
 
+  async gasRefundOptions(config, context, ...transactions) {
+    const {
+      options
+    } = await this.getFeeOptions(config, context, ...transactions);
+    return options;
+  }
+
   async getNonce(config$1, context, space) {
     const addr = config.addressOf(config$1, context);
     utils.logger.info(`[rpc-relayer/getNonce] get nonce for wallet ${addr} space: ${space}`);
@@ -746,8 +776,17 @@ class RpcRelayer extends BaseRelayer {
     return nonce;
   }
 
-  async relay(signedTxs) {
-    utils.logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)}`);
+  async relay(signedTxs, quote) {
+    utils.logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)} with quote ${JSON.stringify(quote)}`);
+    let typecheckedQuote;
+
+    if (quote !== undefined) {
+      if (typeof quote._quote === 'string') {
+        typecheckedQuote = quote._quote;
+      } else {
+        utils.logger.warn('[rpc-relayer/relay] ignoring invalid fee quote');
+      }
+    }
 
     if (!this.provider) {
       utils.logger.warn(`[rpc-relayer/relay] provider not set, failed relay`);
@@ -766,7 +805,8 @@ class RpcRelayer extends BaseRelayer {
         walletAddress,
         contract,
         input
-      }
+      },
+      quote: typecheckedQuote
     });
     utils.logger.info(`[rpc-relayer/relay] got relay result ${JSON.stringify(metaTxn)}`);
     return this.wait(metaTxn.txnHash);
@@ -807,7 +847,7 @@ class MetaTransactionResponseException {
 }
 
 function isRelayer(cand) {
-  return cand && cand.estimateGasLimits !== undefined && cand.gasRefundOptions !== undefined && cand.getNonce !== undefined && cand.relay !== undefined;
+  return typeof cand === 'object' && typeof cand.simulate === 'function' && typeof cand.estimateGasLimits === 'function' && typeof cand.getFeeOptions === 'function' && typeof cand.gasRefundOptions === 'function' && typeof cand.getNonce === 'function' && typeof cand.relay === 'function' && typeof cand.wait === 'function';
 }
 
 exports.BaseRelayer = BaseRelayer;

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

@@ -1,10 +1,10 @@
 import { ethers, providers, Signer } from 'ethers';
 import { walletContracts } from '@0xsequence/abi';
 import { sequenceTxAbiEncode, readSequenceNonce, encodeNonce, computeMetaTxnHash, MetaTransactionsType, appendNonce, decodeNonce } from '@0xsequence/transactions';
+import { isBigNumberish, logger } from '@0xsequence/utils';
 import { Provider } from '@ethersproject/providers';
 import { imageHash, addressOf, encodeSignature, buildStubSignature } from '@0xsequence/config';
 import { Interface } from 'ethers/lib/utils';
-import { isBigNumberish, logger } from '@0xsequence/utils';
 import fetchPonyfill from 'fetch-ponyfill';
 
 function _extends() {
@@ -303,11 +303,24 @@ class LocalRelayer extends ProviderRelayer {
     }));
   }
 
-  async gasRefundOptions(_config, _context, ..._transactions) {
-    return [];
+  async getFeeOptions(_config, _context, ..._transactions) {
+    return {
+      options: []
+    };
+  }
+
+  async gasRefundOptions(config, context, ...transactions) {
+    const {
+      options
+    } = await this.getFeeOptions(config, context, ...transactions);
+    return options;
   }
 
-  async relay(signedTxs) {
+  async relay(signedTxs, quote) {
+    if (quote !== undefined) {
+      logger.warn(`LocalRelayer doesn't accept fee quotes`);
+    }
+
     if (!signedTxs.context.guestModule || signedTxs.context.guestModule.length !== 42) {
       throw new Error('LocalRelayer requires the context.guestModule address');
     }
@@ -331,7 +344,7 @@ class LocalRelayer extends ProviderRelayer {
 }
 
 /* eslint-disable */
-// sequence-relayer v0.4.0 7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd
+// sequence-relayer v0.4.0 4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b
 // --
 // This file has been generated by https://github.com/webrpc/webrpc using gen/typescript
 // Do not edit by hand. Update your webrpc schema and re-generate.
@@ -340,7 +353,7 @@ const WebRPCVersion = 'v1'; // Schema version of your RIDL schema
 
 const WebRPCSchemaVersion = 'v0.4.0'; // Schema hash generated from your RIDL schema
 
-const WebRPCSchemaHash = '7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd'; //
+const WebRPCSchemaHash = '4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b'; //
 // Types
 //
 
@@ -507,7 +520,8 @@ class Relayer {
       return this.fetch(this.url('FeeOptions'), createHTTPRequest(args, headers)).then(res => {
         return buildResponse(res).then(_data => {
           return {
-            options: _data.options
+            options: _data.options,
+            quote: _data.quote
           };
         });
       });
@@ -676,7 +690,7 @@ class RpcRelayer extends BaseRelayer {
     return prevNonce === undefined ? modTxns : appendNonce(modTxns, prevNonce);
   }
 
-  async gasRefundOptions(config, context, ...transactions) {
+  async getFeeOptions(config, context, ...transactions) {
     // NOTE/TODO: for a given `service` the feeTokens will not change between execution, so we should memoize this value
     // for a short-period of time, perhaps for 1 day or in memory. Perhaps one day we can make this happen automatically
     // with http cache response for this endpoint and service-worker.. lots of approaches
@@ -684,7 +698,7 @@ class RpcRelayer extends BaseRelayer {
 
     if (feeTokens.isFeeRequired) {
       const symbols = feeTokens.tokens.map(token => token.symbol).join(', ');
-      logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are required, accepted tokens are ${symbols}`);
+      logger.info(`[rpc-relayer/getFeeOptions] relayer fees are required, accepted tokens are ${symbols}`);
       const wallet = addressOf(config, context);
       let nonce = readSequenceNonce(...transactions);
 
@@ -693,7 +707,7 @@ class RpcRelayer extends BaseRelayer {
       }
 
       if (!this.provider) {
-        logger.warn(`[rpc-relayer/gasRefundOptions] provider not set, needed for stub signature`);
+        logger.warn(`[rpc-relayer/getFeeOptions] provider not set, needed for stub signature`);
         throw new Error('provider is not set');
       }
 
@@ -710,20 +724,36 @@ class RpcRelayer extends BaseRelayer {
       const walletInterface = new ethers.utils.Interface(walletContracts.mainModule.abi);
       const data = walletInterface.encodeFunctionData(walletInterface.getFunction('execute'), [sequenceTxAbiEncode(execute.transactions), execute.nonce, execute.signature]);
       const {
-        options
+        options,
+        quote
       } = await this.service.feeOptions({
         wallet,
         to,
         data
       });
-      logger.info(`[rpc-relayer/gasRefundOptions] got refund options ${JSON.stringify(options)}`);
-      return options;
+      logger.info(`[rpc-relayer/getFeeOptions] got refund options ${JSON.stringify(options)}`);
+      return {
+        options,
+        quote: {
+          _tag: 'FeeQuote',
+          _quote: quote
+        }
+      };
     } else {
-      logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are not required`);
-      return [];
+      logger.info(`[rpc-relayer/getFeeOptions] relayer fees are not required`);
+      return {
+        options: []
+      };
     }
   }
 
+  async gasRefundOptions(config, context, ...transactions) {
+    const {
+      options
+    } = await this.getFeeOptions(config, context, ...transactions);
+    return options;
+  }
+
   async getNonce(config, context, space) {
     const addr = addressOf(config, context);
     logger.info(`[rpc-relayer/getNonce] get nonce for wallet ${addr} space: ${space}`);
@@ -738,8 +768,17 @@ class RpcRelayer extends BaseRelayer {
     return nonce;
   }
 
-  async relay(signedTxs) {
-    logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)}`);
+  async relay(signedTxs, quote) {
+    logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)} with quote ${JSON.stringify(quote)}`);
+    let typecheckedQuote;
+
+    if (quote !== undefined) {
+      if (typeof quote._quote === 'string') {
+        typecheckedQuote = quote._quote;
+      } else {
+        logger.warn('[rpc-relayer/relay] ignoring invalid fee quote');
+      }
+    }
 
     if (!this.provider) {
       logger.warn(`[rpc-relayer/relay] provider not set, failed relay`);
@@ -758,7 +797,8 @@ class RpcRelayer extends BaseRelayer {
         walletAddress,
         contract,
         input
-      }
+      },
+      quote: typecheckedQuote
     });
     logger.info(`[rpc-relayer/relay] got relay result ${JSON.stringify(metaTxn)}`);
     return this.wait(metaTxn.txnHash);
@@ -799,7 +839,7 @@ class MetaTransactionResponseException {
 }
 
 function isRelayer(cand) {
-  return cand && cand.estimateGasLimits !== undefined && cand.gasRefundOptions !== undefined && cand.getNonce !== undefined && cand.relay !== undefined;
+  return typeof cand === 'object' && typeof cand.simulate === 'function' && typeof cand.estimateGasLimits === 'function' && typeof cand.getFeeOptions === 'function' && typeof cand.gasRefundOptions === 'function' && typeof cand.getNonce === 'function' && typeof cand.relay === 'function' && typeof cand.wait === 'function';
 }
 
 export { BaseRelayer, BaseRelayerDefaults, LocalRelayer, ProviderRelayer, ProviderRelayerDefaults, RpcRelayer, relayer_gen as RpcRelayerProto, isBaseRelayerOptions, isLocalRelayerOptions, isProviderRelayerOptions, isRelayer, isRpcRelayerOptions, relayer_gen as proto };

package/dist/declarations/src/index.d.ts

@@ -6,9 +6,13 @@ import { proto } from './rpc-relayer';
 export interface Relayer {
     simulate(wallet: string, ...transactions: Transaction[]): Promise<SimulateResult[]>;
     estimateGasLimits(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<Transaction[]>;
+    getFeeOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
     gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]>;
     getNonce(config: WalletConfig, context: WalletContext, space?: ethers.BigNumberish, blockTag?: providers.BlockTag): Promise<ethers.BigNumberish>;
-    relay(signedTxs: SignedTransactions): Promise<providers.TransactionResponse>;
+    relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<providers.TransactionResponse>;
     wait(metaTxnId: string | SignedTransactions, timeout: number): Promise<providers.TransactionResponse>;
 }
 export * from './local-relayer';
@@ -18,4 +22,8 @@ export * from './rpc-relayer';
 export { proto as RpcRelayerProto } from './rpc-relayer';
 export declare type SimulateResult = proto.SimulateResult;
 export declare type FeeOption = proto.FeeOption;
+export interface FeeQuote {
+    _tag: 'FeeQuote';
+    _quote: unknown;
+}
 export declare function isRelayer(cand: any): cand is Relayer;

package/dist/declarations/src/local-relayer.d.ts

@@ -3,7 +3,7 @@ import { Signer as AbstractSigner } from 'ethers';
 import { SignedTransactions, Transaction } from '@0xsequence/transactions';
 import { WalletContext } from '@0xsequence/network';
 import { WalletConfig } from '@0xsequence/config';
-import { FeeOption, Relayer } from '.';
+import { FeeOption, FeeQuote, Relayer } from '.';
 import { ProviderRelayer, ProviderRelayerOptions } from './provider-relayer';
 export declare type LocalRelayerOptions = Omit<ProviderRelayerOptions, "provider"> & {
     signer: AbstractSigner;
@@ -13,6 +13,9 @@ export declare class LocalRelayer extends ProviderRelayer implements Relayer {
     private signer;
     constructor(options: LocalRelayerOptions | AbstractSigner);
     deployWallet(config: WalletConfig, context: WalletContext): Promise<TransactionResponse>;
-    gasRefundOptions(_config: WalletConfig, _context: WalletContext, ..._transactions: Transaction[]): Promise<FeeOption[]>;
-    relay(signedTxs: SignedTransactions): Promise<TransactionResponse>;
+    getFeeOptions(_config: WalletConfig, _context: WalletContext, ..._transactions: Transaction[]): Promise<{
+        options: FeeOption[];
+    }>;
+    gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]>;
+    relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<TransactionResponse>;
 }

package/dist/declarations/src/provider-relayer.d.ts

@@ -4,7 +4,7 @@ import { SignedTransactions, Transaction } from '@0xsequence/transactions';
 import { WalletContext } from '@0xsequence/network';
 import { WalletConfig } from '@0xsequence/config';
 import { BaseRelayer, BaseRelayerOptions } from './base-relayer';
-import { FeeOption, Relayer, SimulateResult } from '.';
+import { FeeOption, FeeQuote, Relayer, SimulateResult } from '.';
 import { Optionals, Mask } from '@0xsequence/utils';
 export interface ProviderRelayerOptions extends BaseRelayerOptions {
     provider: Provider;
@@ -20,8 +20,12 @@ export declare abstract class ProviderRelayer extends BaseRelayer implements Rel
     deltaBlocksLog: number;
     fromBlockLog: number;
     constructor(options: ProviderRelayerOptions);
+    abstract getFeeOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
     abstract gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]>;
-    abstract relay(signedTxs: SignedTransactions): Promise<TransactionResponse>;
+    abstract relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<TransactionResponse>;
     simulate(wallet: string, ...transactions: Transaction[]): Promise<SimulateResult[]>;
     estimateGasLimits(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<Transaction[]>;
     getNonce(config: WalletConfig, context: WalletContext, space?: ethers.BigNumberish, blockTag?: BlockTag): Promise<ethers.BigNumberish>;

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

@@ -2,7 +2,7 @@ import { TransactionResponse } from '@ethersproject/providers';
 import { ethers } from 'ethers';
 import { Transaction, SignedTransactions } from '@0xsequence/transactions';
 import { BaseRelayer, BaseRelayerOptions } from '../base-relayer';
-import { FeeOption, Relayer, SimulateResult } from '..';
+import { FeeOption, FeeQuote, Relayer, SimulateResult } from '..';
 import { WalletContext } from '@0xsequence/network';
 import { WalletConfig } from '@0xsequence/config';
 import * as proto from './relayer.gen';
@@ -17,8 +17,12 @@ export declare class RpcRelayer extends BaseRelayer implements Relayer {
     waitReceipt(metaTxnHash: string | SignedTransactions, wait?: number): Promise<proto.GetMetaTxnReceiptReturn>;
     simulate(wallet: string, ...transactions: Transaction[]): Promise<SimulateResult[]>;
     estimateGasLimits(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<Transaction[]>;
+    getFeeOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
     gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]>;
     getNonce(config: WalletConfig, context: WalletContext, space?: ethers.BigNumberish): Promise<ethers.BigNumberish>;
-    relay(signedTxs: SignedTransactions): Promise<TransactionResponse>;
+    relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<TransactionResponse>;
     wait(metaTxnHash: string | SignedTransactions, wait?: number): Promise<TransactionResponse>;
 }

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

@@ -1,6 +1,6 @@
 export declare const WebRPCVersion = "v1";
 export declare const WebRPCSchemaVersion = "v0.4.0";
-export declare const WebRPCSchemaHash = "7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd";
+export declare const WebRPCSchemaHash = "4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b";
 export declare enum ETHTxnStatus {
     UNKNOWN = "UNKNOWN",
     DROPPED = "DROPPED",
@@ -231,6 +231,7 @@ export interface GetChainIDReturn {
 }
 export interface SendMetaTxnArgs {
     call: MetaTxn;
+    quote?: string;
 }
 export interface SendMetaTxnReturn {
     status: boolean;
@@ -277,6 +278,7 @@ export interface FeeOptionsArgs {
 }
 export interface FeeOptionsReturn {
     options: Array<FeeOption>;
+    quote?: string;
 }
 export interface GetMetaTxnNetworkFeeOptionsArgs {
     walletConfig: WalletConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/relayer",
-  "version": "0.35.10",
+  "version": "0.36.1",
   "description": "relayer sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/relayer",
   "source": "src/index.ts",
@@ -17,10 +17,10 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@0xsequence/abi": "^0.35.10",
-    "@0xsequence/config": "^0.35.10",
-    "@0xsequence/transactions": "^0.35.10",
-    "@0xsequence/utils": "^0.35.10",
+    "@0xsequence/abi": "^0.36.1",
+    "@0xsequence/config": "^0.36.1",
+    "@0xsequence/transactions": "^0.36.1",
+    "@0xsequence/utils": "^0.36.1",
     "@ethersproject/providers": "^5.5.1",
     "ethers": "^5.5.2",
     "fetch-ponyfill": "^7.1.0"

package/src/index.ts

@@ -16,6 +16,14 @@ export interface Relayer {
     ...transactions: Transaction[]
   ): Promise<Transaction[]>
 
+  // getFeeOptions returns the fee options that the relayer will accept as payment.
+  // If a quote is returned, it may be passed back to the relayer for dispatch.
+  getFeeOptions(
+    config: WalletConfig,
+    context: WalletContext,
+    ...transactions: Transaction[]
+  ): Promise<{ options: FeeOption[], quote?: FeeQuote }>
+
   // gasRefundOptions returns the transactions which can be included to refund a
   // relayer for submitting your transaction to a network.
   gasRefundOptions(
@@ -30,7 +38,8 @@ export interface Relayer {
   getNonce(config: WalletConfig, context: WalletContext, space?: ethers.BigNumberish, blockTag?: providers.BlockTag): Promise<ethers.BigNumberish>
 
   // relayer will submit the transaction(s) to the network and return the transaction response.
-  relay(signedTxs: SignedTransactions): Promise<providers.TransactionResponse>
+  // The quote should be the one returned from getFeeOptions, if any.
+  relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<providers.TransactionResponse>
 
   // wait for transaction confirmation
   wait(metaTxnId: string | SignedTransactions, timeout: number): Promise<providers.TransactionResponse>
@@ -44,7 +53,26 @@ export { proto as RpcRelayerProto } from './rpc-relayer'
 export type SimulateResult = proto.SimulateResult
 export type FeeOption = proto.FeeOption
 
+// A fee quote is simply an opaque value that can be obtained via Relayer.getFeeOptions(), and
+// returned back to the same relayer via Relayer.relay(). Fee quotes should be treated as an
+// implementation detail of the relayer that produces them.
+//
+// This interface exists for type-safety purposes to protect against passing non-FeeQuotes to
+// Relayer.relay(), or any other functions that call it indirectly (e.g. Account.sendTransaction).
+export interface FeeQuote {
+  _tag: 'FeeQuote'
+  _quote: unknown
+}
+
 export function isRelayer(cand: any): cand is Relayer {
-  return cand && cand.estimateGasLimits !== undefined && cand.gasRefundOptions !== undefined &&
-    cand.getNonce !== undefined && cand.relay !== undefined
+  return (
+    typeof cand === 'object' &&
+    typeof cand.simulate === 'function' &&
+    typeof cand.estimateGasLimits === 'function' &&
+    typeof cand.getFeeOptions === 'function' &&
+    typeof cand.gasRefundOptions === 'function' &&
+    typeof cand.getNonce === 'function' &&
+    typeof cand.relay === 'function' &&
+    typeof cand.wait === 'function'
+  )
 }

package/src/local-relayer.ts

@@ -4,7 +4,8 @@ import { walletContracts } from '@0xsequence/abi'
 import { SignedTransactions, Transaction, sequenceTxAbiEncode } from '@0xsequence/transactions'
 import { WalletContext } from '@0xsequence/network'
 import { WalletConfig } from '@0xsequence/config'
-import { FeeOption, Relayer } from '.'
+import { logger } from '@0xsequence/utils'
+import { FeeOption, FeeQuote, Relayer } from '.'
 import { ProviderRelayer, ProviderRelayerOptions } from './provider-relayer'
 
 export type LocalRelayerOptions = Omit<ProviderRelayerOptions, "provider"> & {
@@ -34,15 +35,28 @@ export class LocalRelayer extends ProviderRelayer implements Relayer {
     return this.signer.sendTransaction({ ...walletDeployTxn, gasLimit: ethers.constants.Two.pow(17) } )
   }
 
-  async gasRefundOptions(
+  async getFeeOptions(
     _config: WalletConfig,
     _context: WalletContext,
     ..._transactions: Transaction[]
+  ): Promise<{ options: FeeOption[] }> {
+    return { options: [] }
+  }
+
+  async gasRefundOptions(
+    config: WalletConfig,
+    context: WalletContext,
+    ...transactions: Transaction[]
   ): Promise<FeeOption[]> {
-    return []
+    const { options } = await this.getFeeOptions(config, context, ...transactions)
+    return options
   }
 
-  async relay(signedTxs: SignedTransactions): Promise<TransactionResponse> {
+  async relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<TransactionResponse> {
+    if (quote !== undefined) {
+      logger.warn(`LocalRelayer doesn't accept fee quotes`)
+    }
+
     if (!signedTxs.context.guestModule || signedTxs.context.guestModule.length !== 42) {
       throw new Error('LocalRelayer requires the context.guestModule address')
     }

package/src/provider-relayer.ts

@@ -5,7 +5,7 @@ import { computeMetaTxnHash, encodeNonce, SignedTransactions, Transaction } from
 import { WalletContext } from '@0xsequence/network'
 import { WalletConfig, addressOf } from '@0xsequence/config'
 import { BaseRelayer, BaseRelayerOptions } from './base-relayer'
-import { FeeOption, Relayer, SimulateResult } from '.'
+import { FeeOption, FeeQuote, Relayer, SimulateResult } from '.'
 import { Optionals, Mask } from '@0xsequence/utils'
 
 const DEFAULT_GAS_LIMIT = ethers.BigNumber.from(800000)
@@ -42,8 +42,19 @@ export abstract class ProviderRelayer extends BaseRelayer implements Relayer {
     this.fromBlockLog = opts.fromBlockLog
   }
 
-  abstract gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]>
-  abstract relay(signedTxs: SignedTransactions): Promise<TransactionResponse>
+  abstract getFeeOptions(
+    config: WalletConfig,
+    context: WalletContext,
+    ...transactions: Transaction[]
+  ): Promise<{ options: FeeOption[], quote?: FeeQuote }>
+
+  abstract gasRefundOptions(
+    config: WalletConfig,
+    context: WalletContext,
+    ...transactions: Transaction[]
+  ): Promise<FeeOption[]>
+
+  abstract relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<TransactionResponse>
 
   async simulate(wallet: string, ...transactions: Transaction[]): Promise<SimulateResult[]> {
     return (await Promise.all(transactions.map(async tx => {

package/src/rpc-relayer/index.ts

@@ -13,7 +13,7 @@ import {
   decodeNonce
 } from '@0xsequence/transactions'
 import { BaseRelayer, BaseRelayerOptions } from '../base-relayer'
-import { FeeOption, Relayer, SimulateResult } from '..'
+import { FeeOption, FeeQuote, Relayer, SimulateResult } from '..'
 import { WalletContext } from '@0xsequence/network'
 import { WalletConfig, addressOf, buildStubSignature } from '@0xsequence/config'
 import { logger } from '@0xsequence/utils'
@@ -113,7 +113,11 @@ export class RpcRelayer extends BaseRelayer implements Relayer {
     return prevNonce === undefined ? modTxns : appendNonce(modTxns, prevNonce)
   }
 
-  async gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]> {
+  async getFeeOptions(
+    config: WalletConfig,
+    context: WalletContext,
+    ...transactions: Transaction[]
+  ): Promise<{ options: FeeOption[]; quote?: FeeQuote }> {
     // NOTE/TODO: for a given `service` the feeTokens will not change between execution, so we should memoize this value
     // for a short-period of time, perhaps for 1 day or in memory. Perhaps one day we can make this happen automatically
     // with http cache response for this endpoint and service-worker.. lots of approaches
@@ -121,7 +125,7 @@ export class RpcRelayer extends BaseRelayer implements Relayer {
 
     if (feeTokens.isFeeRequired) {
       const symbols = feeTokens.tokens.map(token => token.symbol).join(', ')
-      logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are required, accepted tokens are ${symbols}`)
+      logger.info(`[rpc-relayer/getFeeOptions] relayer fees are required, accepted tokens are ${symbols}`)
 
       const wallet = addressOf(config, context)
 
@@ -131,7 +135,7 @@ export class RpcRelayer extends BaseRelayer implements Relayer {
       }
 
       if (!this.provider) {
-        logger.warn(`[rpc-relayer/gasRefundOptions] provider not set, needed for stub signature`)
+        logger.warn(`[rpc-relayer/getFeeOptions] provider not set, needed for stub signature`)
         throw new Error('provider is not set')
       }
 
@@ -150,16 +154,21 @@ export class RpcRelayer extends BaseRelayer implements Relayer {
         execute.signature
       ])
 
-      const { options } = await this.service.feeOptions({ wallet, to, data })
+      const { options, quote } = await this.service.feeOptions({ wallet, to, data })
 
-      logger.info(`[rpc-relayer/gasRefundOptions] got refund options ${JSON.stringify(options)}`)
-      return options
+      logger.info(`[rpc-relayer/getFeeOptions] got refund options ${JSON.stringify(options)}`)
+      return { options, quote: { _tag: 'FeeQuote', _quote: quote } }
     } else {
-      logger.info(`[rpc-relayer/gasRefundOptions] relayer fees are not required`)
-      return []
+      logger.info(`[rpc-relayer/getFeeOptions] relayer fees are not required`)
+      return { options: [] }
     }
   }
 
+  async gasRefundOptions(config: WalletConfig, context: WalletContext, ...transactions: Transaction[]): Promise<FeeOption[]> {
+    const { options } = await this.getFeeOptions(config, context, ...transactions)
+    return options
+  }
+
   async getNonce(config: WalletConfig, context: WalletContext, space?: ethers.BigNumberish): Promise<ethers.BigNumberish> {
     const addr = addressOf(config, context)
     logger.info(`[rpc-relayer/getNonce] get nonce for wallet ${addr} space: ${space}`)
@@ -171,8 +180,19 @@ export class RpcRelayer extends BaseRelayer implements Relayer {
     return nonce
   }
 
-  async relay(signedTxs: SignedTransactions): Promise<TransactionResponse> {
-    logger.info(`[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)}`)
+  async relay(signedTxs: SignedTransactions, quote?: FeeQuote): Promise<TransactionResponse> {
+    logger.info(
+      `[rpc-relayer/relay] relaying signed meta-transactions ${JSON.stringify(signedTxs)} with quote ${JSON.stringify(quote)}`
+    )
+
+    let typecheckedQuote: string | undefined
+    if (quote !== undefined) {
+      if (typeof quote._quote === 'string') {
+        typecheckedQuote = quote._quote
+      } else {
+        logger.warn('[rpc-relayer/relay] ignoring invalid fee quote')
+      }
+    }
 
     if (!this.provider) {
       logger.warn(`[rpc-relayer/relay] provider not set, failed relay`)
@@ -189,7 +209,7 @@ export class RpcRelayer extends BaseRelayer implements Relayer {
       execute.signature
     ])
 
-    const metaTxn = await this.service.sendMetaTxn({ call: { walletAddress, contract, input } })
+    const metaTxn = await this.service.sendMetaTxn({ call: { walletAddress, contract, input }, quote: typecheckedQuote })
 
     logger.info(`[rpc-relayer/relay] got relay result ${JSON.stringify(metaTxn)}`)
 

package/src/rpc-relayer/relayer.gen.ts

@@ -1,5 +1,5 @@
 /* eslint-disable */
-// sequence-relayer v0.4.0 7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd
+// sequence-relayer v0.4.0 4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b
 // --
 // This file has been generated by https://github.com/webrpc/webrpc using gen/typescript
 // Do not edit by hand. Update your webrpc schema and re-generate.
@@ -11,7 +11,7 @@ export const WebRPCVersion = 'v1'
 export const WebRPCSchemaVersion = 'v0.4.0'
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = '7dbfaf5c04cf28e9259ff1a9bf3274c8d73be5dd'
+export const WebRPCSchemaHash = '4dca0b91c1531d1166ae2f7ebd8af571b0c0e43b'
 
 //
 // Types
@@ -265,6 +265,7 @@ export interface GetChainIDReturn {
 }
 export interface SendMetaTxnArgs {
   call: MetaTxn
+  quote?: string
 }
 
 export interface SendMetaTxnReturn {
@@ -317,6 +318,7 @@ export interface FeeOptionsArgs {
 
 export interface FeeOptionsReturn {
   options: Array<FeeOption>
+  quote?: string
 }
 export interface GetMetaTxnNetworkFeeOptionsArgs {
   walletConfig: WalletConfig
@@ -477,7 +479,8 @@ export class Relayer implements Relayer {
     return this.fetch(this.url('FeeOptions'), createHTTPRequest(args, headers)).then(res => {
       return buildResponse(res).then(_data => {
         return {
-          options: <Array<FeeOption>>_data.options
+          options: <Array<FeeOption>>_data.options,
+          quote: <string>_data.quote
         }
       })
     })