feat: Add support for signInMessage method

.vscode/settings.json

@@ -2,8 +2,7 @@
   "eslint.format.enable": true,
   "prettier.enable": false,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint":
-    true
+    "source.fixAll.eslint": "explicit"
   },
   "typescript.tsdk": "node_modules/typescript/lib"
 }

examples/angular/src/app/components/content/content.component.html

@@ -20,5 +20,6 @@
 
 <ng-container *ngIf="!accountId">
   <button (click)="signIn()">Log In</button>
+  <button (click)="signInMessage()">Sign In Message</button>
   <near-wallet-selector-sign-in></near-wallet-selector-sign-in>
 </ng-container>

examples/angular/src/app/components/content/content.component.ts

@@ -112,6 +112,13 @@ export class ContentComponent implements OnInit, OnDestroy {
     this.modal.show();
   }
 
+  signInMessage() {
+    const message = "test message to sign";
+    const nonce = Buffer.from(Array.from(Array(32).keys()));
+    const recipient = "guest-book.testnet";
+    this.modal.signInMessage({ message, nonce, recipient });
+  }
+
   async signOut() {
     const wallet = await this.selector.wallet();
 
@@ -211,14 +218,14 @@ export class ContentComponent implements OnInit, OnDestroy {
     const publicKey = urlParams.get("publicKey") as string;
     const signature = urlParams.get("signature") as string;
 
-    if (!accId && !publicKey && !signature) {
-      return;
-    }
-
     const message: SignMessageParams = JSON.parse(
       localStorage.getItem("message") as string
     );
 
+    if ((!accId && !publicKey && !signature) || !message) {
+      return;
+    }
+
     const signedMessage = {
       accountId: accId,
       publicKey,
@@ -328,7 +335,7 @@ export class ContentComponent implements OnInit, OnDestroy {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         signerId: this.accountId!,
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        receiverId: contract!.contractId,
+        receiverId: contract?.contractId || CONTRACT_ID,
         actions: [
           {
             type: "FunctionCall",

examples/react/components/Content.tsx

@@ -135,6 +135,13 @@ const Content: React.FC = () => {
     modal.show();
   };
 
+  const handleSignInMessage = () => {
+    const message = "test message to sign";
+    const nonce = Buffer.from(Array.from(Array(32).keys()));
+    const recipient = "guest-book.testnet";
+    modal.signInMessage({ message, nonce, recipient });
+  };
+
   const handleSignOut = async () => {
     const wallet = await selector.wallet();
 
@@ -192,7 +199,7 @@ const Content: React.FC = () => {
       for (let i = 0; i < 2; i += 1) {
         transactions.push({
           signerId: accountId!,
-          receiverId: contract!.contractId,
+          receiverId: contract?.contractId || CONTRACT_ID,
           actions: [
             {
               type: "FunctionCall",
@@ -275,14 +282,14 @@ const Content: React.FC = () => {
     const publicKey = urlParams.get("publicKey") as string;
     const signature = urlParams.get("signature") as string;
 
-    if (!accId && !publicKey && !signature) {
-      return;
-    }
-
     const message: SignMessageParams = JSON.parse(
       localStorage.getItem("message")!
     );
 
+    if ((!accId && !publicKey && !signature) || !message) {
+      return;
+    }
+
     const signedMessage = {
       accountId: accId,
       publicKey,
@@ -378,6 +385,7 @@ const Content: React.FC = () => {
       <Fragment>
         <div>
           <button onClick={handleSignIn}>Log in</button>
+          <button onClick={handleSignInMessage}>Sign In Message</button>
         </div>
         <SignIn />
       </Fragment>

packages/core/docs/api/selector.md

@@ -153,6 +153,29 @@ Programmatically change active account which will be used to sign and send trans
 selector.setActiveAccount("sometestaccount.testnet");
 ```
 
+### `.signInType()`
+
+**Parameters**
+
+- N/A
+
+**Returns**
+
+- `SignInType`
+
+**Description**
+
+Programmatically check the sign-in type, if signed-in with `wallet.signIn(params)` returns "key" if signed in with `wallet.signInMessage(params)` returns "message"
+
+> Note: This function will throw when calling without being signed in.
+
+**Example**
+
+```ts
+const signInType = selector.signInType();
+
+```
+
 ### `.on(event, callback)`
 
 **Parameters**
@@ -183,7 +206,7 @@ subscription.remove();
 
 **Parameters**
 
-- `event` (`string`): Name of the event. This can be: `signedIn | signedOut | accountsChanged | networkChanged | uriChanged`.
+- `event` (`string`): Name of the event. This can be: `signedIn | signedInMessage | signedOut | accountsChanged | networkChanged | uriChanged`.
 - `callback` (`Function`): Original handler passed to `.on(event, callback)`.
 
 **Returns**

packages/core/docs/api/state.md

@@ -93,3 +93,45 @@ Returns ID-s of 5 recently signed in wallets.
 const { recentlySignedInWallets } = selector.store.getState();
 console.log(recentlySignedInWallets); // ["my-near-wallet", "sender", ...]
 ```
+
+### `.message`
+
+**Returns**
+
+- `SignInMessageParams | null`
+  - `message` (`string`): The message that wants to be transmitted.
+  - `nonce` (`Buffer`): A nonce that uniquely identifies this instance of the message, denoted as a 32 bytes array (a fixed `Buffer` in JS/TS).
+  - `recipient` (`string`): The recipient to whom the message is destined (e.g. "alice.near" or "myapp.com").
+  - `callbackUrl` (`string?`): Optional, applicable to browser wallets (e.g. MyNearWallet). The URL to call after the signing process.
+  - `state` (`string?`): Optional, applicable to browser wallets (e.g. MyNearWallet). A state for authentication purposes.
+
+
+**Description**
+
+Returns the original message that was used for `signInMessage`.
+
+**Example**
+
+```ts
+const { message } = selector.store.getState();
+console.log(message); // { message: "test", nonce: [0...31], recipient: "myapp.com" }
+```
+
+### `.signedInMessageAccount`
+
+**Returns**
+
+- `Account | null`
+  - `accountId` (`string`): The account name to which the publicKey corresponds as plain text (e.g. "alice.near").
+  - `publicKey` (`string`): The public counterpart of the key used to sign, expressed as a string with format "<key-type>:<base58-key-bytes>" (e.g. "ed25519:6TupyNrcHGTt5XRLmHTc2KGaiSbjhQi1KHtCXTgbcr4Y")
+
+**Description**
+
+Returns the `Account` that was signed with `signInMessage`.
+
+**Example**
+
+```ts
+const { signedMessage } = selector.store.getState();
+console.log(signedMessage); // { accountId: "alice.near", publicKey: "ed25519:6TupyNrcHGTt5XRLmHTc2KGaiSbjhQi1KHtCXTgbcr4Y" }
+```

packages/core/docs/api/wallet.md

@@ -326,3 +326,36 @@ Allows users to sign a message for a specific recipient using their NEAR account
   await wallet.signMessage({ message, recipient, nonce });
 })();
 ```
+
+### `.signInMessage(params)`
+
+**Parameters**
+- `params` (`object`)
+  - `message` (`string`): The message that wants to be transmitted.
+  - `nonce` (`Buffer`): A nonce that uniquely identifies this instance of the message, denoted as a 32 bytes array (a fixed `Buffer` in JS/TS).
+  - `recipient` (`string`): The recipient to whom the message is destined (e.g. "alice.near" or "myapp.com").
+  - `callbackUrl` (`string?`): Optional, applicable to browser wallets (e.g. MyNearWallet). The URL to call after the signing process. Defaults to `window.location.href`.
+  - `state` (`string?`): Optional, applicable to browser wallets (e.g. MyNearWallet). A state for authentication purposes.
+
+**Returns**
+- `Promise<SignedMessage | void>`
+
+**Description**
+
+Allows users to sign-in (login) to a dApp without creating a LAK by signing a message for a specific recipient using their NEAR account, based on the [NEP413](https://github.com/near/NEPs/blob/master/neps/nep-0413.md).
+
+**Example**
+
+```ts
+// MyNearWallet
+(async () => {
+  const wallet = await selector.wallet("my-near-wallet");
+  const message = "test message for verification";
+  let nonceArray: Uint8Array = new Uint8Array(32);
+  nonceArray = crypto.getRandomValues(nonceArray);
+  const nonce = Buffer.from(nonceArray);
+  const recipient = "myapp.com";
+
+  await wallet.signInMessage({ message, nonce, recipient });
+})();
+```

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

@@ -74,6 +74,12 @@ const MyWallet: WalletBehaviourFactory<BrowserWallet> = ({
       // that allows users to sign a message for a specific receiver using their NEAR account
       return await wallet.signMessage({ message, nonce, recipient, callbackUrl, state });
     },
+    async signInMessage({ message, nonce, recipient, callbackUrl, state }) {
+      // Sign in to My Wallet withotut creating a LAK for access to account(s).
+      // Signs the message, verifies it and returns the `SignedMessage`.
+
+      return [];
+    },
   };
 };
 

packages/core/src/index.ts

@@ -3,6 +3,7 @@ export type {
   WalletSelectorParams,
   WalletSelectorEvents,
   WalletSelectorStore,
+  SignInType,
 } from "./lib/wallet-selector.types";
 export { setupWalletSelector } from "./lib/wallet-selector";
 
@@ -70,6 +71,7 @@ export type {
   AccountImportData,
   SignedMessage,
   SignMessageParams,
+  SignInMessageParams,
 } from "./lib/wallet";
 
 export type { FinalExecutionOutcome } from "near-api-js/lib/providers";
@@ -81,6 +83,7 @@ export {
   verifyFullKeyBelongsToUser,
   verifySignature,
   serializeNep413,
+  verifyMessageNEP413,
 } from "./lib/helpers";
 
 export { translate, allowOnlyLanguage } from "./lib/translate/translate";

packages/core/src/lib/constants.ts

@@ -6,3 +6,7 @@ export const PENDING_CONTRACT = "contract:pending";
 
 export const SELECTED_WALLET_ID = `selectedWalletId`;
 export const PENDING_SELECTED_WALLET_ID = `selectedWalletId:pending`;
+
+export const SIGN_IN_MESSAGE = "message";
+export const PENDING_SIGN_IN_MESSAGE = "message:pending";
+export const SIGNED_IN_MESSAGE_ACCOUNT = "signedInMessageAccount";

packages/core/src/lib/helpers/verify-signature/verify-signature.ts

@@ -8,6 +8,8 @@ import type {
 } from "./verify-signature.types";
 import { Payload, payloadSchema } from "./payload";
 import type { AccessKeyView } from "near-api-js/lib/providers/provider";
+import type { SignedMessage, SignMessageParams } from "../../wallet";
+import type { Network } from "../../options.types";
 
 export const verifySignature = ({
   publicKey,
@@ -64,3 +66,34 @@ export const verifyFullKeyBelongsToUser = async ({
 
   return permission === "FullAccess";
 };
+
+export const verifyMessageNEP413 = async (
+  message: SignMessageParams,
+  signedMessage: SignedMessage,
+  network: Network
+) => {
+  const isSignatureValid = verifySignature({
+    message: message.message,
+    nonce: message.nonce,
+    recipient: message.recipient,
+    publicKey: signedMessage.publicKey,
+    signature: signedMessage.signature,
+    callbackUrl: message.callbackUrl,
+  });
+
+  if (!isSignatureValid) {
+    throw Error("Failed to verify the signature");
+  }
+
+  const isFullAccess = await verifyFullKeyBelongsToUser({
+    publicKey: signedMessage.publicKey,
+    accountId: signedMessage.accountId,
+    network,
+  });
+
+  if (!isFullAccess) {
+    throw Error("Message was not signed with full access key");
+  }
+
+  return true;
+};