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

package/README.md

@@ -136,6 +136,19 @@ const signature = await provider.signMessage(
 );
 ```
 
+### 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.
+
+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 tokens with id AA and BB from the contract on index 1399, and subindex 0 to the account `2za2yAXbFiaB151oYqTteZfqiBzibHXizwjNbpdU8hodq9SfEk`.
+
+```typescript
+const provider = await detectConcordiumProvider();
+await provider.addCIS2Tokens('2za2yAXbFiaB151oYqTteZfqiBzibHXizwjNbpdU8hodq9SfEk', ['AA', 'BB'], '1399', '0');
+```
+
 ## Events
 
 ### Account changed

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

@@ -1,5 +1,5 @@
-import type { AccountTransactionPayload, AccountTransactionSignature, AccountTransactionType, InitContractPayload, JsonRpcClient, SchemaVersion, UpdateContractPayload } from '@concordium/web-sdk';
-declare type SendTransactionPayload = Exclude<AccountTransactionPayload, UpdateContractPayload | InitContractPayload> | Omit<UpdateContractPayload, 'parameter'> | Omit<InitContractPayload, 'parameter'>;
+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.
  */
@@ -22,12 +22,12 @@ interface MainWalletApi {
      * Note that if the user rejects signing the transaction, this will throw an error.
      * @param accountAddress the address of the account that should sign the transaction
      * @param type the type of transaction that is to be signed and sent.
-     * @param payload the payload of the transaction to be signed and sent. Note that for smart contract transactions, the payload should not contain the parameters, those should instead be provided in the subsequent argument instead.
+     * @param payload the payload of the transaction to be signed and sent. Note that for smart contract transactions, the payload should not contain the params/message fields, those should instead be provided in the subsequent argument instead.
      * @param parameters parameters for the initContract and updateContract transactions in JSON-like format.
      * @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.UpdateSmartContractInstance | AccountTransactionType.InitializeSmartContractInstance, payload: SendTransactionPayload, parameters: Record<string, unknown>, schema: string, schemaVersion?: SchemaVersion): Promise<string>;
+    sendTransaction(accountAddress: string, type: AccountTransactionType.Update | AccountTransactionType.InitContract, payload: SendTransactionPayload, parameters: Record<string, unknown>, schema: string, 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.
@@ -54,6 +54,25 @@ interface MainWalletApi {
     getMostRecentlySelectedAccount(): Promise<string | undefined>;
     removeAllListeners(event?: EventType | string | undefined): this;
     getJsonRpcClient(): JsonRpcClient;
+    /**
+     * 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,6 +1,6 @@
 {
     "name": "@concordium/browser-wallet-api-helpers",
-    "version": "1.0.0",
+    "version": "2.1.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": "^2.0.0"
+        "@concordium/web-sdk": "^3.1.0"
     },
     "devDependencies": {
         "@babel/core": "^7.17.10",