@binance/w3w-multichain-connector 1.0.0

package/README.md

@@ -0,0 +1,44 @@
+# @binance/w3w-multichain-connector
+
+The `@binance/w3w-multichain-connector` package provides a wrapper for the `Binance Wallet` extension multichain connector
+
+## Installation
+
+```bash
+pnpm add @binance/w3w-multichain-connector
+# or
+npm install @binance/w3w-multichain-connector
+```
+
+## Usage
+
+### Importing
+
+```ts
+import { getMultichainWallet } from '@binance/w3w-multichain-connector'
+```
+
+### Call methods
+
+```ts
+const wallet = getMultichainWallet()
+const connectedWallets = await wallet.requestConnect(['56', 'CT_501'])
+```
+
+### Handle events
+
+```ts
+const wallet = getMultichainWallet()
+wallet.on('walletLockedChanged', (isLocked) => {
+  console.log('Wallet is locked', isLocked)
+})
+```
+
+### Check extension support features
+
+```ts
+import { checkExtensionSupported, Features } from '@binance/w3w-multichain-connector'
+
+const isSupported = checkExtensionSupported(Features.requestConnect)
+
+```

package/dist/index.d.ts

@@ -0,0 +1,96 @@
+import EventEmitter from 'eventemitter3';
+
+declare const enum ChainType {
+    EVM = "EVM",
+    SOL = "SOL"
+}
+/**
+ * privateKey:私钥钱包
+ * hd: 助记词钱包
+ */
+declare const enum WalletType {
+    privateKey = "privateKey",
+    seedPhrase = "hd"
+}
+declare const enum Features {
+    requestConnect = "requestConnect",
+    checkConnectedWallet = "checkConnectedWallet",
+    disconnect = "disconnect",
+    switchChain = "switchChain",
+    requestAutoSign = "requestAutoSign",
+    eventWalletLockedChanged = "eventWalletLockedChanged",
+    eventAutoSignEnabledChanged = "eventAutoSignEnabledChanged",
+    eventConnectedWalletsChanged = "eventConnectedWalletsChanged",
+    eventConnectedChainIdChanged = "eventConnectedChainIdChanged"
+}
+
+/**
+ * 链接的钱包
+ */
+interface IConnectedWallet {
+    /**
+     * base64编码的钱包图标
+     */
+    walletIcon: string;
+    walletName: string;
+    walletId: string;
+    walletType: WalletType;
+    addressList: {
+        address: string;
+        chainType: ChainType;
+    }[];
+}
+interface WalletEvents {
+    walletLockedChanged: (isLocked: boolean) => void;
+    autoSignEnabledChanged: (isEnabled: boolean) => void;
+    connectedWalletsChanged: (connectedWallets: IConnectedWallet[]) => void;
+    connectedChainIdChanged: (binanceChainId: string) => void;
+}
+interface IWallet extends EventEmitter<WalletEvents> {
+    /**
+     * 弹出连接请求
+     * 若已链接，则直接返回已连接的钱包
+     * 用户的当前活跃钱包会出现在数组的第一个
+     * 若用户拒绝，会报4001用户拒绝
+     * @param binanceChainIds 请求链接网络的binanceChainId
+     */
+    requestConnect(binanceChainIds: string[]): Promise<IConnectedWallet[]>;
+    /**
+     * 检查当前连接的钱包
+     * 用户的当前活跃钱包会出现在数组的第一个
+     */
+    checkConnectedWallet(): Promise<IConnectedWallet[]>;
+    /**
+     * 断开所有连接的钱包
+     */
+    disconnect(): Promise<void>;
+    /**
+     * 切换网络，若当前活跃钱包不支持该网络，会报4001用户拒绝
+     * @param binanceChainId 请求网络的binanceChainId
+     */
+    switchChain(binanceChainId: string): Promise<void>;
+    /**
+     * 弹出自动签名的请求弹窗
+     * 若已链接，则直接返回
+     */
+    requestAutoSign(): Promise<void>;
+    /**
+     * 插件当前版本
+     */
+    version: string;
+    /**
+     * 是否启用自动签名
+     */
+    autoSignEnabled: boolean;
+    walletLocked: boolean;
+    extensionId: string;
+}
+
+declare const checkExtensionInstalled: () => boolean;
+/**
+ * 检查当前用户安装的插件是否支持
+ */
+declare const checkExtensionSupported: (feature: Features) => any;
+declare const getMultichainWallet: () => IWallet;
+
+export { ChainType, Features, IConnectedWallet, IWallet, WalletEvents, WalletType, checkExtensionInstalled, checkExtensionSupported, getMultichainWallet };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+var r=(n=>(n.EVM="EVM",n.SOL="SOL",n))(r||{}),l=(n=>(n.privateKey="privateKey",n.seedPhrase="hd",n))(l||{}),a=(e=>(e.requestConnect="requestConnect",e.checkConnectedWallet="checkConnectedWallet",e.disconnect="disconnect",e.switchChain="switchChain",e.requestAutoSign="requestAutoSign",e.eventWalletLockedChanged="eventWalletLockedChanged",e.eventAutoSignEnabledChanged="eventAutoSignEnabledChanged",e.eventConnectedWalletsChanged="eventConnectedWalletsChanged",e.eventConnectedChainIdChanged="eventConnectedChainIdChanged",e))(a||{});var d=()=>{try{return!!window?.binancew3w?.isExtension}catch{return!1}},s=t=>{let o=c();return o?o.checkSupportFeature(t):!1},c=()=>d()?window.binancew3w?.wallet:null,h=()=>c();export{r as ChainType,a as Features,l as WalletType,d as checkExtensionInstalled,s as checkExtensionSupported,h as getMultichainWallet};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/enum.ts","../src/getMultichainWallet.ts"],"sourcesContent":["export const enum ChainType {\n  EVM = 'EVM',\n  SOL = 'SOL',\n}\n\n/**\n * privateKey:私钥钱包\n * hd: 助记词钱包\n */\nexport const enum WalletType {\n  privateKey = 'privateKey',\n  seedPhrase = 'hd',\n}\n\nexport const enum Features {\n  requestConnect = 'requestConnect',\n  checkConnectedWallet = 'checkConnectedWallet',\n  disconnect = 'disconnect',\n  switchChain = 'switchChain',\n  requestAutoSign = 'requestAutoSign',\n  eventWalletLockedChanged = 'eventWalletLockedChanged',\n  eventAutoSignEnabledChanged = 'eventAutoSignEnabledChanged',\n  eventConnectedWalletsChanged = 'eventConnectedWalletsChanged',\n  eventConnectedChainIdChanged = 'eventConnectedChainIdChanged',\n}\n","import { Features } from './enum'\nimport type { IWallet } from './type'\n\nexport const checkExtensionInstalled = () => {\n  try {\n    return !!(window as any)?.binancew3w?.isExtension\n  } catch (error) {\n    return false\n  }\n}\n\n/**\n * 检查当前用户安装的插件是否支持\n */\nexport const checkExtensionSupported = (feature: Features) => {\n  const wallet = getInjectedWallet()\n  if (!wallet) {\n    return false\n  }\n  return wallet.checkSupportFeature(feature)\n}\n\nconst getInjectedWallet = () => {\n  const isInstalled = checkExtensionInstalled()\n  if (!isInstalled) {\n    return null\n  }\n  return (window as any).binancew3w?.wallet\n}\n\nexport const getMultichainWallet = (): IWallet => {\n  return getInjectedWallet()\n}\n"],"mappings":"AAAO,IAAWA,OAChBA,EAAA,IAAM,MACNA,EAAA,IAAM,MAFUA,OAAA,IASAC,OAChBA,EAAA,WAAa,aACbA,EAAA,WAAa,KAFGA,OAAA,IAKAC,OAChBA,EAAA,eAAiB,iBACjBA,EAAA,qBAAuB,uBACvBA,EAAA,WAAa,aACbA,EAAA,YAAc,cACdA,EAAA,gBAAkB,kBAClBA,EAAA,yBAA2B,2BAC3BA,EAAA,4BAA8B,8BAC9BA,EAAA,6BAA+B,+BAC/BA,EAAA,6BAA+B,+BATfA,OAAA,ICXX,IAAMC,EAA0B,IAAM,CAC3C,GAAI,CACF,MAAO,CAAC,CAAE,QAAgB,YAAY,WACxC,MAAE,CACA,MAAO,EACT,CACF,EAKaC,EAA2BC,GAAsB,CAC5D,IAAMC,EAASC,EAAkB,EACjC,OAAKD,EAGEA,EAAO,oBAAoBD,CAAO,EAFhC,EAGX,EAEME,EAAoB,IACJJ,EAAwB,EAIpC,OAAe,YAAY,OAF1B,KAKEK,EAAsB,IAC1BD,EAAkB","names":["ChainType","WalletType","Features","checkExtensionInstalled","checkExtensionSupported","feature","wallet","getInjectedWallet","getMultichainWallet"]}

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@binance/w3w-multichain-connector",
+  "version": "1.0.0",
+  "description": "A multichain connector for Binance Wallet",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [],
+  "author": "Binance",
+  "license": "ISC",
+  "dependencies": {
+    "eventemitter3": "^5.0.1"
+  },
+  "scripts": {
+    "build": "tsup ./src/index.ts --dts"
+  }
+}

