Merge pull request #193 from zavodil/signMessage

feat: Sign message

This PR enables the use of the signMessage method from the wallet-selector. The user can sign a message with any of the connected wallets for further [signature verification](https://docs.near.org/build/web3-apps/backend/) on a third-party authentication server.

- Add `Near.signMessage` function to sign arbitrary message with NEAR account. The message that the user needs to sign contains 4 fields:
  - `message`: The message that the user is signing.
  - `recipient`: The recipient of the message.
  - `nonce`: The challenge that the user is signing.
  - `callbackUrl`: The URL that the wallet will call with the signature.
How to verify the signature: https://docs.near.org/build/web3-apps/backend/#3-verify-the-signature

- Add get/set methods for `window.location.hash`. `Set` method only accepts an empty string as a value.

CHANGELOG.md

@@ -3,6 +3,14 @@
 ## Pending
 
 - Add 2s animation delay to the loading spinner. Makes it visually less jarring when loading is quick.
+- Add `Near.signMessage` function to sign arbitrary message with NEAR account. The message that the user needs to sign contains 4 fields:
+  - `message`: The message that the user is signing.
+  - `recipient`: The recipient of the message.
+  - `nonce`: The challenge that the user is signing.
+  - `callbackUrl`: The URL that the wallet will call with the signature.
+How to verify the signature: https://docs.near.org/build/web3-apps/backend/#3-verify-the-signature
+
+- Add get/set methods for `window.location.hash`. `Set` method only accepts an empty string as a value.
 
 ## 2.6.1
 

src/lib/data/near.js

@@ -284,6 +284,11 @@ function setupContract(near, contractId, options) {
   return contract;
 }
 
+async function signMessage(near, args) {
+  const wallet = await (await near.selector).wallet();
+  return wallet.signMessage(args);
+}
+
 async function viewCall(
   provider,
   blockId,
@@ -402,6 +407,10 @@ async function _initNear({
           blockId: undefined,
         };
 
+  _near.signMessage = (args) => {
+    return signMessage(_near, args);
+  }
+
   _near.viewCall = (contractId, methodName, args, blockHeightOrFinality) => {
     const { blockId, finality } = transformBlockId(blockHeightOrFinality);
     const nearViewCall = () =>

src/lib/vm/vm.js

@@ -1612,6 +1612,31 @@ export default class VM {
     };
 
     const Near = {
+      signMessage: (...args) => {
+        if (args.length === 1) {
+          if (isObject(args[0])) {
+            return this.near.signMessage(args[0]);
+          } else {
+            throw new Error(
+              "Method: Near.signMessage. Required argument: '{message, recipient, nonce, callbackUrl}'"
+            );
+          }
+        } else if (args.length < 3) {
+          throw new Error(
+            "Method: Near.signMessage. Required arguments: 'message', 'recipient', 'nonce'. Optional: 'callbackUrl'"
+          );
+        }
+        else {
+          const [
+            message,
+            recipient,
+            nonce,
+            callbackUrl
+          ] = args;
+
+          return this.near.signMessage({message, recipient, nonce, callbackUrl});
+        }
+      },
       view: (...args) => {
         if (args.length < 2) {
           throw new Error(
@@ -2327,6 +2352,19 @@ export default class VM {
     this.state = {
       ...GlobalInjected,
       ...this.globalFunctions,
+      window: {
+        location: {
+          get hash() {
+            return window.location.hash
+          },
+          set hash(value) {
+            if (value !== "") {
+              throw new Error("Set `window.location.hash` only accepts an empty string as a value.");
+            }
+            history.pushState(value, document.title, window.location.pathname + window.location.search);
+          }
+        }
+      },
       props: isObject(props) ? Object.assign({}, props) : props,
       context,
       state,