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

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# 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.

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 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.
+
+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'>;
+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,12 @@ 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.
+     */
+    addCIS2Tokens(accountAddress: string, tokenIds: string[], contractIndex: bigint, contractSubindex?: bigint): Promise<string[]>;
 }
 export declare type WalletApi = MainWalletApi & EventListeners;
 export {};

package/package.json

@@ -1,36 +1,36 @@
 {
-    "name": "@concordium/browser-wallet-api-helpers",
-    "version": "1.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": "^2.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.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"
+  }
+}