@concordium/browser-wallet-api-helpers 2.4.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,10 +151,10 @@ 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 message should either utf8 string or an object with the following fields:
+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.
+-   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:
 

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

@@ -1,4 +1,4 @@
-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;
@@ -70,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.4.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.4.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"
     }
 }