Merge pull request #780 from near/relayer

Add relayerUrl to configuration options
near · Apr 25, 2023 · 14a037f · 14a037f
2 parents 984d0d7 + d82f38d
commit 14a037f
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 0 deletions.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -48,6 +48,7 @@ const selector = await setupWalletSelector({
 - `randomizeWalletOrder` (`boolean?`): Randomize wallets order in the `More` section of the UI.
 - `allowMultipleSelectors` (`boolean?`): Optionally allow creating new instances of wallet selector.
 - `languageCode` (`string?`): Optionally set specific ISO 639-1 two-letter language code, disables language detection based on the browser's settings.
+- `relayerUrl` (`string?`): Optionally set the URL that meta-transaction enabled wallet modules can use to submit DelegateActions to a relayer
 - `storage` (`StorageService?`): Async storage implementation. Useful when [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) is unavailable. Defaults to `localStorage`.
 - `modules` (`Array<WalletModuleFactory>`): List of wallets to support in your dApp.
 

diff --git a/packages/core/docs/api/selector.md b/packages/core/docs/api/selector.md
@@ -13,6 +13,8 @@
 - `optimizeWalletOrder` (`boolean`): Whether wallet order optimization is enabled.
 - `randomizeWalletOrder` (`boolean`): Weather wallet order randomization is enabled.
 - `languageCode` (`string?`): ISO 639-1 two-letter language code.
+- `relayerUrl` (`string?`): The URL where DelegateActions are sent by meta transaction enabled wallet modules.
+
 **Description**
 
 Resolved variation of the options passed to `setupWalletSelector`.

diff --git a/packages/core/src/lib/options.ts b/packages/core/src/lib/options.ts
@@ -36,6 +36,7 @@ export const resolveOptions = (params: WalletSelectorParams) => {
     debug: params.debug || false,
     optimizeWalletOrder: params.optimizeWalletOrder === false ? false : true,
     randomizeWalletOrder: params.randomizeWalletOrder || false,
+    relayerUrl: params.relayerUrl || undefined,
   };
 
   return {

diff --git a/packages/core/src/lib/options.types.ts b/packages/core/src/lib/options.types.ts
@@ -16,4 +16,5 @@ export interface Options {
   debug: boolean;
   optimizeWalletOrder: boolean;
   randomizeWalletOrder: boolean;
+  relayerUrl: string | undefined;
 }
diff --git a/packages/core/src/lib/wallet-selector.types.ts b/packages/core/src/lib/wallet-selector.types.ts
@@ -17,6 +17,7 @@ export interface WalletSelectorParams {
   allowMultipleSelectors?: boolean;
   randomizeWalletOrder?: boolean;
   languageCode?: SupportedLanguage;
+  relayerUrl?: string;
 }
 
 export type WalletSelectorStore = ReadOnlyStore;