Add feeTokens endpoint to relayer (#885)

Author: ScreamingHawk

packages/services/relayer/src/rpc-relayer/relayer.gen.ts

@@ -63,6 +63,8 @@ export interface Relayer {
 
   isAvailable(wallet: Address.Address, chainId: number): Promise<boolean>
 
+  feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: FeeToken[]; paymentAddress?: Address.Address }>
+
   feeOptions(
     wallet: Address.Address,
     chainId: number,

packages/wallet/core/src/relayer/relayer.ts

@@ -3,7 +3,7 @@ import { EIP1193ProviderAdapter, LocalRelayer } from './local.js'
 import { FeeOption, FeeQuote, OperationStatus, Relayer } from '../relayer.js'
 import { Address, Hex } from 'ox'
 import { Payload } from '@0xsequence/wallet-primitives'
-import { IntentPrecondition } from './rpc/relayer.gen.js'
+import { FeeToken, IntentPrecondition } from './rpc/relayer.gen.js'
 
 export class EIP6963Relayer implements Relayer {
   public readonly kind: 'relayer' = 'relayer'
@@ -23,6 +23,10 @@ export class EIP6963Relayer implements Relayer {
     return this.relayer.isAvailable(wallet, chainId)
   }
 
+  feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: FeeToken[]; paymentAddress?: Address.Address }> {
+    return this.relayer.feeTokens()
+  }
+
   feeOptions(
     wallet: Address.Address,
     chainId: number,

packages/wallet/core/src/relayer/standard/eip6963.ts

@@ -2,7 +2,7 @@ import { Constants, Payload } from '@0xsequence/wallet-primitives'
 import { EIP1193Provider } from 'mipd'
 import { AbiFunction, Address, Bytes, Hex, TransactionReceipt } from 'ox'
 import { FeeOption, FeeQuote, OperationStatus, Relayer } from '../relayer.js'
-import { IntentPrecondition } from './rpc/relayer.gen.js'
+import { FeeToken, IntentPrecondition } from './rpc/relayer.gen.js'
 import { decodePrecondition } from '../../preconditions/index.js'
 import {
   erc20BalanceOf,
@@ -47,6 +47,12 @@ export class LocalRelayer implements Relayer {
     return new LocalRelayer(new EIP1193ProviderAdapter(provider))
   }
 
+  feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: FeeToken[]; paymentAddress?: Address.Address }> {
+    return Promise.resolve({
+      isFeeRequired: false,
+    })
+  }
+
   feeOptions(
     wallet: Address.Address,
     chainId: number,

packages/wallet/core/src/relayer/standard/local.ts

@@ -2,6 +2,7 @@ import { Payload, Precondition } from '@0xsequence/wallet-primitives'
 import { Address, Hex, Provider, Secp256k1, TransactionEnvelopeEip1559, TransactionReceipt } from 'ox'
 import { LocalRelayer } from './local.js'
 import { FeeOption, FeeQuote, OperationStatus, Relayer } from '../relayer.js'
+import { FeeToken } from './rpc/relayer.gen.js'
 
 export class PkRelayer implements Relayer {
   public readonly kind: 'relayer' = 'relayer'
@@ -106,6 +107,10 @@ export class PkRelayer implements Relayer {
     return providerChainId === chainId
   }
 
+  feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: FeeToken[]; paymentAddress?: Address.Address }> {
+    return this.relayer.feeTokens()
+  }
+
   feeOptions(
     wallet: Address.Address,
     chainId: number,

packages/wallet/core/src/relayer/standard/pk-relayer.ts

@@ -109,6 +109,27 @@ export class RpcRelayer implements Relayer {
     return Promise.resolve(this.chainId === chainId)
   }
 
+  async feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: RpcFeeToken[]; paymentAddress?: Address.Address }> {
+    try {
+      const { isFeeRequired, tokens, paymentAddress } = await this.client.feeTokens()
+      if (isFeeRequired) {
+        Address.assert(paymentAddress)
+        return {
+          isFeeRequired,
+          tokens,
+          paymentAddress,
+        }
+      }
+      // Not required
+      return {
+        isFeeRequired,
+      }
+    } catch (e) {
+      console.warn('RpcRelayer.feeTokens failed:', e)
+      return { isFeeRequired: false }
+    }
+  }
+
   async feeOptions(
     wallet: Address.Address,
     chainId: number,

packages/wallet/core/src/relayer/standard/rpc/index.ts

@@ -1,5 +1,5 @@
 /* eslint-disable */
-// sequence-relayer v0.4.1 62fe2b49d57c4a0d3960ac1176d48ecfffc7af5a
+// sequence-relayer v0.4.1 93ac61641d0351211680e2092673726b5c4f1848
 // --
 // Code generated by [email protected] with typescript generator. DO NOT EDIT.
 //
@@ -16,7 +16,7 @@ export const WebRPCVersion = 'v1'
 export const WebRPCSchemaVersion = 'v0.4.1'
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = '62fe2b49d57c4a0d3960ac1176d48ecfffc7af5a'
+export const WebRPCSchemaHash = '93ac61641d0351211680e2092673726b5c4f1848'
 
 type WebrpcGenVersions = {
   webrpcGenVersion: string
@@ -557,6 +557,7 @@ export interface FeeTokensArgs {}
 export interface FeeTokensReturn {
   isFeeRequired: boolean
   tokens: Array<FeeToken>
+  paymentAddress: string
 }
 export interface FeeOptionsArgs {
   wallet: string
@@ -950,6 +951,7 @@ export class Relayer implements Relayer {
           return {
             isFeeRequired: <boolean>_data.isFeeRequired,
             tokens: <Array<FeeToken>>_data.tokens,
+            paymentAddress: <string>_data.paymentAddress,
           }
         })
       },

packages/wallet/core/src/relayer/standard/rpc/relayer.gen.ts

@@ -2,6 +2,7 @@ import { ETHTxnStatus, IntentPrecondition, Relayer as Service } from '@0xsequenc
 import { Payload } from '@0xsequence/wallet-primitives'
 import { AbiFunction, Address, Bytes, Hex } from 'ox'
 import { FeeOption, FeeQuote, OperationStatus, Relayer } from '../relayer.js'
+import { FeeToken } from './rpc/relayer.gen.js'
 
 export class SequenceRelayer implements Relayer {
   public readonly kind: 'relayer' = 'relayer'
@@ -18,6 +19,22 @@ export class SequenceRelayer implements Relayer {
     return true
   }
 
+  async feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: FeeToken[]; paymentAddress?: Address.Address }> {
+    const { isFeeRequired, tokens, paymentAddress } = await this.service.feeTokens()
+    if (isFeeRequired) {
+      Address.assert(paymentAddress)
+      return {
+        isFeeRequired,
+        tokens,
+        paymentAddress,
+      }
+    }
+    // Not required
+    return {
+      isFeeRequired,
+    }
+  }
+
   async feeOptions(
     wallet: Address.Address,
     _chainId: number,