@xyo-network/key-model 2.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +13 -0
  3. package/dist/cjs/Key/AddressValue.js +3 -0
  4. package/dist/cjs/Key/AddressValue.js.map +1 -0
  5. package/dist/cjs/Key/EllipticKey.js +3 -0
  6. package/dist/cjs/Key/EllipticKey.js.map +1 -0
  7. package/dist/cjs/Key/KeyPair.js +3 -0
  8. package/dist/cjs/Key/KeyPair.js.map +1 -0
  9. package/dist/cjs/Key/PrivateKey.js +3 -0
  10. package/dist/cjs/Key/PrivateKey.js.map +1 -0
  11. package/dist/cjs/Key/PublicKey.js +3 -0
  12. package/dist/cjs/Key/PublicKey.js.map +1 -0
  13. package/dist/cjs/Key/index.js +8 -0
  14. package/dist/cjs/Key/index.js.map +1 -0
  15. package/dist/cjs/index.js +5 -0
  16. package/dist/cjs/index.js.map +1 -0
  17. package/dist/docs.json +2814 -0
  18. package/dist/esm/Key/AddressValue.js +2 -0
  19. package/dist/esm/Key/AddressValue.js.map +1 -0
  20. package/dist/esm/Key/EllipticKey.js +2 -0
  21. package/dist/esm/Key/EllipticKey.js.map +1 -0
  22. package/dist/esm/Key/KeyPair.js +2 -0
  23. package/dist/esm/Key/KeyPair.js.map +1 -0
  24. package/dist/esm/Key/PrivateKey.js +2 -0
  25. package/dist/esm/Key/PrivateKey.js.map +1 -0
  26. package/dist/esm/Key/PublicKey.js +2 -0
  27. package/dist/esm/Key/PublicKey.js.map +1 -0
  28. package/dist/esm/Key/index.js +5 -0
  29. package/dist/esm/Key/index.js.map +1 -0
  30. package/dist/esm/index.js +2 -0
  31. package/dist/esm/index.js.map +1 -0
  32. package/dist/types/Key/AddressValue.d.ts +13 -0
  33. package/dist/types/Key/AddressValue.d.ts.map +1 -0
  34. package/dist/types/Key/EllipticKey.d.ts +4 -0
  35. package/dist/types/Key/EllipticKey.d.ts.map +1 -0
  36. package/dist/types/Key/KeyPair.d.ts +12 -0
  37. package/dist/types/Key/KeyPair.d.ts.map +1 -0
  38. package/dist/types/Key/PrivateKey.d.ts +15 -0
  39. package/dist/types/Key/PrivateKey.d.ts.map +1 -0
  40. package/dist/types/Key/PublicKey.d.ts +14 -0
  41. package/dist/types/Key/PublicKey.d.ts.map +1 -0
  42. package/dist/types/Key/index.d.ts +5 -0
  43. package/dist/types/Key/index.d.ts.map +1 -0
  44. package/dist/types/index.d.ts +2 -0
  45. package/dist/types/index.d.ts.map +1 -0
  46. package/package.json +54 -0
  47. package/src/Key/AddressValue.ts +15 -0
  48. package/src/Key/EllipticKey.ts +4 -0
  49. package/src/Key/KeyPair.ts +14 -0
  50. package/src/Key/PrivateKey.ts +18 -0
  51. package/src/Key/PublicKey.ts +17 -0
  52. package/src/Key/index.ts +4 -0
  53. package/src/index.ts +1 -0
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=AddressValue.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AddressValue.js","sourceRoot":"","sources":["../../../src/Key/AddressValue.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=EllipticKey.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"EllipticKey.js","sourceRoot":"","sources":["../../../src/Key/EllipticKey.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=KeyPair.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"KeyPair.js","sourceRoot":"","sources":["../../../src/Key/KeyPair.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=PrivateKey.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PrivateKey.js","sourceRoot":"","sources":["../../../src/Key/PrivateKey.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=PublicKey.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PublicKey.js","sourceRoot":"","sources":["../../../src/Key/PublicKey.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export * from './AddressValue';
2
+ export * from './KeyPair';
3
+ export * from './PrivateKey';
4
+ export * from './PublicKey';
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Key/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './Key';
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA"}
@@ -0,0 +1,13 @@
1
+ import { DataLike } from '@xyo-network/core';
2
+ import { EllipticKeyInstance } from './EllipticKey';
3
+ export interface AddressValueInstance extends EllipticKeyInstance {
4
+ verify(msg: Uint8Array | string, signature: Uint8Array | string): boolean;
5
+ }
6
+ export interface AddressValueStatic {
7
+ new (address: DataLike): AddressValueInstance;
8
+ addressFromAddressOrPublicKey(bytes: DataLike): Uint8Array | string;
9
+ addressFromPublicKey(key: DataLike): string;
10
+ isXyoAddress(value: unknown): boolean;
11
+ verify(msg: Uint8Array | string, signature: Uint8Array | string, address: DataLike): boolean;
12
+ }
13
+ //# sourceMappingURL=AddressValue.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AddressValue.d.ts","sourceRoot":"","sources":["../../../src/Key/AddressValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAEnD,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;CAC1E;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,OAAO,EAAE,QAAQ,GAAG,oBAAoB,CAAA;IAC7C,6BAA6B,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAA;IACnE,oBAAoB,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAAA;IAC3C,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAA;IACrC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAA;CAC7F"}
@@ -0,0 +1,4 @@
1
+ import { XyoData } from '@xyo-network/core';
2
+ export interface EllipticKeyInstance extends XyoData {
3
+ }
4
+ //# sourceMappingURL=EllipticKey.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"EllipticKey.d.ts","sourceRoot":"","sources":["../../../src/Key/EllipticKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAG3C,MAAM,WAAW,mBAAoB,SAAQ,OAAO;CAAG"}
@@ -0,0 +1,12 @@
1
+ import { DataLike } from '@xyo-network/core';
2
+ import { XyoPrivateKeyModel } from './PrivateKey';
3
+ import { XyoPublicKeyModel } from './PublicKey';
4
+ export interface KeyPairInstance {
5
+ get private(): XyoPrivateKeyModel;
6
+ get public(): XyoPublicKeyModel;
7
+ }
8
+ export interface KeyPairStatic {
9
+ new (privateKeyData?: DataLike): KeyPairInstance;
10
+ isXyoKeyPair(value: unknown): boolean;
11
+ }
12
+ //# sourceMappingURL=KeyPair.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"KeyPair.d.ts","sourceRoot":"","sources":["../../../src/Key/KeyPair.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,WAAW,eAAe;IAC9B,IAAI,OAAO,IAAI,kBAAkB,CAAA;IACjC,IAAI,MAAM,IAAI,iBAAiB,CAAA;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,cAAc,CAAC,EAAE,QAAQ,GAAG,eAAe,CAAA;IAChD,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAA;CACtC"}
@@ -0,0 +1,15 @@
1
+ import { DataLike } from '@xyo-network/core';
2
+ import { EllipticKeyInstance } from './EllipticKey';
3
+ import { XyoPublicKeyModel } from './PublicKey';
4
+ export interface PrivateKeyInstance extends EllipticKeyInstance {
5
+ get public(): XyoPublicKeyModel;
6
+ sign(hash: DataLike): Uint8Array;
7
+ verify(msg: Uint8Array | string, signature: Uint8Array | string): boolean;
8
+ }
9
+ export interface PrivateKeyStatic {
10
+ new (value?: DataLike): PrivateKeyInstance;
11
+ isXyoPrivateKey(value: unknown): boolean;
12
+ }
13
+ export interface XyoPrivateKeyModel extends PrivateKeyInstance {
14
+ }
15
+ //# sourceMappingURL=PrivateKey.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PrivateKey.d.ts","sourceRoot":"","sources":["../../../src/Key/PrivateKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,MAAM,IAAI,iBAAiB,CAAA;IAC/B,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAA;IAChC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;CAC1E;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,KAAK,CAAC,EAAE,QAAQ,GAAG,kBAAkB,CAAA;IAC1C,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAA;CACzC;AAGD,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;CAAG"}
@@ -0,0 +1,14 @@
1
+ import { DataLike } from '@xyo-network/core';
2
+ import { AddressValueInstance } from './AddressValue';
3
+ import { EllipticKeyInstance } from './EllipticKey';
4
+ export interface PublicKeyInstance extends EllipticKeyInstance {
5
+ get address(): AddressValueInstance;
6
+ verify(msg: Uint8Array | string, signature: Uint8Array | string): boolean;
7
+ }
8
+ export interface PublicKeyStatic {
9
+ new (bytes: DataLike): PublicKeyInstance;
10
+ isXyoPublicKey(value: unknown): boolean;
11
+ }
12
+ export interface XyoPublicKeyModel extends PublicKeyInstance {
13
+ }
14
+ //# sourceMappingURL=PublicKey.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PublicKey.d.ts","sourceRoot":"","sources":["../../../src/Key/PublicKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAEnD,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,IAAI,OAAO,IAAI,oBAAoB,CAAA;IACnC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;CAC1E;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,KAAK,EAAE,QAAQ,GAAG,iBAAiB,CAAA;IACxC,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAA;CACxC;AAGD,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;CAAG"}
@@ -0,0 +1,5 @@
1
+ export * from './AddressValue';
2
+ export * from './KeyPair';
3
+ export * from './PrivateKey';
4
+ export * from './PublicKey';
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Key/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './Key';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA"}
package/package.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "name": "@xyo-network/key-model",
3
+ "author": {
4
+ "email": "support@xyo.network",
5
+ "name": "XYO Development Team",
6
+ "url": "https://xyo.network"
7
+ },
8
+ "bugs": {
9
+ "email": "support@xyo.network",
10
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
+ },
12
+ "dependencies": {
13
+ "@xyo-network/core": "^2.48.0"
14
+ },
15
+ "description": "Primary SDK for using XYO Protocol 2.0",
16
+ "devDependencies": {
17
+ "@xylabs/ts-scripts-yarn3": "^2.15.0",
18
+ "@xylabs/tsconfig": "^2.15.0",
19
+ "typescript": "^4.9.5"
20
+ },
21
+ "browser": "dist/esm/index.js",
22
+ "main": "dist/cjs/index.js",
23
+ "module": "dist/esm/index.js",
24
+ "docs": "dist/docs.json",
25
+ "exports": {
26
+ ".": {
27
+ "node": {
28
+ "import": "./dist/esm/index.js",
29
+ "require": "./dist/cjs/index.js"
30
+ },
31
+ "browser": {
32
+ "import": "./dist/esm/index.js",
33
+ "require": "./dist/cjs/index.js"
34
+ },
35
+ "default": "./dist/esm/index.js"
36
+ },
37
+ "./dist/docs.json": {
38
+ "default": "./dist/docs.json"
39
+ },
40
+ "./package.json": "./package.json"
41
+ },
42
+ "homepage": "https://xyo.network",
43
+ "license": "LGPL-3.0",
44
+ "publishConfig": {
45
+ "access": "public"
46
+ },
47
+ "repository": {
48
+ "type": "git",
49
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
50
+ },
51
+ "sideEffects": false,
52
+ "types": "dist/types/index.d.ts",
53
+ "version": "2.48.0"
54
+ }
@@ -0,0 +1,15 @@
1
+ import { DataLike } from '@xyo-network/core'
2
+
3
+ import { EllipticKeyInstance } from './EllipticKey'
4
+
5
+ export interface AddressValueInstance extends EllipticKeyInstance {
6
+ verify(msg: Uint8Array | string, signature: Uint8Array | string): boolean
7
+ }
8
+
9
+ export interface AddressValueStatic {
10
+ new (address: DataLike): AddressValueInstance
11
+ addressFromAddressOrPublicKey(bytes: DataLike): Uint8Array | string
12
+ addressFromPublicKey(key: DataLike): string
13
+ isXyoAddress(value: unknown): boolean
14
+ verify(msg: Uint8Array | string, signature: Uint8Array | string, address: DataLike): boolean
15
+ }
@@ -0,0 +1,4 @@
1
+ import { XyoData } from '@xyo-network/core'
2
+
3
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
4
+ export interface EllipticKeyInstance extends XyoData {}
@@ -0,0 +1,14 @@
1
+ import { DataLike } from '@xyo-network/core'
2
+
3
+ import { XyoPrivateKeyModel } from './PrivateKey'
4
+ import { XyoPublicKeyModel } from './PublicKey'
5
+
6
+ export interface KeyPairInstance {
7
+ get private(): XyoPrivateKeyModel
8
+ get public(): XyoPublicKeyModel
9
+ }
10
+
11
+ export interface KeyPairStatic {
12
+ new (privateKeyData?: DataLike): KeyPairInstance
13
+ isXyoKeyPair(value: unknown): boolean
14
+ }
@@ -0,0 +1,18 @@
1
+ import { DataLike } from '@xyo-network/core'
2
+
3
+ import { EllipticKeyInstance } from './EllipticKey'
4
+ import { XyoPublicKeyModel } from './PublicKey'
5
+
6
+ export interface PrivateKeyInstance extends EllipticKeyInstance {
7
+ get public(): XyoPublicKeyModel
8
+ sign(hash: DataLike): Uint8Array
9
+ verify(msg: Uint8Array | string, signature: Uint8Array | string): boolean
10
+ }
11
+
12
+ export interface PrivateKeyStatic {
13
+ new (value?: DataLike): PrivateKeyInstance
14
+ isXyoPrivateKey(value: unknown): boolean
15
+ }
16
+
17
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
18
+ export interface XyoPrivateKeyModel extends PrivateKeyInstance {}
@@ -0,0 +1,17 @@
1
+ import { DataLike } from '@xyo-network/core'
2
+
3
+ import { AddressValueInstance } from './AddressValue'
4
+ import { EllipticKeyInstance } from './EllipticKey'
5
+
6
+ export interface PublicKeyInstance extends EllipticKeyInstance {
7
+ get address(): AddressValueInstance
8
+ verify(msg: Uint8Array | string, signature: Uint8Array | string): boolean
9
+ }
10
+
11
+ export interface PublicKeyStatic {
12
+ new (bytes: DataLike): PublicKeyInstance
13
+ isXyoPublicKey(value: unknown): boolean
14
+ }
15
+
16
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
17
+ export interface XyoPublicKeyModel extends PublicKeyInstance {}
@@ -0,0 +1,4 @@
1
+ export * from './AddressValue'
2
+ export * from './KeyPair'
3
+ export * from './PrivateKey'
4
+ export * from './PublicKey'
package/src/index.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './Key'