@xyo-network/account-model - npm Package Compare versions

Comparing version 3.8.0 to 3.8.1

dist/browser/index.d.ts

@@ -1,2 +0,43 @@
-export * from './Account.ts';
-//# sourceMappingURL=index.d.ts.map
+import { Address, Hash } from '@xylabs/hex';
+import { PrivateKeyInstance, PublicKeyInstance } from '@xyo-network/key-model';
+import { PreviousHashStore } from '@xyo-network/previous-hash-store-model';
+
+declare const ethMessagePrefix = "\u0019Ethereum Signed Message:\n";
+interface PhraseInitializationConfig {
+    phrase: string;
+}
+interface PrivateKeyInitializationConfig {
+    privateKey: ArrayBufferLike;
+}
+interface MnemonicInitializationConfig {
+    mnemonic: string;
+    path?: string;
+}
+interface AccountOptions {
+    previousHash?: ArrayBufferLike;
+}
+type InitializationConfig = PhraseInitializationConfig | PrivateKeyInitializationConfig | MnemonicInitializationConfig;
+type AccountConfig = InitializationConfig & AccountOptions;
+declare const isPhraseInitializationConfig: (value: unknown) => value is PhraseInitializationConfig;
+declare const isPrivateKeyInitializationConfig: (value: unknown) => value is PrivateKeyInitializationConfig;
+declare const isMnemonicInitializationConfig: (value: unknown) => value is MnemonicInitializationConfig;
+declare const isInitializationConfig: (value: unknown) => value is InitializationConfig;
+interface AccountInstance {
+    readonly address: Address;
+    readonly addressBytes: ArrayBufferLike;
+    previousHash: Hash | undefined;
+    previousHashBytes: ArrayBufferLike | undefined;
+    readonly private?: PrivateKeyInstance;
+    readonly public?: PublicKeyInstance;
+    sign: (hash: ArrayBufferLike, previousHash?: ArrayBufferLike) => Promise<[ArrayBufferLike, Hash?]>;
+    verify: (msg: ArrayBufferLike, signature: ArrayBufferLike) => Promise<boolean>;
+}
+declare const isAccountInstance: (account: any) => account is AccountInstance;
+interface AccountStatic<T extends AccountInstance = AccountInstance, C extends AccountConfig = AccountConfig> {
+    previousHashStore?: PreviousHashStore;
+    create(options?: C): Promise<T>;
+    fromPrivateKey(key: ArrayBufferLike | bigint | string): Promise<AccountInstance>;
+    random(): Promise<AccountInstance>;
+}
+
+export { type AccountConfig, type AccountInstance, type AccountOptions, type AccountStatic, type InitializationConfig, type MnemonicInitializationConfig, type PhraseInitializationConfig, type PrivateKeyInitializationConfig, ethMessagePrefix, isAccountInstance, isInitializationConfig, isMnemonicInitializationConfig, isPhraseInitializationConfig, isPrivateKeyInitializationConfig };

dist/neutral/index.d.ts

@@ -1,2 +0,43 @@
-export * from './Account.ts';
-//# sourceMappingURL=index.d.ts.map
+import { Address, Hash } from '@xylabs/hex';
+import { PrivateKeyInstance, PublicKeyInstance } from '@xyo-network/key-model';
+import { PreviousHashStore } from '@xyo-network/previous-hash-store-model';
+
+declare const ethMessagePrefix = "\u0019Ethereum Signed Message:\n";
+interface PhraseInitializationConfig {
+    phrase: string;
+}
+interface PrivateKeyInitializationConfig {
+    privateKey: ArrayBufferLike;
+}
+interface MnemonicInitializationConfig {
+    mnemonic: string;
+    path?: string;
+}
+interface AccountOptions {
+    previousHash?: ArrayBufferLike;
+}
+type InitializationConfig = PhraseInitializationConfig | PrivateKeyInitializationConfig | MnemonicInitializationConfig;
+type AccountConfig = InitializationConfig & AccountOptions;
+declare const isPhraseInitializationConfig: (value: unknown) => value is PhraseInitializationConfig;
+declare const isPrivateKeyInitializationConfig: (value: unknown) => value is PrivateKeyInitializationConfig;
+declare const isMnemonicInitializationConfig: (value: unknown) => value is MnemonicInitializationConfig;
+declare const isInitializationConfig: (value: unknown) => value is InitializationConfig;
+interface AccountInstance {
+    readonly address: Address;
+    readonly addressBytes: ArrayBufferLike;
+    previousHash: Hash | undefined;
+    previousHashBytes: ArrayBufferLike | undefined;
+    readonly private?: PrivateKeyInstance;
+    readonly public?: PublicKeyInstance;
+    sign: (hash: ArrayBufferLike, previousHash?: ArrayBufferLike) => Promise<[ArrayBufferLike, Hash?]>;
+    verify: (msg: ArrayBufferLike, signature: ArrayBufferLike) => Promise<boolean>;
+}
+declare const isAccountInstance: (account: any) => account is AccountInstance;
+interface AccountStatic<T extends AccountInstance = AccountInstance, C extends AccountConfig = AccountConfig> {
+    previousHashStore?: PreviousHashStore;
+    create(options?: C): Promise<T>;
+    fromPrivateKey(key: ArrayBufferLike | bigint | string): Promise<AccountInstance>;
+    random(): Promise<AccountInstance>;
+}
+
+export { type AccountConfig, type AccountInstance, type AccountOptions, type AccountStatic, type InitializationConfig, type MnemonicInitializationConfig, type PhraseInitializationConfig, type PrivateKeyInitializationConfig, ethMessagePrefix, isAccountInstance, isInitializationConfig, isMnemonicInitializationConfig, isPhraseInitializationConfig, isPrivateKeyInitializationConfig };

