@concordium/browser-wallet-api-helpers 2.3.0 → 2.5.0

package/README.md

@@ -74,6 +74,15 @@ if (accountAddress) {
 }
 ```
 
+### getSelectedChain
+
+This can be invoked to get the genesis hash of the chain selected in the wallet. The method returns a `Promise`, resolving with the genesis hash (as a hex string) of the selected chain, or undefined if the wallet is locked or has not been set up by the user.
+
+```typescript
+const provider = await detectConcordiumProvider();
+const genesisHash = await provider.getSelectedChain();
+```
+
 N.B. In the current version, if the currently selected account has not whitelisted the dApp, the returned account will not actually be the most recently selected account, but instead the oldest account that has whitelisted the dApp.
 
 ### sendTransaction
@@ -142,7 +151,12 @@ It is possible to sign arbitrary messages using the keys for an account stored i
 
 If the wallet is locked, or you have not connected with the wallet (or previously been whitelisted) or if the user rejects signing the meesage, the `Promise` will reject.
 
-The following exemplifies requesting a signature of a message:
+The message should be either a utf8 string or an object with the following fields:
+
+-   data: A hex string representing the bytes that should be signed.
+-   schema: A base64 string that represents a schema for the data field, and which can be used to deserialize the data into a JSON format. (For reference, the type of schema used here is the same that is used for smart contract types)
+
+The following exemplifies requesting a signature of a message, where the message is a utf8 string:
 
 ```typescript
 const provider = await detectConcordiumProvider();
@@ -152,6 +166,31 @@ const signature = await provider.signMessage(
 );
 ```
 
+The following exemplifies requesting a signature of a message, where the message is an object:
+
+```typescript
+const provider = await detectConcordiumProvider();
+const signature = await provider.signMessage('4MyVHYbRkAU6fqQsoSDzni6mrVz1KEvhDJoMVmDmrCgPBD8b7S', {
+    data: '00000b0000004120676f6f64206974656d00a4fbca84010000',
+    schema: 'FAAEAAAADQAAAGF1Y3Rpb25fc3RhdGUVAgAAAAoAAABOb3RTb2xkWWV0AgQAAABTb2xkAQEAAAALDgAAAGhpZ2hlc3RfYmlkZGVyFQIAAAAEAAAATm9uZQIEAAAAU29tZQEBAAAACwQAAABpdGVtFgIDAAAAZW5kDQ',
+});
+```
+
+In this example the user will be shown:
+
+```JSON
+{
+  "auction_state": {
+    "NotSoldYet": []
+  },
+  "end": "2022-12-01T00:00:00+00:00",
+  "highest_bidder": {
+    "None": []
+  },
+  "item": "A good item"
+}
+```
+
 ### Add CIS-2 Tokens
 
 It is possible to suggest CIS-2 tokens to be added to an account's display. This method returns a `Promise` resolving with a list containing the ids of the tokens that were added.

package/lib/wallet-api-types.d.ts

@@ -1,8 +1,14 @@
-import type { AccountTransactionPayload, AccountTransactionSignature, AccountTransactionType, InitContractPayload, JsonRpcClient, SchemaVersion, UpdateContractPayload, IdStatement, IdProofOutput } from '@concordium/web-sdk';
+import type { AccountTransactionPayload, AccountTransactionSignature, AccountTransactionType, InitContractPayload, JsonRpcClient, SchemaVersion, UpdateContractPayload, IdStatement, IdProofOutput, ConcordiumGRPCClient } from '@concordium/web-sdk';
 export declare type SendTransactionPayload = Exclude<AccountTransactionPayload, UpdateContractPayload | InitContractPayload> | Omit<UpdateContractPayload, 'message'> | Omit<InitContractPayload, 'param'>;
 export declare type SmartContractParameters = {
     [key: string]: SmartContractParameters;
 } | SmartContractParameters[] | number | string | boolean;
+export declare type SignMessageObject = {
+    /** as base64 */
+    schema: string;
+    /** as hex */
+    data: string;
+};
 /**
  * An enumeration of the events that can be emitted by the WalletApi.
  */
@@ -51,9 +57,9 @@ interface MainWalletApi {
      * Sends a message to the Concordium Wallet and awaits the users action. If the user signs the message, this will resolve to the signature.
      * Note that if the user rejects signing the message, this will throw an error.
      * @param accountAddress the address of the account that should sign the message
-     * @param message message to be signed. Note that the wallet will prepend some bytes to ensure the message cannot be a transaction
+     * @param message message to be signed. Note that the wallet will prepend some bytes to ensure the message cannot be a transaction. The message should either be a utf8 string or { @link SignMessageObject }.
      */
-    signMessage(accountAddress: string, message: string): Promise<AccountTransactionSignature>;
+    signMessage(accountAddress: string, message: string | SignMessageObject): Promise<AccountTransactionSignature>;
     /**
      * Requests a connection to the Concordium wallet, prompting the user to either accept or reject the request.
      * If a connection has already been accepted for the url once the returned promise will resolve without prompting the user.
@@ -64,7 +70,20 @@ interface MainWalletApi {
      */
     getMostRecentlySelectedAccount(): Promise<string | undefined>;
     removeAllListeners(event?: EventType | string | undefined): this;
+    /**
+     * @deprecated use { @link getGrpcClient} instead
+     */
     getJsonRpcClient(): JsonRpcClient;
+    /**
+     * Returns a gRPC client that is connected to the node that the wallet is.
+     * Note that any calls will throw an error, if the site is not connected with the wallet.
+     */
+    getGrpcClient(): ConcordiumGRPCClient;
+    /**
+     * Returns the genesis hash of the currently selected chain in the wallet.
+     * Returns undefined if the wallet is either locked or not set up by the user.
+     */
+    getSelectedChain(): Promise<string | undefined>;
     /**
      * Request that the user adds the specified tokens for a given contract to the wallet.
      * Returns which of the given tokens the user accepted to add the tokens into the wallet.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@concordium/browser-wallet-api-helpers",
-    "version": "2.3.0",
+    "version": "2.5.0",
     "license": "Apache-2.0",
     "packageManager": "yarn@3.2.0",
     "main": "lib/index.js",
@@ -19,7 +19,7 @@
         "url": "https://concordium.com"
     },
     "dependencies": {
-        "@concordium/web-sdk": "^3.2.0"
+        "@concordium/web-sdk": "^3.4.2"
     },
     "devDependencies": {
         "@babel/core": "^7.17.10",
@@ -31,6 +31,7 @@
         "webpack-cli": "^4.9.2"
     },
     "scripts": {
-        "build": "tsc && webpack"
+        "build": "tsc && webpack",
+        "build:api-helpers": "yarn build"
     }
 }