@concordium/browser-wallet-api-helpers 2.0.0 → 2.1.0

package/README.md

@@ -138,7 +138,7 @@ const signature = await provider.signMessage(
 
 ### Add CIS-2 Tokens
 
-It is possible to suggest CIS-2 tokens to be added to the connected account's display. sign arbitrary messages using the keys for an account stored in the wallet, by invoking the `signMessage` method. The first parameter is the account to be used for signing the message. This method returns a `Promise` resolving with a signature of the message.
+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.
 
 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.
 

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

@@ -1,4 +1,4 @@
-import type { AccountTransactionPayload, AccountTransactionSignature, AccountTransactionType, InitContractPayload, JsonRpcClient, SchemaVersion, UpdateContractPayload } from '@concordium/web-sdk';
+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'>;
 /**
  * An enumeration of the events that can be emitted by the WalletApi.
@@ -58,8 +58,21 @@ interface MainWalletApi {
      * 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.
      * Note that this will throw an error if the dApp is not connected with the accountAddress.
+     * @param accountAddress the address of the account whose display the tokens should be added to.
+     * @param tokenIds the list of ids, for the tokens that should be added.
+     * @param contractIndex the index of the CIS-2 contract which the tokens are in.
+     * @param contractSubindex the subindex of the CIS-2 contract which the tokens are in.
+     * @returns a list containing the ids of the tokens that was added to the wallet.
      */
     addCIS2Tokens(accountAddress: string, tokenIds: string[], contractIndex: bigint, contractSubindex?: bigint): Promise<string[]>;
+    /**
+     * Request that the user provides a proof for the given statement.
+     * @param accountAddress the address of the account that should prove the statement.
+     * @param statement the id statement that should be proven.
+     * @param challenge bytes chosen by the verifier. Should be HEX encoded.
+     * @returns The id proof and the id of the credential used to prove it.
+     */
+    requestIdProof(accountAddress: string, statement: IdStatement, challenge: string): Promise<IdProofOutput>;
 }
 export declare type WalletApi = MainWalletApi & EventListeners;
 export {};

package/package.json

@@ -1,36 +1,36 @@
 {
-  "name": "@concordium/browser-wallet-api-helpers",
-  "version": "2.0.0",
-  "license": "Apache-2.0",
-  "packageManager": "yarn@3.2.0",
-  "main": "lib/index.js",
-  "browser": "lib/concordiumHelpers.min.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "/lib/**/*"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Concordium/concordium-browser-wallet"
-  },
-  "author": {
-    "name": "Concordium Software",
-    "email": "support@concordium.software",
-    "url": "https://concordium.com"
-  },
-  "dependencies": {
-    "@concordium/web-sdk": "^3.0.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.17.10",
-    "@babel/plugin-transform-modules-commonjs": "^7.12.1",
-    "@babel/plugin-transform-runtime": "^7.12.1",
-    "@babel/preset-env": "^7.12.1",
-    "typescript": "^4.3.5",
-    "webpack": "^5.72.0",
-    "webpack-cli": "^4.9.2"
-  },
-  "scripts": {
-    "build": "tsc && webpack"
-  }
-}
+    "name": "@concordium/browser-wallet-api-helpers",
+    "version": "2.1.0",
+    "license": "Apache-2.0",
+    "packageManager": "yarn@3.2.0",
+    "main": "lib/index.js",
+    "browser": "lib/concordiumHelpers.min.js",
+    "types": "lib/index.d.ts",
+    "files": [
+        "/lib/**/*"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Concordium/concordium-browser-wallet"
+    },
+    "author": {
+        "name": "Concordium Software",
+        "email": "support@concordium.software",
+        "url": "https://concordium.com"
+    },
+    "dependencies": {
+        "@concordium/web-sdk": "^3.1.0"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.17.10",
+        "@babel/plugin-transform-modules-commonjs": "^7.12.1",
+        "@babel/plugin-transform-runtime": "^7.12.1",
+        "@babel/preset-env": "^7.12.1",
+        "typescript": "^4.3.5",
+        "webpack": "^5.72.0",
+        "webpack-cli": "^4.9.2"
+    },
+    "scripts": {
+        "build": "tsc && webpack"
+    }
+}

package/CHANGELOG.md

@@ -1,39 +0,0 @@
-# Changelog
-
-## 2.0.0
-
-### Added
-
--   Entrypoint to suggest CIS-2 tokens to be added to the connected account's view.
-
-### (Breaking) Changed
-
--   Updated web-sdk to version 3, which changes field names in some transaction payloads for sendTransaction entrypoint.
-
-## 1.0.0
-
-### Changed
-
--   Fixed broken link + typos in README
--   Removed parameters from smart contract types' payloads, due the wallet ignoring it in favor of separate arguments.
-
-## 0.2.0
-
-### Added
-
--   Expose a JSON-RPC client, using the wallet's current JSON-RPC server.
--   `getMostRecentlySelectedAccount` method. This method allows dApps to get the most prioritized account without using `connect`. In a future release it will be updated to actually return the most recently selected account.
-
-### (Breaking) Changed
-
--   Updated API of sendTransaction and signMessage to require the account address.
--   Updated API to include an 'accountDisconnected' event.
-
-## 0.1.1
-
--   sendTransaction can now take a 5th argument, which is the schema's version. This will allow V1 contract parameters to be serialized.
-
-## 0.1.0
-
--   Initialized from the old browser-wallet-api-types package.
--   Added method for detecting the injected Concordium browser wallet API.