@xyo-network/metamask-connector 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,347 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/metamask-connector
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
+
+```sh
+yarn add {{name}}
+```
 
-Version: 5.0.2
+Using pnpm:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+pnpm add {{name}}
+```
 
-## Documentation
+Using bun:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__metamask-connector)
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### sdk-utils
+
+    ### packages
+
+      ### metamask-connector
+
+        ### .temp-typedoc
+
+          ### classes
+
+            ### <a id="MetaMaskConnector"></a>MetaMaskConnector
+
+[**@xyo-network/metamask-connector**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new MetaMaskConnector(provider?): MetaMaskConnector;
+```
+
+### Parameters
+
+#### provider?
+
+`BrowserProvider`
+
+### Returns
+
+`MetaMaskConnector`
+
+## Accessors
+
+### chainId
+
+### Get Signature
+
+```ts
+get chainId(): string | null | undefined;
+```
+
+#### Returns
+
+`string` \| `null` \| `undefined`
+
+***
+
+### currentAccount
+
+### Get Signature
+
+```ts
+get currentAccount(): string | null | undefined;
+```
+
+#### Returns
+
+`string` \| `null` \| `undefined`
+
+## Methods
+
+### connectWallet()
+
+```ts
+connectWallet(): Promise<void>;
+```
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### isMetaMaskInstalled()
+
+```ts
+isMetaMaskInstalled(): true | undefined;
+```
+
+### Returns
+
+`true` \| `undefined`
+
+***
+
+### isWalletIsConnected()
+
+```ts
+isWalletIsConnected(): boolean;
+```
+
+### Returns
+
+`boolean`
+
+***
+
+### providerOnAccountsChanged()
+
+```ts
+providerOnAccountsChanged(listener): void;
+```
+
+EIP-1193 Event Listeners
+
+.on in Web3Provider does not understand EIP-1193 events
+see - https://github.com/ethers-io/ethers.js/discussions/1560#discussioncomment-730893
+
+### Parameters
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### providerOnChainChanged()
+
+```ts
+providerOnChainChanged(listener): void;
+```
+
+### Parameters
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### providerOnConnect()
+
+```ts
+providerOnConnect(listener): void;
+```
+
+### Parameters
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### providerOnDisconnect()
+
+```ts
+providerOnDisconnect(listener): void;
+```
+
+### Parameters
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### providerRemoveListener()
+
+```ts
+providerRemoveListener(event, listener): void;
+```
+
+### Parameters
+
+#### event
+
+`string`
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### providerRemoveListeners()
+
+```ts
+providerRemoveListeners(): void;
+```
+
+### Returns
+
+`void`
+
+***
+
+### requestAccounts()
+
+```ts
+requestAccounts(): Promise<string[] | null>;
+```
+
+### Returns
+
+`Promise`\<`string`[] \| `null`\>
+
+***
+
+### signMessage()
+
+```ts
+signMessage(message): Promise<string | undefined>;
+```
+
+### Parameters
+
+#### message
+
+`string`
+
+### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+***
+
+### web3ProviderOn()
+
+```ts
+web3ProviderOn(event, listener): void;
+```
+
+Web3Provider Listeners - https://docs.ethers.org/v5/api/providers/provider/#Provider--events
+
+### Parameters
+
+#### event
+
+`string`
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### web3ProviderRemoveListener()
+
+```ts
+web3ProviderRemoveListener(event, listener): void;
+```
+
+### Parameters
+
+#### event
+
+`string`
+
+#### listener
+
+`Listener`
+
+### Returns
+
+`void`
+
+***
+
+### web3ProviderRemoveListeners()
+
+```ts
+web3ProviderRemoveListeners(): void;
+```
+
+### Returns
 
-## Credits
+`void`
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/metamask-connector.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/metamask-connector
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/metamask-connector.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/metamask-connector",
-  "version": "5.3.25",
+  "version": "5.3.27",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/browser/index.d.ts",
+      "import": "./dist/browser/index.mjs",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/browser/index.mjs",
   "types": "dist/browser/index.d.ts",
   "files": [
     "dist",
@@ -38,15 +38,11 @@
   "devDependencies": {
     "@metamask/providers": "^22.1.1",
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "~5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "^7.6.16",
-    "@xylabs/tsconfig-dom": "~7.6.16",
-    "acorn": "^8.16.0",
+    "@xylabs/sdk-js": "~5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.15",
+    "@xylabs/ts-scripts-pnpm": "~7.7.15",
+    "@xylabs/tsconfig-dom": "~7.7.15",
     "axios": "^1.14.0",
-    "esbuild": "^0.28.0",
     "ethers": "^6.16.0",
     "typescript": "~5.9.3",
     "webextension-polyfill": "^0.12.0",
@@ -55,9 +51,7 @@
   "peerDependencies": {
     "@metamask/providers": "^22",
     "@xylabs/sdk-js": "^5",
-    "ethers": "^6",
-    "webextension-polyfill": "^0.10.0 || ^0.11.0 || ^0.12.0",
-    "zod": "^4"
+    "ethers": "^6"
   },
   "publishConfig": {
     "access": "public"