package/src/enum.ts

@@ -0,0 +1,25 @@
+export const enum ChainType {
+  EVM = 'EVM',
+  SOL = 'SOL',
+}
+
+/**
+ * privateKey:私钥钱包
+ * hd: 助记词钱包
+ */
+export const enum WalletType {
+  privateKey = 'privateKey',
+  seedPhrase = 'hd',
+}
+
+export const enum Features {
+  requestConnect = 'requestConnect',
+  checkConnectedWallet = 'checkConnectedWallet',
+  disconnect = 'disconnect',
+  switchChain = 'switchChain',
+  requestAutoSign = 'requestAutoSign',
+  eventWalletLockedChanged = 'eventWalletLockedChanged',
+  eventAutoSignEnabledChanged = 'eventAutoSignEnabledChanged',
+  eventConnectedWalletsChanged = 'eventConnectedWalletsChanged',
+  eventConnectedChainIdChanged = 'eventConnectedChainIdChanged',
+}

package/src/getMultichainWallet.ts

@@ -0,0 +1,33 @@
+import { Features } from './enum'
+import type { IWallet } from './type'
+
+export const checkExtensionInstalled = () => {
+  try {
+    return !!(window as any)?.binancew3w?.isExtension
+  } catch (error) {
+    return false
+  }
+}
+
+/**
+ * 检查当前用户安装的插件是否支持
+ */
+export const checkExtensionSupported = (feature: Features) => {
+  const wallet = getInjectedWallet()
+  if (!wallet) {
+    return false
+  }
+  return wallet.checkSupportFeature(feature)
+}
+
+const getInjectedWallet = () => {
+  const isInstalled = checkExtensionInstalled()
+  if (!isInstalled) {
+    return null
+  }
+  return (window as any).binancew3w?.wallet
+}
+
+export const getMultichainWallet = (): IWallet => {
+  return getInjectedWallet()
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './enum'
+export * from './type'
+export * from './getMultichainWallet'

package/src/type.ts

@@ -0,0 +1,77 @@
+import type EventEmitter from 'eventemitter3'
+
+import type { ChainType, Features, WalletType } from './enum'
+
+/**
+ * 链接的钱包
+ */
+export interface IConnectedWallet {
+  /**
+   * base64编码的钱包图标
+   */
+  walletIcon: string
+
+  walletName: string
+
+  walletId: string
+
+  walletType: WalletType
+
+  addressList: {
+    address: string
+    chainType: ChainType
+  }[]
+}
+
+export interface WalletEvents {
+  walletLockedChanged: (isLocked: boolean) => void
+  autoSignEnabledChanged: (isEnabled: boolean) => void
+  connectedWalletsChanged: (connectedWallets: IConnectedWallet[]) => void
+  connectedChainIdChanged: (binanceChainId: string) => void
+}
+
+export interface IWallet extends EventEmitter<WalletEvents> {
+  /**
+   * 弹出连接请求
+   * 若已链接，则直接返回已连接的钱包
+   * 用户的当前活跃钱包会出现在数组的第一个
+   * 若用户拒绝，会报4001用户拒绝
+   * @param binanceChainIds 请求链接网络的binanceChainId
+   */
+  requestConnect(binanceChainIds: string[]): Promise<IConnectedWallet[]>
+
+  /**
+   * 检查当前连接的钱包
+   * 用户的当前活跃钱包会出现在数组的第一个
+   */
+  checkConnectedWallet(): Promise<IConnectedWallet[]>
+
+  /**
+   * 断开所有连接的钱包
+   */
+  disconnect(): Promise<void>
+
+  /**
+   * 切换网络，若当前活跃钱包不支持该网络，会报4001用户拒绝
+   * @param binanceChainId 请求网络的binanceChainId
+   */
+  switchChain(binanceChainId: string): Promise<void>
+
+  /**
+   * 弹出自动签名的请求弹窗
+   * 若已链接，则直接返回
+   */
+  requestAutoSign(): Promise<void>
+
+  /**
+   * 插件当前版本
+   */
+  version: string
+
+  /**
+   * 是否启用自动签名
+   */
+  autoSignEnabled: boolean
+  walletLocked: boolean
+  extensionId: string
+}

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.json"
+}