@xyo-network/wallet 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,1133 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/wallet
 
-[![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:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__wallet)
+Using bun:
+
+```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
+
+  ### protocol
+
+    ### packages
+
+      ### crypto
+
+        ### packages
+
+          ### wallet
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="HDWallet"></a>HDWallet
+
+[**@xyo-network/wallet**](#../README)
+
+***
+
+## Extends
+
+- `Account`
+
+## Implements
+
+- `WalletInstance`
+
+## Constructors
+
+### Constructor
+
+```ts
+new HDWallet(
+   key, 
+   node, 
+   privateKey): HDWallet;
+```
+
+### Parameters
+
+#### key
+
+`symbol`
+
+#### node
+
+`HDNodeWallet`
+
+#### privateKey
+
+`PrivateKeyInstance`
+
+### Returns
+
+`HDWallet`
+
+### Overrides
+
+```ts
+Account.constructor
+```
+
+## Properties
+
+### previousHashStore
+
+```ts
+static previousHashStore: PreviousHashStore | undefined;
+```
+
+### Inherited from
+
+```ts
+Account.previousHashStore
+```
+
+***
+
+### \_protectedConstructorKey
+
+```ts
+protected static _protectedConstructorKey: symbol;
+```
+
+### Inherited from
+
+```ts
+Account._protectedConstructorKey
+```
+
+***
+
+### \_node
+
+```ts
+protected _node: HDNodeWallet | undefined;
+```
+
+### Inherited from
+
+```ts
+Account._node
+```
+
+***
+
+### \_previousHash?
+
+```ts
+protected optional _previousHash?: ArrayBufferLike;
+```
+
+### Inherited from
+
+```ts
+Account._previousHash
+```
+
+***
+
+### uniqueName
+
+```ts
+readonly static uniqueName: string;
+```
+
+### Overrides
+
+```ts
+Account.uniqueName
+```
+
+***
+
+### \_addressMap
+
+```ts
+protected static _addressMap: Record<Address, WeakRef<WalletInstance>> = {};
+```
+
+### Overrides
+
+```ts
+Account._addressMap
+```
+
+***
+
+### node
+
+```ts
+protected readonly node: HDNodeWallet;
+```
+
+***
+
+### neuter
+
+```ts
+neuter: () => HDWallet;
+```
+
+### Returns
+
+`HDWallet`
+
+### Implementation of
+
+```ts
+WalletInstance.neuter
+```
+
+## Accessors
+
+### previousHash
+
+### Get Signature
+
+```ts
+get previousHash(): BrandedHash | undefined;
+```
+
+#### Returns
+
+`BrandedHash` \| `undefined`
+
+### Implementation of
+
+```ts
+WalletInstance.previousHash
+```
+
+### Inherited from
+
+```ts
+Account.previousHash
+```
+
+***
+
+### previousHashBytes
+
+### Get Signature
+
+```ts
+get previousHashBytes(): ArrayBufferLike | undefined;
+```
+
+#### Returns
+
+`ArrayBufferLike` \| `undefined`
+
+### Implementation of
+
+```ts
+WalletInstance.previousHashBytes
+```
+
+### Inherited from
+
+```ts
+Account.previousHashBytes
+```
+
+***
+
+### private
+
+### Get Signature
+
+```ts
+get private(): PrivateKeyInstance;
+```
+
+#### Returns
+
+`PrivateKeyInstance`
+
+### Implementation of
+
+```ts
+WalletInstance.private
+```
+
+### Inherited from
+
+```ts
+Account.private
+```
+
+***
+
+### public
+
+### Get Signature
+
+```ts
+get public(): PublicKeyInstance;
+```
+
+#### Returns
+
+`PublicKeyInstance`
+
+### Implementation of
+
+```ts
+WalletInstance.public
+```
+
+### Inherited from
+
+```ts
+Account.public
+```
+
+***
+
+### length
+
+### Get Signature
+
+```ts
+get length(): number;
+```
+
+#### Returns
+
+`number`
+
+### Inherited from
+
+```ts
+Account.length
+```
+
+***
+
+### base58
+
+### Get Signature
+
+```ts
+get base58(): string;
+```
+
+#### Returns
+
+`string`
+
+### Inherited from
+
+```ts
+Account.base58
+```
+
+***
+
+### bytes
+
+### Get Signature
+
+```ts
+get bytes(): ArrayBuffer | SharedArrayBuffer;
+```
+
+#### Returns
+
+`ArrayBuffer` \| `SharedArrayBuffer`
+
+### Inherited from
+
+```ts
+Account.bytes
+```
+
+***
+
+### hex
+
+### Get Signature
+
+```ts
+get hex(): BrandedHex;
+```
+
+#### Returns
+
+`BrandedHex`
+
+### Inherited from
+
+```ts
+Account.hex
+```
+
+***
+
+### keccak256
+
+### Get Signature
+
+```ts
+get keccak256(): ArrayBufferLike;
+```
+
+#### Returns
+
+`ArrayBufferLike`
+
+### Inherited from
+
+```ts
+Account.keccak256
+```
+
+***
+
+### address
+
+### Get Signature
+
+```ts
+get address(): BrandedAddress;
+```
+
+#### Returns
+
+`BrandedAddress`
+
+### Implementation of
+
+```ts
+WalletInstance.address
+```
+
+### Overrides
+
+```ts
+Account.address
+```
+
+***
+
+### addressBytes
+
+### Get Signature
+
+```ts
+get addressBytes(): ArrayBufferLike;
+```
+
+#### Returns
+
+`ArrayBufferLike`
+
+### Implementation of
+
+```ts
+WalletInstance.addressBytes
+```
+
+### Overrides
+
+```ts
+Account.addressBytes
+```
+
+***
+
+### chainCode
+
+### Get Signature
+
+```ts
+get chainCode(): string;
+```
+
+#### Returns
+
+`string`
+
+### Implementation of
+
+```ts
+WalletInstance.chainCode
+```
+
+***
+
+### depth
+
+### Get Signature
+
+```ts
+get depth(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+WalletInstance.depth
+```
+
+***
+
+### extendedKey
+
+### Get Signature
+
+```ts
+get extendedKey(): string;
+```
+
+#### Returns
+
+`string`
+
+### Implementation of
+
+```ts
+WalletInstance.extendedKey
+```
+
+***
+
+### fingerprint
+
+### Get Signature
+
+```ts
+get fingerprint(): string;
+```
+
+#### Returns
+
+`string`
+
+### Implementation of
+
+```ts
+WalletInstance.fingerprint
+```
+
+***
+
+### index
+
+### Get Signature
+
+```ts
+get index(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+WalletInstance.index
+```
+
+***
+
+### mnemonic
+
+### Get Signature
+
+```ts
+get mnemonic(): Mnemonic | null;
+```
+
+#### Returns
+
+`Mnemonic` \| `null`
+
+### Implementation of
+
+```ts
+WalletInstance.mnemonic
+```
+
+***
+
+### parentFingerprint
+
+### Get Signature
+
+```ts
+get parentFingerprint(): string;
+```
+
+#### Returns
+
+`string`
+
+### Implementation of
+
+```ts
+WalletInstance.parentFingerprint
+```
+
+***
+
+### path
+
+### Get Signature
+
+```ts
+get path(): string | null;
+```
+
+#### Returns
+
+`string` \| `null`
+
+### Implementation of
+
+```ts
+WalletInstance.path
+```
+
+***
+
+### privateKey
+
+### Get Signature
+
+```ts
+get privateKey(): BrandedHex;
+```
+
+#### Returns
+
+`BrandedHex`
+
+### Implementation of
+
+```ts
+WalletInstance.privateKey
+```
+
+***
+
+### publicKey
+
+### Get Signature
+
+```ts
+get publicKey(): BrandedHex;
+```
+
+#### Returns
+
+`BrandedHex`
+
+### Implementation of
+
+```ts
+WalletInstance.publicKey
+```
+
+## Methods
+
+### fromPrivateKey()
+
+```ts
+static fromPrivateKey(key): Promise<AccountInstance>;
+```
+
+### Parameters
+
+#### key
+
+`string` \| `bigint` \| `ArrayBufferLike`
+
+### Returns
+
+`Promise`\<`AccountInstance`\>
+
+### Inherited from
+
+```ts
+Account.fromPrivateKey
+```
+
+***
+
+### isAddress()
+
+```ts
+static isAddress(address): boolean;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`boolean`
+
+### Inherited from
+
+```ts
+Account.isAddress
+```
+
+***
+
+### initialize()
+
+```ts
+initialize(): Promise<HDWallet>;
+```
+
+### Returns
+
+`Promise`\<`HDWallet`\>
+
+### Inherited from
+
+```ts
+Account.initialize
+```
+
+***
+
+### loadPreviousHash()
+
+```ts
+loadPreviousHash(previousHash?): Promise<HDWallet>;
+```
+
+### Parameters
+
+#### previousHash?
+
+`string` \| `ArrayBufferLike`
+
+### Returns
+
+`Promise`\<`HDWallet`\>
+
+### Inherited from
+
+```ts
+Account.loadPreviousHash
+```
+
+***
+
+### sign()
+
+```ts
+sign(hash, previousHash): Promise<[ArrayBufferLike, BrandedHash?]>;
+```
+
+### Parameters
+
+#### hash
+
+`ArrayBufferLike`
+
+#### previousHash
+
+`ArrayBufferLike` \| `undefined`
+
+### Returns
+
+`Promise`\<\[`ArrayBufferLike`, `BrandedHash`?\]\>
+
+### Implementation of
+
+```ts
+WalletInstance.sign
+```
+
+### Inherited from
+
+```ts
+Account.sign
+```
+
+***
+
+### verify()
+
+```ts
+verify(msg, signature): Promise<boolean>;
+```
+
+### Parameters
+
+#### msg
+
+`ArrayBufferLike`
+
+#### signature
+
+`ArrayBufferLike`
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### Implementation of
+
+```ts
+WalletInstance.verify
+```
+
+### Inherited from
+
+```ts
+Account.verify
+```
+
+***
+
+### verifyUniqueAddress()
+
+```ts
+verifyUniqueAddress(): HDWallet | AccountInstance;
+```
+
+### Returns
+
+`HDWallet` \| `AccountInstance`
+
+### Inherited from
+
+```ts
+Account.verifyUniqueAddress
+```
+
+***
+
+### is()
+
+```ts
+static is(value): value is AbstractData;
+```
+
+### Parameters
+
+#### value
+
+`unknown`
+
+### Returns
+
+`value is AbstractData`
+
+### Inherited from
+
+```ts
+Account.is
+```
+
+***
+
+### from()
+
+```ts
+static from(data): Data | undefined;
+```
+
+### Parameters
+
+#### data
+
+`ArrayBuffer` \| `undefined`
+
+### Returns
+
+`Data` \| `undefined`
+
+### Inherited from
+
+```ts
+Account.from
+```
+
+***
+
+### create()
+
+```ts
+static create(opts?): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### opts?
+
+`AccountConfig`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+### Overrides
+
+```ts
+Account.create
+```
+
+***
+
+### createFromNode()
+
+```ts
+static createFromNode(node, previousHash?): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### node
+
+`HDNodeWallet`
+
+#### previousHash?
+
+`string`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+***
+
+### fromExtendedKey()
+
+```ts
+static fromExtendedKey(key): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### key
+
+`string`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+***
+
+### fromMnemonic()
+
+```ts
+static fromMnemonic(mnemonic, path?): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### mnemonic
+
+`Mnemonic`
+
+#### path?
+
+`string` = `defaultPath`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+***
+
+### fromPhrase()
+
+```ts
+static fromPhrase(phrase, path?): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### phrase
+
+`string`
+
+#### path?
+
+`string` = `defaultPath`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+***
+
+### fromSeed()
+
+```ts
+static fromSeed(seed): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### seed
+
+`string` \| `ArrayBufferLike`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+***
+
+### generateMnemonic()
+
+```ts
+static generateMnemonic(wordlist?, strength?): string;
+```
+
+### Parameters
+
+#### wordlist?
+
+`string`[] = `englishWordlist`
+
+#### strength?
+
+`number` = `256`
+
+### Returns
+
+`string`
+
+***
+
+### random()
+
+```ts
+static random(): Promise<WalletInstance>;
+```
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+### Overrides
+
+```ts
+Account.random
+```
+
+***
+
+### createFromNodeInternal()
+
+```ts
+protected static createFromNodeInternal(node, previousHash?): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### node
+
+`HDNodeWallet`
+
+#### previousHash?
+
+`string`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+***
+
+### getCachedWalletOrCacheNewWallet()
+
+```ts
+protected static getCachedWalletOrCacheNewWallet(createdWallet): WalletInstance;
+```
+
+### Parameters
+
+#### createdWallet
+
+`WalletInstance`
+
+### Returns
+
+`WalletInstance`
+
+***
+
+### derivePath()
+
+```ts
+derivePath(path): Promise<WalletInstance>;
+```
+
+### Parameters
+
+#### path
+
+`string`
+
+### Returns
+
+`Promise`\<`WalletInstance`\>
+
+### Implementation of
 
-## Credits
+```ts
+WalletInstance.derivePath
+```
 
-[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/wallet.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/wallet
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/wallet.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/wallet",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -37,20 +37,20 @@
   ],
   "dependencies": {
     "@scure/bip39": "~2.0.1",
-    "@xyo-network/account": "~5.3.25",
-    "@xyo-network/account-model": "~5.3.25",
-    "@xyo-network/key-model": "~5.3.25",
-    "@xyo-network/wallet-model": "~5.3.25"
+    "@xyo-network/account-model": "~5.3.26",
+    "@xyo-network/key-model": "~5.3.26",
+    "@xyo-network/account": "~5.3.26",
+    "@xyo-network/wallet-model": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@scure/bip39": "~2.0.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/vitest-matchers": "~5.0.93",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
+    "@xylabs/vitest-matchers": "~5.0.94",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
@@ -60,10 +60,10 @@
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
     "zod": "^4.3.6",
-    "@xyo-network/account": "~5.3.25",
-    "@xyo-network/account-model": "~5.3.25",
-    "@xyo-network/key-model": "~5.3.25",
-    "@xyo-network/wallet-model": "~5.3.25"
+    "@xyo-network/account": "~5.3.26",
+    "@xyo-network/account-model": "~5.3.26",
+    "@xyo-network/key-model": "~5.3.26",
+    "@xyo-network/wallet-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",