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

Comparing version 2.111.3 to 3.0.0

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: ArrayBuffer;
+}
+interface MnemonicInitializationConfig {
+    mnemonic: string;
+    path?: string;
+}
+interface AccountOptions {
+    previousHash?: ArrayBuffer;
+}
+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: ArrayBuffer;
+    previousHash: Hash | undefined;
+    previousHashBytes: ArrayBuffer | undefined;
+    readonly private: PrivateKeyInstance;
+    readonly public: PublicKeyInstance;
+    sign: (hash: ArrayBuffer, previousHash: ArrayBuffer | undefined) => ArrayBuffer | Promise<ArrayBuffer>;
+    verify: (msg: ArrayBuffer, signature: ArrayBuffer) => boolean | 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: ArrayBuffer | 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: ArrayBuffer;
+}
+interface MnemonicInitializationConfig {
+    mnemonic: string;
+    path?: string;
+}
+interface AccountOptions {
+    previousHash?: ArrayBuffer;
+}
+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: ArrayBuffer;
+    previousHash: Hash | undefined;
+    previousHashBytes: ArrayBuffer | undefined;
+    readonly private: PrivateKeyInstance;
+    readonly public: PublicKeyInstance;
+    sign: (hash: ArrayBuffer, previousHash: ArrayBuffer | undefined) => ArrayBuffer | Promise<ArrayBuffer>;
+    verify: (msg: ArrayBuffer, signature: ArrayBuffer) => boolean | 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: ArrayBuffer | 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: ArrayBuffer;
+}
+interface MnemonicInitializationConfig {
+    mnemonic: string;
+    path?: string;
+}
+interface AccountOptions {
+    previousHash?: ArrayBuffer;
+}
+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: ArrayBuffer;
+    previousHash: Hash | undefined;
+    previousHashBytes: ArrayBuffer | undefined;
+    readonly private: PrivateKeyInstance;
+    readonly public: PublicKeyInstance;
+    sign: (hash: ArrayBuffer, previousHash: ArrayBuffer | undefined) => ArrayBuffer | Promise<ArrayBuffer>;
+    verify: (msg: ArrayBuffer, signature: ArrayBuffer) => boolean | 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: ArrayBuffer | 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

@@ -15,9 +15,9 @@ {
     "@xylabs/lodash": "^3.6.12",
-    "@xyo-network/key-model": "^2.111.3",
-    "@xyo-network/previous-hash-store-model": "^2.111.3"
+    "@xyo-network/key-model": "^3.0.0",
+    "@xyo-network/previous-hash-store-model": "^3.0.0"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.15.14",
-    "@xylabs/tsconfig": "^3.15.14",
+    "@xylabs/ts-scripts-yarn3": "next",
+    "@xylabs/tsconfig": "next",
     "ethers": "^6.13.2",
@@ -36,28 +36,9 @@ "typescript": "^5.5.4"
     ".": {
-      "browser": {
-        "require": {
-          "types": "./dist/browser/index.d.cts",
-          "default": "./dist/browser/index.cjs"
-        },
-        "import": {
-          "types": "./dist/browser/index.d.mts",
-          "default": "./dist/browser/index.mjs"
-        }
-      },
-      "node": {
-        "require": {
-          "types": "./dist/node/index.d.cts",
-          "default": "./dist/node/index.cjs"
-        },
-        "import": {
-          "types": "./dist/node/index.d.mts",
-          "default": "./dist/node/index.mjs"
-        }
-      }
+      "types": "./dist/neutral/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "main": "dist/node/index.cjs",
-  "module": "dist/node/index.mjs",
-  "types": "dist/node/index.d.mts",
+  "module": "dist/neutral/index.mjs",
+  "types": "dist/neutral/index.d.ts",
   "homepage": "https://xyo.network",
@@ -73,4 +54,4 @@ "license": "LGPL-3.0-only",
   "sideEffects": false,
-  "version": "2.111.3",
+  "version": "3.0.0",
   "type": "module"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

34109

decreased by-58.45%

Number of package files

16

decreased by-70.91%

Lines of code

311

decreased by-35.88%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@xylabs/arraybuffer@4.0.10(transitive)

• + Added@xylabs/assert@4.0.10(transitive)

• + Added@xylabs/hex@4.0.10(transitive)

• + Added@xylabs/lodash@4.0.10(transitive)

• + Added@xylabs/typeof@4.0.10(transitive)

• + Added@xyo-network/data@3.1.11(transitive)

• + Added@xyo-network/key-model@3.1.11(transitive)

• + Added@xyo-network/previous-hash-store-model@3.1.11(transitive)

• + Addedlodash-es@4.17.21(transitive)

• - Removed@xylabs/arraybuffer@3.6.12(transitive)

• - Removed@xylabs/assert@3.6.12(transitive)

• - Removed@xylabs/typeof@3.6.12(transitive)

• - Removed@xyo-network/data@2.111.3(transitive)

• - Removed@xyo-network/key-model@2.111.3(transitive)

• - Removed@xyo-network/previous-hash-store-model@2.111.3(transitive)

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

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