feat: bitgetWallet support (#1919)

* feat：add @web3-onboard/bitget packages * dosc：bitget Wallet * feat：Upgrade npm package * feat：Change package name * feat：Change package name * Update packages/bitkeep/package.json * Update packages/bitget-wallet/package.json * Format code * Add CI * Rename bitget * delete wrong type * Test and remove type file for bitkeep * Import deps dynamically * Add bitkeep and bitget to docs site --------- Co-authored-by: kean <[email protected]@bitget.com> Co-authored-by: Adam Carpenter <[email protected]>
blocknative · Oct 17, 2023 · 24c825d · 24c825d
1 parent ffb01e3
commit 24c825d
Show file tree

Hide file tree

Showing 44 changed files with 534 additions and 3 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -413,6 +413,18 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/venly
     steps:
       - node-build-steps
+  build-bitget:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/bitget
+    steps:
+      - node-build-steps
+  build-bitkeep:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/bitkeep
+    steps:
+      - node-build-steps
 
   # Build staging/Alpha releases
   build-staging-core:
@@ -661,6 +673,18 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/venly
     steps:
       - node-staging-build-steps
+  build-staging-bitget:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/bitget
+    steps:
+      - node-staging-build-steps
+  build-staging-bitkeep:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/bitkeep
+    steps:
+      - node-staging-build-steps
 
 workflows:
   version: 2
@@ -911,3 +935,15 @@ workflows:
           <<: *deploy_production_filters
       - build-staging-venly:
           <<: *deploy_staging_filters
+  bitget:
+    jobs:
+      - build-bitget:
+          <<: *deploy_production_filters
+      - build-staging-bitget:
+          <<: *deploy_staging_filters
+  bitkeep:
+    jobs:
+      - build-bitkeep:
+          <<: *deploy_production_filters
+      - build-staging-bitkeep:
+          <<: *deploy_staging_filters
diff --git a/...ocs/[...4]wallets/[...8]frontier/+page.md → ...cs/[...4]wallets/[...10]frontier/+page.md b/...ocs/[...4]wallets/[...8]frontier/+page.md → ...cs/[...4]wallets/[...10]frontier/+page.md
diff --git a/.../docs/[...4]wallets/[...9]gnosis/+page.md → ...docs/[...4]wallets/[...11]gnosis/+page.md b/.../docs/[...4]wallets/[...9]gnosis/+page.md → ...docs/[...4]wallets/[...11]gnosis/+page.md
diff --git a/....4]wallets/[...10]infinitywallet/+page.md → ....4]wallets/[...12]infinitywallet/+page.md b/....4]wallets/[...10]infinitywallet/+page.md → ....4]wallets/[...12]infinitywallet/+page.md
diff --git a/...cs/[...4]wallets/[...11]injected/+page.md → ...cs/[...4]wallets/[...13]injected/+page.md b/...cs/[...4]wallets/[...11]injected/+page.md → ...cs/[...4]wallets/[...13]injected/+page.md
diff --git a/...ocs/[...4]wallets/[...12]keepkey/+page.md → ...ocs/[...4]wallets/[...14]keepkey/+page.md b/...ocs/[...4]wallets/[...12]keepkey/+page.md → ...ocs/[...4]wallets/[...14]keepkey/+page.md
diff --git a/...cs/[...4]wallets/[...13]keystone/+page.md → ...cs/[...4]wallets/[...15]keystone/+page.md b/...cs/[...4]wallets/[...13]keystone/+page.md → ...cs/[...4]wallets/[...15]keystone/+page.md
diff --git a/...docs/[...4]wallets/[...14]ledger/+page.md → ...docs/[...4]wallets/[...16]ledger/+page.md b/...docs/[...4]wallets/[...14]ledger/+page.md → ...docs/[...4]wallets/[...16]ledger/+page.md
diff --git a/.../docs/[...4]wallets/[...15]magic/+page.md → .../docs/[...4]wallets/[...17]magic/+page.md b/.../docs/[...4]wallets/[...15]magic/+page.md → .../docs/[...4]wallets/[...17]magic/+page.md
diff --git a/...es/docs/[...4]wallets/[...16]mew/+page.md → ...es/docs/[...4]wallets/[...18]mew/+page.md b/...es/docs/[...4]wallets/[...16]mew/+page.md → ...es/docs/[...4]wallets/[...18]mew/+page.md
diff --git a/...s/[...4]wallets/[...17]mewwallet/+page.md → ...s/[...4]wallets/[...19]mewwallet/+page.md b/...s/[...4]wallets/[...17]mewwallet/+page.md → ...s/[...4]wallets/[...19]mewwallet/+page.md
diff --git a/...ocs/[...4]wallets/[...18]phantom/+page.md → ...ocs/[...4]wallets/[...20]phantom/+page.md b/...ocs/[...4]wallets/[...18]phantom/+page.md → ...ocs/[...4]wallets/[...20]phantom/+page.md
diff --git a/...docs/[...4]wallets/[...19]portis/+page.md → ...docs/[...4]wallets/[...21]portis/+page.md b/...docs/[...4]wallets/[...19]portis/+page.md → ...docs/[...4]wallets/[...21]portis/+page.md
diff --git a/...s/docs/[...4]wallets/[...20]taho/+page.md → ...s/docs/[...4]wallets/[...22]taho/+page.md b/...s/docs/[...4]wallets/[...20]taho/+page.md → ...s/docs/[...4]wallets/[...22]taho/+page.md
diff --git a/...ocs/[...4]wallets/[...21]tallyho/+page.md → ...ocs/[...4]wallets/[...23]tallyho/+page.md b/...ocs/[...4]wallets/[...21]tallyho/+page.md → ...ocs/[...4]wallets/[...23]tallyho/+page.md
diff --git a/.../docs/[...4]wallets/[...22]torus/+page.md → .../docs/[...4]wallets/[...24]torus/+page.md b/.../docs/[...4]wallets/[...22]torus/+page.md → .../docs/[...4]wallets/[...24]torus/+page.md
diff --git a/...docs/[...4]wallets/[...23]trezor/+page.md → ...docs/[...4]wallets/[...25]trezor/+page.md b/...docs/[...4]wallets/[...23]trezor/+page.md → ...docs/[...4]wallets/[...25]trezor/+page.md
diff --git a/.../docs/[...4]wallets/[...24]uauth/+page.md → .../docs/[...4]wallets/[...26]uauth/+page.md b/.../docs/[...4]wallets/[...24]uauth/+page.md → .../docs/[...4]wallets/[...26]uauth/+page.md
diff --git a/.../docs/[...4]wallets/[...25]venly/+page.md → .../docs/[...4]wallets/[...27]venly/+page.md b/.../docs/[...4]wallets/[...25]venly/+page.md → .../docs/[...4]wallets/[...27]venly/+page.md
diff --git a/.....4]wallets/[...26]walletconnect/+page.md → .....4]wallets/[...28]walletconnect/+page.md b/.....4]wallets/[...26]walletconnect/+page.md → .....4]wallets/[...28]walletconnect/+page.md
diff --git a/.../[...4]wallets/[...27]walletlink/+page.md → .../[...4]wallets/[...29]walletlink/+page.md b/.../[...4]wallets/[...27]walletlink/+page.md → .../[...4]wallets/[...29]walletlink/+page.md
diff --git a/docs/src/routes/docs/[...4]wallets/[...2]bitget/+page.md b/docs/src/routes/docs/[...4]wallets/[...2]bitget/+page.md
@@ -0,0 +1,48 @@
+---
+title: Bitget
+---
+
+# {$frontmatter.title}
+
+## Wallet module for connecting Bitget Wallet through web3-onboard
+
+Bitget Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.
+
+### Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/bitget
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/bitget
+```
+
+  </TabPanel>
+</Tabs>
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import bitgetWalletModule from '@web3-onboard/bitget'
+
+const bitgetWallet = bitgetWalletModule()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    bitgetWallet()
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
diff --git a/...cs/[...4]wallets/[...28]web3auth/+page.md → ...cs/[...4]wallets/[...30]web3auth/+page.md b/...cs/[...4]wallets/[...28]web3auth/+page.md → ...cs/[...4]wallets/[...30]web3auth/+page.md
diff --git a/.../docs/[...4]wallets/[...29]xdefi/+page.md → .../docs/[...4]wallets/[...31]xdefi/+page.md b/.../docs/[...4]wallets/[...29]xdefi/+page.md → .../docs/[...4]wallets/[...31]xdefi/+page.md
diff --git a/...s/docs/[...4]wallets/[...30]zeal/+page.md → ...s/docs/[...4]wallets/[...32]zeal/+page.md b/...s/docs/[...4]wallets/[...30]zeal/+page.md → ...s/docs/[...4]wallets/[...32]zeal/+page.md
diff --git a/docs/src/routes/docs/[...4]wallets/[...3]bitkeep/+page.md b/docs/src/routes/docs/[...4]wallets/[...3]bitkeep/+page.md
@@ -0,0 +1,48 @@
+---
+title: BitKeep
+---
+
+# {$frontmatter.title}
+
+## Wallet module for connecting BitKeep Wallet through web3-onboard
+
+BitKeep Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.
+
+### Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/bitkeep
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/bitkeep
+```
+
+  </TabPanel>
+</Tabs>
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import bitKeepWalletModule from '@web3-onboard/bitkeep'
+
+const bitKeepWallet = bitKeepWalletModule()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    bitKeepWallet()
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
diff --git a/.../docs/[...4]wallets/[...2]blocto/+page.md → .../docs/[...4]wallets/[...4]blocto/+page.md b/.../docs/[...4]wallets/[...2]blocto/+page.md → .../docs/[...4]wallets/[...4]blocto/+page.md
diff --git a/...ocs/[...4]wallets/[...3]coinbase/+page.md → ...ocs/[...4]wallets/[...5]coinbase/+page.md b/...ocs/[...4]wallets/[...3]coinbase/+page.md → ...ocs/[...4]wallets/[...5]coinbase/+page.md
diff --git a/...s/docs/[...4]wallets/[...4]dcent/+page.md → ...s/docs/[...4]wallets/[...6]dcent/+page.md b/...s/docs/[...4]wallets/[...4]dcent/+page.md → ...s/docs/[...4]wallets/[...6]dcent/+page.md
diff --git a/...docs/[...4]wallets/[...5]enkrypt/+page.md → ...docs/[...4]wallets/[...7]enkrypt/+page.md b/...docs/[...4]wallets/[...5]enkrypt/+page.md → ...docs/[...4]wallets/[...7]enkrypt/+page.md
diff --git a/...cs/[...4]wallets/[...6]fortmatic/+page.md → ...cs/[...4]wallets/[...8]fortmatic/+page.md b/...cs/[...4]wallets/[...6]fortmatic/+page.md → ...cs/[...4]wallets/[...8]fortmatic/+page.md
diff --git a/...s/docs/[...4]wallets/[...7]frame/+page.md → ...s/docs/[...4]wallets/[...9]frame/+page.md b/...s/docs/[...4]wallets/[...7]frame/+page.md → ...s/docs/[...4]wallets/[...9]frame/+page.md
diff --git a/packages/bitget/README.md b/packages/bitget/README.md
@@ -0,0 +1,33 @@
+# @web3-onboard/bitget
+
+## Wallet module for connecting Bitget Wallet through web3-onboard
+
+Bitget Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.
+
+### Install
+
+**NPM**
+`npm i @web3-onboard/core @web3-onboard/bitget`
+
+**Yarn**
+`yarn add @web3-onboard/core @web3-onboard/bitget`
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import bitgetWalletModule from '@web3-onboard/bitget'
+
+const bitgetWallet = bitgetWalletModule()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    bitgetWallet()
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
diff --git a/packages/bitget/package.json b/packages/bitget/package.json
@@ -0,0 +1,67 @@
+{
+  "name": "@web3-onboard/bitget",
+  "version": "2.0.0-alpha.1",
+  "description": "bitget-wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
+  "keywords": [
+    "Ethereum",
+    "Web3",
+    "EVM",
+    "dapp",
+    "Multichain",
+    "Wallet",
+    "Transaction",
+    "Provider",
+    "Hardware Wallet",
+    "Notifications",
+    "React",
+    "Svelte",
+    "Vue",
+    "Next",
+    "Nuxt",
+    "MetaMask",
+    "Coinbase",
+    "WalletConnect",
+    "Ledger",
+    "Trezor",
+    "Connect Wallet",
+    "Ethereum Hooks",
+    "Blocknative",
+    "Mempool",
+    "pending",
+    "confirmed",
+    "Injected Wallet",
+    "Crypto",
+    "Crypto Wallet",
+    "Enkrypt",
+    "bitgetWallet"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/blocknative/web3-onboard.git",
+    "directory": "packages/bitget-wallet"
+  },
+  "homepage": "https://www.blocknative.com/onboard",
+  "bugs": "https://github.com/blocknative/web3-onboard/issues",
+  "module": "dist/index.js",
+  "browser": "dist/index.js",
+  "main": "dist/index.js",
+  "type": "module",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "type-check": "tsc --noEmit"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^17.0.21",
+    "typescript": "^4.5.5"
+  },
+  "dependencies": {
+    "@bitget-wallet/web3-sdk": "^0.0.6",
+    "@web3-onboard/common": "^2.3.3"
+  }
+}
diff --git a/packages/bitget/src/index.ts b/packages/bitget/src/index.ts
@@ -0,0 +1,51 @@
+import type { WalletInit, EIP1193Provider } from '@web3-onboard/common'
+
+let bitgetDependencies: any = null
+let bitgetAdapter: any = null
+
+const loadBitgetDependencies = async (getAdapter?: boolean) => {
+  if (!bitgetDependencies) {
+    bitgetDependencies = await import('@bitget-wallet/web3-sdk')
+  }
+  if (getAdapter && !bitgetAdapter) {
+    bitgetAdapter = new bitgetDependencies.LegacyEip1193Adapter()
+    return bitgetAdapter
+  }
+  if (getAdapter) {
+    return bitgetAdapter
+  }
+  return bitgetDependencies
+}
+
+function bitget(): WalletInit {
+  if (typeof window === 'undefined') return () => null
+
+  return () => {
+    return {
+      label: 'Bitget',
+      getIcon: async () => {
+        const sdkAdapter = await loadBitgetDependencies(true)
+        return sdkAdapter.getLogo()
+      },
+      getInterface: async () => {
+        const {
+          currentProvider,
+          getIsInstall,
+          getDownload,
+          installWalletMessage
+        } = await loadBitgetDependencies()
+
+        let provider: EIP1193Provider
+        if (getIsInstall()) {
+          provider = currentProvider()
+        } else {
+          window.open(getDownload(), '_blank')
+          throw new Error(installWalletMessage)
+        }
+        return { provider }
+      }
+    }
+  }
+}
+
+export default bitget
diff --git a/packages/bitget/tsconfig.json b/packages/bitget/tsconfig.json
@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*"],
+
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true,
+    "declarationDir": "dist",
+    "paths": {
+      "*": ["./src/*", "./node_modules/*"]
+    },
+    "typeRoots": ["node_modules/@types"]
+  }
+}
diff --git a/packages/bitkeep/README.md b/packages/bitkeep/README.md
@@ -0,0 +1,33 @@
+# @web3-onboard/bitkeep
+
+## Wallet module for connecting Bitkeep Wallet through web3-onboard
+
+Bitkeep Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.
+
+### Install
+
+**NPM**
+`npm i @web3-onboard/core @web3-onboard/bitkeep`
+
+**Yarn**
+`yarn add @web3-onboard/core @web3-onboard/bitkeep`
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import bitkeepModule from '@web3-onboard/bitkeep'
+
+const bitKeep = bitkeepModule()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    bitKeep()
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```