@xyo-network/account-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,437 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/account-model
 
-[![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:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__account-model)
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+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
+
+          ### account-model
+
+            ### .temp-typedoc
+
+              ### functions
+
+                ### <a id="isAccountInstance"></a>isAccountInstance
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+function isAccountInstance(account): account is AccountInstance;
+```
+
+## Parameters
+
+### account
+
+`any`
+
+## Returns
+
+`account is AccountInstance`
+
+                ### <a id="isInitializationConfig"></a>isInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+function isInitializationConfig(value): value is InitializationConfig;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is InitializationConfig`
+
+                ### <a id="isMnemonicInitializationConfig"></a>isMnemonicInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+function isMnemonicInitializationConfig(value): value is MnemonicInitializationConfig;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is MnemonicInitializationConfig`
+
+                ### <a id="isPhraseInitializationConfig"></a>isPhraseInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+function isPhraseInitializationConfig(value): value is PhraseInitializationConfig;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is PhraseInitializationConfig`
+
+                ### <a id="isPrivateKeyInitializationConfig"></a>isPrivateKeyInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+function isPrivateKeyInitializationConfig(value): value is PrivateKeyInitializationConfig;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is PrivateKeyInitializationConfig`
+
+              ### interfaces
+
+                ### <a id="AccountInstance"></a>AccountInstance
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+## Properties
+
+### address
+
+```ts
+readonly address: BrandedAddress;
+```
+
+***
+
+### addressBytes
+
+```ts
+readonly addressBytes: ArrayBufferLike;
+```
+
+***
+
+### previousHash
+
+```ts
+previousHash: BrandedHash | undefined;
+```
+
+***
+
+### previousHashBytes
+
+```ts
+previousHashBytes: ArrayBufferLike | undefined;
+```
+
+***
+
+### private?
+
+```ts
+readonly optional private?: PrivateKeyInstance;
+```
+
+***
+
+### public?
+
+```ts
+readonly optional public?: PublicKeyInstance;
+```
+
+***
+
+### sign
+
+```ts
+sign: (hash, previousHash?) => Promise<[ArrayBufferLike, BrandedHash?]>;
+```
+
+### Parameters
+
+#### hash
+
+`ArrayBufferLike`
+
+#### previousHash?
+
+`ArrayBufferLike`
+
+### Returns
+
+`Promise`\<\[`ArrayBufferLike`, `BrandedHash`?\]\>
+
+***
+
+### verify
+
+```ts
+verify: (msg, signature) => Promise<boolean>;
+```
+
+### Parameters
+
+#### msg
+
+`ArrayBufferLike`
+
+#### signature
+
+`ArrayBufferLike`
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+                ### <a id="AccountOptions"></a>AccountOptions
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+## Properties
+
+### previousHash?
+
+```ts
+optional previousHash?: ArrayBufferLike;
+```
+
+                ### <a id="AccountStatic"></a>AccountStatic
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AccountInstance`](#AccountInstance) = [`AccountInstance`](#AccountInstance)
+
+### C
+
+`C` *extends* [`AccountConfig`](#../type-aliases/AccountConfig) = [`AccountConfig`](#../type-aliases/AccountConfig)
+
+## Properties
+
+### previousHashStore?
+
+```ts
+optional previousHashStore?: PreviousHashStore;
+```
+
+## Methods
+
+### create()
+
+```ts
+create(options?): Promise<T>;
+```
+
+### Parameters
+
+#### options?
+
+`C`
+
+### Returns
+
+`Promise`\<`T`\>
+
+***
+
+### fromPrivateKey()
+
+```ts
+fromPrivateKey(key): Promise<AccountInstance>;
+```
+
+### Parameters
+
+#### key
+
+`string` \| `bigint` \| `ArrayBufferLike`
+
+### Returns
+
+`Promise`\<[`AccountInstance`](#AccountInstance)\>
+
+***
+
+### random()
+
+```ts
+random(): Promise<AccountInstance>;
+```
+
+### Returns
+
+`Promise`\<[`AccountInstance`](#AccountInstance)\>
+
+                ### <a id="MnemonicInitializationConfig"></a>MnemonicInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+## Properties
+
+### mnemonic
+
+```ts
+mnemonic: string;
+```
+
+***
+
+### path?
+
+```ts
+optional path?: string;
+```
+
+                ### <a id="PhraseInitializationConfig"></a>PhraseInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+## Properties
+
+### phrase
+
+```ts
+phrase: string;
+```
+
+                ### <a id="PrivateKeyInitializationConfig"></a>PrivateKeyInitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+## Properties
+
+### privateKey
+
+```ts
+privateKey: ArrayBufferLike;
+```
+
+              ### type-aliases
+
+                ### <a id="AccountConfig"></a>AccountConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+type AccountConfig = InitializationConfig & AccountOptions;
+```
+
+                ### <a id="InitializationConfig"></a>InitializationConfig
+
+[**@xyo-network/account-model**](#../README)
+
+***
+
+```ts
+type InitializationConfig = 
+  | PhraseInitializationConfig
+  | PrivateKeyInitializationConfig
+  | MnemonicInitializationConfig;
+```
+
+              ### variables
+
+                ### <a id="ethMessagePrefix"></a>ethMessagePrefix
+
+[**@xyo-network/account-model**](#../README)
+
+***
 
-## Credits
+```ts
+const ethMessagePrefix: "\u0019Ethereum Signed Message:\n" = '\u0019Ethereum Signed Message:\n';
+```
 
-[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/account-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/account-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/account-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/account-model",
-  "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",
@@ -36,23 +36,23 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/key-model": "~5.3.25",
-    "@xyo-network/previous-hash-store-model": "~5.3.25"
+    "@xyo-network/key-model": "~5.3.26",
+    "@xyo-network/previous-hash-store-model": "~5.3.26"
   },
   "devDependencies": {
     "@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",
+    "@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",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/key-model": "~5.3.25",
-    "@xyo-network/previous-hash-store-model": "~5.3.25"
+    "@xyo-network/key-model": "~5.3.26",
+    "@xyo-network/previous-hash-store-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",