feat: Add signInMulti method

packages/coin98-wallet/src/lib/coin98-wallet.ts

@@ -105,6 +105,14 @@ const Coin98Wallet: WalletBehaviourFactory<InjectedWallet> = async ({
       return getAccounts();
     },
 
+    async signInMulti({ permissions }) {
+      logger.log("signInMulti", { permissions });
+
+      throw new Error(
+        `The signInMulti method is not supported by ${metadata.name}`
+      );
+    },
+
     async signOut() {
       // Ignore if unsuccessful (returns false).
       await _state.wallet.near.disconnect();

packages/core/docs/api/state.md

@@ -18,6 +18,25 @@ Returns the signed in contract.
 const { contract } = selector.store.getState();
 console.log(contract); // { contractId: "test.testnet", methodNames: [] }
 ```
+### `.contracts`
+
+**Returns**
+
+- `MultiContractState | null`
+  - `contractId` (`string`): Account ID of the Smart Contract.
+  - `methodNames` (`Array<string>`): List of methods that can only be invoked on the Smart Contract. Empty list means no restriction.
+
+**Description**
+
+Returns the signed in contracts when signing-in with `signInMulti`.
+
+**Example**
+
+```ts
+// MultiContractState = Array<ContractState>;
+const { contracts } = selector.store.getState();
+console.log(contracts); // [{ contractId: "test.testnet", methodNames: [] }, { contractId: "test1.testnet", methodNames: [] }]
+```
 
 ### `.modules`
 

packages/core/docs/api/wallet.md

@@ -82,9 +82,9 @@ Returns meta information about the wallet such as `name`, `description`, `iconUr
   - `contractId` (`string`): Account ID of the Smart Contract.
   - `methodNames` (`Array<string>?`): Specify limited access to particular methods on the Smart Contract.
   - `accounts` (`Array<{derivationPath: string, publicKey: string, accountId: string}>?`): Required for hardware wallets (e.g. Ledger). This is a list of `accounts` linked to public keys on your device.
-  - `qrCodeModal` (`boolean?`): Optional for bridge wallets (e.g Wallet Connect). This indicates whether to render QR Code in wallet selector modal or use the default vendor modal.
-  - `successUrl` (`string?`): Optional for browser wallets (e.g MyNearWallet and HERE Wallet). After successfully signing in where to redirect.
-  - `failureUrl` (`string?`): Optional for browser wallets (e.g MyNearWallet and HERE Wallet). After failing to sign in where to redirect.
+  - `qrCodeModal` (`boolean?`): Optional for bridge wallets (e.g. Wallet Connect). This indicates whether to render QR Code in wallet selector modal or use the default vendor modal.
+  - `successUrl` (`string?`): Optional for browser wallets (e.g. MyNearWallet and NEAR Wallet). After successfully signing in where to redirect.
+  - `failureUrl` (`string?`): Optional for browser wallets (e.g. MyNearWallet and NEAR Wallet). After failing to sign in where to redirect.
 
 **Returns**
 
@@ -139,6 +139,94 @@ Programmatically sign in. Hardware wallets (e.g. Ledger) require `derivationPath
 })();
 ```
 
+### `.signInMulti(params)`
+
+**Parameters**
+
+- `params` (`object`)
+
+  - `permissions`(`Array<{allowance?: BN, receiverId: string, methodNames: Array<string>}>`): List of Account ID-s of the Smart Contracts and the limited access to particular methods on the Smart Contract.
+  - `accounts` (`Array<{derivationPath: string, publicKey: string, accountId: string}>?`): Required for hardware wallets (e.g. Ledger). This is a list of `accounts` linked to public keys on your device.
+  - `qrCodeModal` (`boolean?`): Optional for bridge wallets (e.g. Wallet Connect). This indicates whether to render QR Code in wallet selector modal or use the default vendor modal.
+  - `successUrl` (`string?`): Optional for browser wallets (e.g. MyNearWallet and NEAR Wallet). After successfully signing in where to redirect.
+  - `failureUrl` (`string?`): Optional for browser wallets (e.g. MyNearWallet and NEAR Wallet). After failing to sign in where to redirect.
+
+**Returns**
+
+- `Promise<Array<Account>>`
+
+**Description**
+
+Programmatically sign in. Hardware wallets (e.g. Ledger) require `derivationPaths` to validate access key permissions.
+
+**Example**
+
+```ts
+// NEAR Wallet.
+(async () => {
+  const wallet = await selector.wallet("near-wallet");
+  const accounts = await wallet.signInMulti({
+    permissions: [
+      { receiverId: "test.testnet", methodNames: [] },
+      { receiverId: "test1.testnet", methodNames: [] }
+    ]
+  });
+})();
+
+// Sender.
+(async () => {
+  const wallet = await selector.wallet("sender");
+  const accounts = await wallet.signInMulti({
+    permissions: [
+      { receiverId: "test.testnet", methodNames: [] },
+      { receiverId: "test1.testnet", methodNames: [] }
+    ]
+  });
+})();
+
+// Math Wallet.
+(async () => {
+  const wallet = await selector.wallet("math-wallet");
+  const accounts = await wallet.signInMulti({
+    permissions: [
+      { receiverId: "test.testnet", methodNames: [] },
+      { receiverId: "test1.testnet", methodNames: [] }
+    ]
+  });
+})();
+
+// Ledger
+(async () => {
+  const wallet = await selector.wallet("ledger");
+  const derivationPath = "44'/397'/0'/0'/1'";
+  const publicKey = await wallet.getPublicKey(derivationPath);
+  const accountId = "youraccountid.testnet"
+
+  const accounts = await wallet.signIn({
+    permissions: [
+      { receiverId: "test.testnet", methodNames: [] },
+      { receiverId: "test1.testnet", methodNames: [] }
+    ],
+    accounts: [{
+      derivationPath,
+      publicKey,
+      accountId
+    }],
+  });
+})();
+
+// WalletConnect.
+(async () => {
+  const wallet = await selector.wallet("wallet-connect");
+  const accounts = await wallet.signInMulti({
+    permissions: [
+      { receiverId: "test.testnet", methodNames: [] },
+      { receiverId: "test1.testnet", methodNames: [] }
+    ]
+  });
+})();
+```
+
 ### `.signOut()`
 
 **Parameters**

packages/core/docs/guides/custom-wallets.md

@@ -31,6 +31,12 @@ const MyWallet: WalletBehaviourFactory<BrowserWallet> = ({
       return [];
     },
 
+    async signInMulti({ permissions }) {
+      // Sign in to My Wallet with multiple contracts.
+
+      return [];
+    },
+
     async signOut() {
       // Sign out from accounts and cleanup (e.g. listeners).
     },

packages/core/src/index.ts

@@ -21,6 +21,7 @@ export type { Optional } from "./lib/utils.types";
 export type {
   WalletSelectorState,
   ContractState,
+  MultiContractState,
   ModuleState,
   AccountState,
 } from "./lib/store.types";
@@ -35,6 +36,7 @@ export type {
   WalletMetadata,
   WalletEvents,
   SignInParams,
+  SignInMultiParams,
   BrowserWalletMetadata,
   BrowserWalletBehaviour,
   BrowserWallet,

packages/core/src/lib/constants.ts

@@ -4,5 +4,8 @@ export const RECENTLY_SIGNED_IN_WALLETS = "recentlySignedInWallets";
 export const CONTRACT = "contract";
 export const PENDING_CONTRACT = "contract:pending";
 
+export const CONTRACTS = "contracts";
+export const PENDING_CONTRACTS = "contracts:pending";
+
 export const SELECTED_WALLET_ID = `selectedWalletId`;
 export const PENDING_SELECTED_WALLET_ID = `selectedWalletId:pending`;

packages/core/src/lib/services/wallet-modules/wallet-modules.service.ts

@@ -7,10 +7,16 @@ import type {
   WalletModuleFactory,
   Account,
   InstantLinkWallet,
+  SignInMultiParams,
 } from "../../wallet";
 import type { StorageService } from "../storage/storage.service.types";
 import type { Options } from "../../options.types";
-import type { ContractState, ModuleState, Store } from "../../store.types";
+import type {
+  ContractState,
+  ModuleState,
+  Store,
+  MultiContractState,
+} from "../../store.types";
 import { EventEmitter } from "../event-emitter/event-emitter.service";
 import type { WalletSelectorEvents } from "../../wallet-selector.types";
 import { Logger, logger } from "../logger/logger.service";
@@ -19,6 +25,7 @@ import {
   PACKAGE_NAME,
   PENDING_CONTRACT,
   PENDING_SELECTED_WALLET_ID,
+  PENDING_CONTRACTS,
 } from "../../constants";
 import { JsonStorage } from "../storage/json-storage.service";
 import type { ProviderService } from "../provider/provider.service.types";
@@ -80,12 +87,20 @@ export class WalletModules {
       PENDING_CONTRACT
     );
 
+    const pendingContracts = await jsonStorage.getItem<MultiContractState>(
+      PENDING_CONTRACTS
+    );
+
     if (pendingSelectedWalletId && pendingContract) {
       const accounts = await this.validateWallet(pendingSelectedWalletId);
 
       await jsonStorage.removeItem(PENDING_SELECTED_WALLET_ID);
       await jsonStorage.removeItem(PENDING_CONTRACT);
 
+      if (pendingContracts) {
+        await jsonStorage.removeItem(PENDING_CONTRACTS);
+      }
+
       if (accounts.length) {
         const { selectedWalletId } = this.store.getState();
         const selectedWallet = await this.getWallet(selectedWalletId);
@@ -105,11 +120,12 @@ export class WalletModules {
           contract: pendingContract,
           selectedWalletId: pendingSelectedWalletId,
           recentlySignedInWallets: recentlySignedInWalletsFromPending,
+          contracts: pendingContracts,
         };
       }
     }
 
-    const { contract, selectedWalletId } = this.store.getState();
+    const { contract, selectedWalletId, contracts } = this.store.getState();
     const accounts = await this.validateWallet(selectedWalletId);
 
     const recentlySignedInWallets = await jsonStorage.getItem<Array<string>>(
@@ -122,6 +138,7 @@ export class WalletModules {
         contract: null,
         selectedWalletId: null,
         recentlySignedInWallets: recentlySignedInWallets || [],
+        contracts: null,
       };
     }
 
@@ -130,6 +147,7 @@ export class WalletModules {
       contract,
       selectedWalletId,
       recentlySignedInWallets: recentlySignedInWallets || [],
+      contracts,
     };
   }
 
@@ -170,7 +188,7 @@ export class WalletModules {
 
   private async onWalletSignedIn(
     walletId: string,
-    { accounts, contractId, methodNames }: WalletEvents["signedIn"]
+    { accounts, contractId, methodNames, contracts }: WalletEvents["signedIn"]
   ) {
     const { selectedWalletId } = this.store.getState();
     const jsonStorage = new JsonStorage(this.storage, PACKAGE_NAME);
@@ -183,6 +201,13 @@ export class WalletModules {
       if (module.type === "browser") {
         await jsonStorage.setItem(PENDING_SELECTED_WALLET_ID, walletId);
         await jsonStorage.setItem<ContractState>(PENDING_CONTRACT, contract);
+
+        if (contracts) {
+          await jsonStorage.setItem<MultiContractState>(
+            PENDING_CONTRACTS,
+            contracts
+          );
+        }
       }
 
       return;
@@ -198,14 +223,21 @@ export class WalletModules {
 
     this.store.dispatch({
       type: "WALLET_CONNECTED",
-      payload: { walletId, contract, accounts, recentlySignedInWallets },
+      payload: {
+        walletId,
+        contract,
+        accounts,
+        recentlySignedInWallets,
+        contracts,
+      },
     });
 
     this.emitter.emit("signedIn", {
       walletId,
       contractId,
       methodNames,
       accounts,
+      contracts,
     });
   }
 
@@ -255,6 +287,7 @@ export class WalletModules {
 
   private decorateWallet(wallet: Wallet): Wallet {
     const _signIn = wallet.signIn;
+    const _signInMulti = wallet.signInMulti;
     const _signOut = wallet.signOut;
 
     wallet.signIn = async (params: never) => {
@@ -265,6 +298,25 @@ export class WalletModules {
         accounts,
         contractId,
         methodNames,
+        contracts: null,
+      });
+
+      return accounts;
+    };
+
+    wallet.signInMulti = async (params: never) => {
+      const accounts = await _signInMulti(params);
+
+      const { permissions } = params as SignInMultiParams;
+      const contracts: MultiContractState = permissions.map((permission) => ({
+        contractId: permission.receiverId,
+        methodNames: permission.methodNames,
+      }));
+      await this.onWalletSignedIn(wallet.id, {
+        accounts,
+        contractId: contracts[0].contractId,
+        methodNames: contracts[0].methodNames,
+        contracts,
       });
 
       return accounts;
@@ -374,8 +426,13 @@ export class WalletModules {
 
     this.modules = modules;
 
-    const { accounts, contract, selectedWalletId, recentlySignedInWallets } =
-      await this.resolveStorageState();
+    const {
+      accounts,
+      contract,
+      selectedWalletId,
+      recentlySignedInWallets,
+      contracts,
+    } = await this.resolveStorageState();
 
     this.store.dispatch({
       type: "SETUP_WALLET_MODULES",
@@ -385,6 +442,7 @@ export class WalletModules {
         contract,
         selectedWalletId,
         recentlySignedInWallets,
+        contracts,
       },
     });