dist/node/index.d.ts

@@ -1,2 +0,43 @@
-export * from './Account.ts';
-//# sourceMappingURL=index.d.ts.map
+import { Address, Hash } from '@xylabs/hex';
+import { PrivateKeyInstance, PublicKeyInstance } from '@xyo-network/key-model';
+import { PreviousHashStore } from '@xyo-network/previous-hash-store-model';
+
+declare const ethMessagePrefix = "\u0019Ethereum Signed Message:\n";
+interface PhraseInitializationConfig {
+    phrase: string;
+}
+interface PrivateKeyInitializationConfig {
+    privateKey: ArrayBufferLike;
+}
+interface MnemonicInitializationConfig {
+    mnemonic: string;
+    path?: string;
+}
+interface AccountOptions {
+    previousHash?: ArrayBufferLike;
+}
+type InitializationConfig = PhraseInitializationConfig | PrivateKeyInitializationConfig | MnemonicInitializationConfig;
+type AccountConfig = InitializationConfig & AccountOptions;
+declare const isPhraseInitializationConfig: (value: unknown) => value is PhraseInitializationConfig;
+declare const isPrivateKeyInitializationConfig: (value: unknown) => value is PrivateKeyInitializationConfig;
+declare const isMnemonicInitializationConfig: (value: unknown) => value is MnemonicInitializationConfig;
+declare const isInitializationConfig: (value: unknown) => value is InitializationConfig;
+interface AccountInstance {
+    readonly address: Address;
+    readonly addressBytes: ArrayBufferLike;
+    previousHash: Hash | undefined;
+    previousHashBytes: ArrayBufferLike | undefined;
+    readonly private?: PrivateKeyInstance;
+    readonly public?: PublicKeyInstance;
+    sign: (hash: ArrayBufferLike, previousHash?: ArrayBufferLike) => Promise<[ArrayBufferLike, Hash?]>;
+    verify: (msg: ArrayBufferLike, signature: ArrayBufferLike) => Promise<boolean>;
+}
+declare const isAccountInstance: (account: any) => account is AccountInstance;
+interface AccountStatic<T extends AccountInstance = AccountInstance, C extends AccountConfig = AccountConfig> {
+    previousHashStore?: PreviousHashStore;
+    create(options?: C): Promise<T>;
+    fromPrivateKey(key: ArrayBufferLike | bigint | string): Promise<AccountInstance>;
+    random(): Promise<AccountInstance>;
+}
+
+export { type AccountConfig, type AccountInstance, type AccountOptions, type AccountStatic, type InitializationConfig, type MnemonicInitializationConfig, type PhraseInitializationConfig, type PrivateKeyInitializationConfig, ethMessagePrefix, isAccountInstance, isInitializationConfig, isMnemonicInitializationConfig, isPhraseInitializationConfig, isPrivateKeyInitializationConfig };

package.json

 {
   "name": "@xyo-network/account-model",
-  "version": "3.8.0",
+  "version": "3.8.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -34,8 +34,8 @@ "homepage": "https://xyo.network",
     "@xylabs/hex": "^4.5.1",
-    "@xyo-network/key-model": "^3.8.0",
-    "@xyo-network/previous-hash-store-model": "^3.8.0"
+    "@xyo-network/key-model": "^3.8.1",
+    "@xyo-network/previous-hash-store-model": "^3.8.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.6",
-    "@xylabs/tsconfig": "^4.2.6",
+    "@xylabs/ts-scripts-yarn3": "^5.0.22",
+    "@xylabs/tsconfig": "^5.0.22",
     "ethers": "^6.13.5",
@@ -42,0 +42,0 @@ "typescript": "^5.7.3"

No alert changes

Improved metrics

Lines of code

307

increased by0.99%

Worsened metrics

Total package byte prevSize

34359

decreased by-12.87%

Number of package files

16

decreased by-36%

Dependency changes

• Updated@xyo-network/key-model@^3.8.1

• Updated@xyo-network/previous-hash-store-model@^3.8.1