Merge pull request #15 from tronprotocol/release/v1.1.5

Release/v1.1.5
tronprotocol · Mar 23, 2023 · 81aa622 · 81aa622
2 parents 3dcbc67 + c81324a
commit 81aa622
Show file tree

Hide file tree

Showing 28 changed files with 426 additions and 168 deletions.
diff --git a/demos/dev-demo/src/TronLinkAdapterDemo.tsx b/demos/dev-demo/src/TronLinkAdapterDemo.tsx
@@ -26,7 +26,13 @@ export function TronLinkAdapterDemo() {
     useEffect(() => {
         setConnectState(adapter.state);
         setAccount(adapter.address || '');
-        setReadyState(adapter.readyState)
+        setReadyState(adapter.readyState);
+        adapter.network().then((res) => {
+            console.log(res);
+            setChainId(res.chainId)
+        }).catch(e => {
+            console.log(e)
+        })
 
         adapter.on('readyStateChanged', () => {
             console.log('readyState: ', adapter.readyState)
@@ -35,6 +41,12 @@ export function TronLinkAdapterDemo() {
         adapter.on('connect', () => {
             console.log('connect: ', adapter.address);
             setAccount(adapter.address || '');
+            adapter.network().then((res) => {
+                console.log(res);
+                setChainId(res.chainId)
+            }).catch(e => {
+                console.log(e)
+            })
         });
         adapter.on('stateChanged', (state) => {
             console.log('stateChanged: ', state);

diff --git a/docs/wallet-adapters.md b/docs/wallet-adapters.md
@@ -180,18 +180,18 @@ Events are as follows:
         chainId: string;
     }
     ```
--   `error(ConnectionError)`: Emit when there are some errors when call the adapter's method. The [ConnectionError Types] is defined as follows.
+-   `error(WalletError)`: Emit when there are some errors when call the adapter's method. The [WalletError Types] is defined as follows.
 
-### ConnectionError
+### WalletError
 
-`ConnectionError` is a superclass which defines the error when using adapter.
+`WalletError` is a superclass which defines the error when using adapter.
 All error types are extended from this class.
 Developers can check the error type according to the error instance.
 
 ```typescript
 try {
     // do something here
-} catch (error: ConnectionError) {
+} catch (error: WalletError) {
     if (error instanceof WalletNotFoundError) {
         console.log('Wallet is not found');
     }
@@ -251,6 +251,28 @@ try {
         dappName?: string;
     }
     ```
+-   `network()` method is supported to get current network information. The type of returned value is `Network` as follows:
+
+    ```typescript
+    export enum NetworkType {
+        Mainnet = 'Mainnet',
+        Shasta = 'Shasta',
+        Nile = 'Nile',
+        /**
+         * When use custom node
+         */
+        Unknown = 'Unknown'
+    }
+
+    export type Network = {
+        networkType: NetworkType;
+        chainId: string;
+        fullNode: string;
+        solidityNode: string;
+        eventServer: string;
+    };
+    ```
+
 -   **Don't support `disconnect` by DApp**. As TronLinkAdapter doesn't support disconnect by DApp website, call `adapter.disconnect()` won't disconnect from TronLink extension really.
 -   **Auto open TronLink app in mobile browser**. If developers call `connect()` method in mobile browser, it will open DApp in TronLink app to get tronlink wallet.
 
@@ -281,7 +303,7 @@ try {
     }
     ```
     More detail about WalletConnect client options please refer to the [WalletConnect document](https://docs.walletconnect.com/2.0/javascript/sign/dapp-usage).
-- `multiSign()` and `switchChain(chainId: string)` are not supported.
+-   `multiSign()` and `switchChain(chainId: string)` are not supported.
 
 ### LedgerAdapter
 
@@ -371,4 +393,4 @@ try {
         // { address: 'some address', publicKey: 'publicKey for address' }
         ```
 
-- `multiSign()` and `switchChain(chainId: string)` are not supported.
+-   `multiSign()` and `switchChain(chainId: string)` are not supported.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "tronwallet-adapter",
     "description": "wallet adapters for TRON blockchain",
-    "version": "1.1.4",
+    "version": "1.1.5",
     "main": "index.js",
     "sideEffects": false,
     "private": true,
@@ -25,7 +25,7 @@
         "build:other": "pnpm --recursive --filter \"@tronweb3/*\" run build",
         "build:clean": "pnpm run clean && pnpm run build && pnpm run package",
         "package": "pnpm --recursive run package",
-        "release": "pnpm build:clean && pnpm test && changeset publish",
+        "release": "pnpm prerelease && pnpm build:clean && pnpm test && changeset publish",
         "watch": "pnpm run watch:ts",
         "watch:ts": "tsc --build --verbose --watch tsconfig.all.json",
         "dev": "pnpm watch & pnpm run --filter {demos/dev-demo} dev",
@@ -35,7 +35,8 @@
         "test": "pnpm --recursive --filter \"@tronweb3/*\" run test",
         "example": "pnpm run --filter {demos/react-ui/vite-app} dev",
         "prepare": "husky install",
-        "update-version": "pnpm changeset add && pnpm changeset version"
+        "update-version": "pnpm changeset add && pnpm changeset version",
+        "prerelease": "node ./scripts/check-dep-version.js"
     },
     "devDependencies": {
         "@changesets/cli": "^2.26.0",

diff --git a/packages/adapters/abstract-adapter/package.json b/packages/adapters/abstract-adapter/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@tronweb3/tronwallet-abstract-adapter",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "Abstract interface definition of Tron Wallet Adapters.",
     "author": "tronprotocol",
     "repository": {

diff --git a/packages/adapters/abstract-adapter/src/types.ts b/packages/adapters/abstract-adapter/src/types.ts
@@ -1,17 +1,36 @@
-export type NetworkNodeConfig = {
-    chainId: string;
-    chain: string;
-    fullNode: string;
-    solidityNode: string;
-    eventServer: string;
-};
+export enum NetworkType {
+    Mainnet = 'Mainnet',
+    Shasta = 'Shasta',
+    Nile = 'Nile',
+    /**
+     * When use custom node
+     */
+    Unknown = 'Unknown',
+}
 
 export enum ChainNetwork {
     Mainnet = 'Mainnet',
     Shasta = 'Shasta',
     Nile = 'Nile',
 }
 
+export type Network = {
+    networkType: NetworkType;
+    chainId: string;
+    fullNode: string;
+    solidityNode: string;
+    eventServer: string;
+};
+/**
+ * @deprecated Use Network instead.
+ */
+export type NetworkNodeConfig = {
+    chainId: string;
+    chain: string;
+    fullNode: string;
+    solidityNode: string;
+    eventServer: string;
+};
 // types should be defined in @tronweb3/web3.js, such as tronweb
 // as no ts in tronweb
 // just defined here

diff --git a/packages/adapters/adapters/README.md b/packages/adapters/adapters/README.md
@@ -180,18 +180,18 @@ Events are as follows:
         chainId: string;
     }
     ```
--   `error(ConnectionError)`: Emit when there are some errors when call the adapter's method. The [ConnectionError Types] is defined as follows.
+-   `error(WalletError)`: Emit when there are some errors when call the adapter's method. The [WalletError Types] is defined as follows.
 
-### ConnectionError
+### WalletError
 
-`ConnectionError` is a superclass which defines the error when using adapter.
+`WalletError` is a superclass which defines the error when using adapter.
 All error types are extended from this class.
 Developers can check the error type according to the error instance.
 
 ```typescript
 try {
     // do something here
-} catch (error: ConnectionError) {
+} catch (error: WalletError) {
     if (error instanceof WalletNotFoundError) {
         console.log('Wallet is not found');
     }
@@ -251,6 +251,28 @@ try {
         dappName?: string;
     }
     ```
+-   `network()` method is supported to get current network information. The type of returned value is `Network` as follows:
+
+    ```typescript
+    export enum NetworkType {
+        Mainnet = 'Mainnet',
+        Shasta = 'Shasta',
+        Nile = 'Nile',
+        /**
+         * When use custom node
+         */
+        Unknown = 'Unknown',
+    }
+
+    export type Network = {
+        networkType: NetworkType;
+        chainId: string;
+        fullNode: string;
+        solidityNode: string;
+        eventServer: string;
+    };
+    ```
+
 -   **Don't support `disconnect` by DApp**. As TronLinkAdapter doesn't support disconnect by DApp website, call `adapter.disconnect()` won't disconnect from TronLink extension really.
 -   **Auto open TronLink app in mobile browser**. If developers call `connect()` method in mobile browser, it will open DApp in TronLink app to get tronlink wallet.
 
@@ -281,7 +303,7 @@ try {
     }
     ```
     More detail about WalletConnect client options please refer to the [WalletConnect document](https://docs.walletconnect.com/2.0/javascript/sign/dapp-usage).
--   `multiSign()` is not supported yet.
+-   `multiSign()` and `switchChain(chainId: string)` are not supported.
 
 ### LedgerAdapter
 
@@ -371,4 +393,4 @@ try {
         // { address: 'some address', publicKey: 'publicKey for address' }
         ```
 
--   `multiSign()` is not supported yet.
+-   `multiSign()` and `switchChain(chainId: string)` are not supported.
diff --git a/packages/adapters/adapters/package.json b/packages/adapters/adapters/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@tronweb3/tronwallet-adapters",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "Wallet adapters to help developers interact with Tron wallets using consistent API.",
     "keywords": [
         "TRON",
@@ -40,9 +40,9 @@
         "package": "shx echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json"
     },
     "dependencies": {
-        "@tronweb3/tronwallet-adapter-ledger": "^1.1.4",
-        "@tronweb3/tronwallet-adapter-tronlink": "^1.1.3",
-        "@tronweb3/tronwallet-adapter-walletconnect": "^1.0.1"
+        "@tronweb3/tronwallet-adapter-ledger": "^1.1.5",
+        "@tronweb3/tronwallet-adapter-tronlink": "^1.1.4",
+        "@tronweb3/tronwallet-adapter-walletconnect": "^1.0.2"
     },
     "devDependencies": {
         "shx": "^0.3.4"

diff --git a/packages/adapters/ledger/package.json b/packages/adapters/ledger/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@tronweb3/tronwallet-adapter-ledger",
-    "version": "1.1.4",
+    "version": "1.1.5",
     "description": "Wallet adapter for the Ledger wallet.",
     "keywords": [
         "TRON",
@@ -44,7 +44,7 @@
         "@ledgerhq/hw-app-trx": "^6.27.8",
         "@ledgerhq/hw-transport": "6.27.1",
         "@ledgerhq/hw-transport-webhid": "6.27.1",
-        "@tronweb3/tronwallet-abstract-adapter": "^1.1.2",
+        "@tronweb3/tronwallet-abstract-adapter": "^1.1.4",
         "buffer": "^6.0.3",
         "eventemitter3": "^4.0.0",
         "preact": "^10.11.3"

diff --git a/packages/adapters/tronlink/package.json b/packages/adapters/tronlink/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@tronweb3/tronwallet-adapter-tronlink",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "Wallet adapter for TronLink Wallet extension and TronLink app.",
     "keywords": [
         "TRON",
@@ -42,7 +42,7 @@
         "test:coverage": "jest  --coverage"
     },
     "dependencies": {
-        "@tronweb3/tronwallet-abstract-adapter": "^1.1.2"
+        "@tronweb3/tronwallet-abstract-adapter": "^1.1.4"
     },
     "devDependencies": {
         "@testing-library/dom": "^8.20.0",