@concordium/browser-wallet-api-helpers 2.2.0 → 2.4.0

package/README.md

@@ -142,7 +142,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 either 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.
+
+The following exemplifies requesting a signature of a message, where the message is a utf8 string:
 
 ```typescript
 const provider = await detectConcordiumProvider();
@@ -152,6 +157,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.
@@ -165,6 +195,22 @@ const provider = await detectConcordiumProvider();
 await provider.addCIS2Tokens('2za2yAXbFiaB151oYqTteZfqiBzibHXizwjNbpdU8hodq9SfEk', ['AA', 'BB'], '1399', '0');
 ```
 
+### Prove ID statement
+
+It is possible to request a proof for a given ID statement on a specific account. The function takes 3 arguments. The statement to be proved, a challenge to ensure that the proof was not generated for a different context, and the account that should prove that statement.
+This method returns a `Promise` resolving with an object containing the proof and the credential id (field name: credential) of the credential used to prove the statement.
+
+If the wallet is locked, or you have not connected with the wallet (or previously been whitelisted) or if the user rejects proving the statement, the `Promise` will reject.
+
+The following exemplifies requesting a proof for a statement name myIdStatement (To see how to create a statement check out [our documentation](https://developer.concordium.software/en/mainnet/net/guides/create-proofs.html)) with a challenge of "12346789ABCD" id, for the account `2za2yAXbFiaB151oYqTteZfqiBzibHXizwjNbpdU8hodq9SfEk`.
+
+```typescript
+const statement = myIdStatement;
+const challenge = '12346789ABCD';
+const provider = await detectConcordiumProvider();
+await provider.requestIdProof('2za2yAXbFiaB151oYqTteZfqiBzibHXizwjNbpdU8hodq9SfEk', ['AA', 'BB'], '1399', '0');
+```
+
 ## Events
 
 ### Account changed

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

@@ -1,5 +1,14 @@
 import type { AccountTransactionPayload, AccountTransactionSignature, AccountTransactionType, InitContractPayload, JsonRpcClient, SchemaVersion, UpdateContractPayload, IdStatement, IdProofOutput } from '@concordium/web-sdk';
-declare type SendTransactionPayload = Exclude<AccountTransactionPayload, UpdateContractPayload | InitContractPayload> | Omit<UpdateContractPayload, 'message'> | Omit<InitContractPayload, 'param'>;
+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.
  */
@@ -35,7 +44,7 @@ interface MainWalletApi {
      * @param schema schema used for the initContract and updateContract transactions to serialize the parameters. Should be base64 encoded.
      * @param schemaVersion version of the schema provided. Must be supplied for schemas that use version 0 or 1, as they don't have the version embedded.
      */
-    sendTransaction(accountAddress: string, type: AccountTransactionType.Update | AccountTransactionType.InitContract, payload: SendTransactionPayload, parameters: Record<string, unknown>, schema: string | SchemaWithContext, schemaVersion?: SchemaVersion): Promise<string>;
+    sendTransaction(accountAddress: string, type: AccountTransactionType.Update | AccountTransactionType.InitContract, payload: SendTransactionPayload, parameters: SmartContractParameters, schema: string | SchemaWithContext, schemaVersion?: SchemaVersion): Promise<string>;
     /**
      * Sends a transaction to the Concordium Wallet and awaits the users action. Note that a header is not sent, and will be constructed by the wallet itself.
      * Note that if the user rejects signing the transaction, this will throw an error.
@@ -48,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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@concordium/browser-wallet-api-helpers",
-    "version": "2.2.0",
+    "version": "2.4.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.0"
     },
     "devDependencies": {
         "@babel/core": "^7.17.10",