@xyo-network/elliptic 5.3.25 → 5.3.27

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 (2) hide show
  1. package/README.md +212 -10
  2. package/package.json +11 -15
package/README.md CHANGED
@@ -1,23 +1,225 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/elliptic
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
4
13
 
5
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Primary SDK for using XYO Protocol 2.0
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__elliptic)
24
+ Using pnpm:
25
+
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### protocol
46
+
47
+ ### packages
48
+
49
+ ### crypto
50
+
51
+ ### packages
52
+
53
+ ### elliptic
54
+
55
+ ### .temp-typedoc
56
+
57
+ ### classes
58
+
59
+ ### <a id="Elliptic"></a>Elliptic
60
+
61
+ [**@xyo-network/elliptic**](#../README)
62
+
63
+ ***
64
+
65
+ ## Constructors
66
+
67
+ ### Constructor
68
+
69
+ ```ts
70
+ new Elliptic(): Elliptic;
71
+ ```
72
+
73
+ ### Returns
74
+
75
+ `Elliptic`
76
+
77
+ ## Properties
78
+
79
+ ### wasmSupport
80
+
81
+ ```ts
82
+ readonly static wasmSupport: WasmSupport = wasmSupportStatic;
83
+ ```
84
+
85
+ ***
86
+
87
+ ### \_secp256k1
88
+
89
+ ```ts
90
+ protected static _secp256k1: Secp256k1 | undefined;
91
+ ```
92
+
93
+ ## Methods
94
+
95
+ ### addressFromPublicKey()
96
+
97
+ ```ts
98
+ static addressFromPublicKey(key): ArrayBufferLike;
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ #### key
104
+
105
+ `ArrayBufferLike`
106
+
107
+ ### Returns
108
+
109
+ `ArrayBufferLike`
110
+
111
+ ***
112
+
113
+ ### initialize()
114
+
115
+ ```ts
116
+ static initialize(): Promise<Secp256k1>;
117
+ ```
118
+
119
+ ### Returns
120
+
121
+ `Promise`\<`Secp256k1`\>
122
+
123
+ ***
124
+
125
+ ### publicKeyFromPrivateKey()
126
+
127
+ ```ts
128
+ static publicKeyFromPrivateKey(privateKey, prefix?): Promise<ArrayBufferLike>;
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ #### privateKey
134
+
135
+ `ArrayBufferLike`
136
+
137
+ #### prefix?
138
+
139
+ `boolean` = `false`
140
+
141
+ ### Returns
142
+
143
+ `Promise`\<`ArrayBufferLike`\>
144
+
145
+ ***
146
+
147
+ ### ready()
148
+
149
+ ```ts
150
+ static ready(): boolean;
151
+ ```
152
+
153
+ ### Returns
154
+
155
+ `boolean`
156
+
157
+ ***
158
+
159
+ ### secp256k1()
160
+
161
+ ```ts
162
+ static secp256k1(): Promise<Secp256k1>;
163
+ ```
164
+
165
+ ### Returns
166
+
167
+ `Promise`\<`Secp256k1`\>
168
+
169
+ ***
170
+
171
+ ### sign()
172
+
173
+ ```ts
174
+ static sign(hash, key): Promise<ArrayBufferLike>;
175
+ ```
176
+
177
+ ### Parameters
178
+
179
+ #### hash
180
+
181
+ `ArrayBufferLike`
182
+
183
+ #### key
184
+
185
+ `ArrayBufferLike`
186
+
187
+ ### Returns
188
+
189
+ `Promise`\<`ArrayBufferLike`\>
190
+
191
+ ***
192
+
193
+ ### verify()
194
+
195
+ ```ts
196
+ static verify(
197
+ msg,
198
+ signature,
199
+ address): Promise<boolean>;
200
+ ```
201
+
202
+ ### Parameters
203
+
204
+ #### msg
205
+
206
+ `ArrayBufferLike`
207
+
208
+ #### signature
209
+
210
+ `ArrayBufferLike`
211
+
212
+ #### address
213
+
214
+ `ArrayBufferLike`
215
+
216
+ ### Returns
18
217
 
19
- ## Credits
218
+ `Promise`\<`boolean`\>
20
219
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
220
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
221
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
222
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/elliptic.svg
223
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/elliptic
224
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/elliptic.svg
225
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/elliptic",
3
- "version": "5.3.25",
3
+ "version": "5.3.27",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -38,30 +38,26 @@
38
38
  "dependencies": {
39
39
  "@bitauth/libauth": "~3.0.0",
40
40
  "async-mutex": "~0.5.0",
41
- "@xyo-network/data": "~5.3.25",
42
- "@xyo-network/wasm": "~5.3.25"
41
+ "@xyo-network/data": "~5.3.27",
42
+ "@xyo-network/wasm": "~5.3.27"
43
43
  },
44
44
  "devDependencies": {
45
45
  "@bitauth/libauth": "~3.0.0",
46
46
  "@opentelemetry/api": "^1.9.1",
47
- "@types/node": "^25.5.0",
48
- "@xylabs/sdk-js": "^5.0.93",
49
- "@xylabs/ts-scripts-common": "~7.6.16",
50
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
51
- "@xylabs/tsconfig": "~7.6.16",
52
- "acorn": "^8.16.0",
47
+ "@xylabs/sdk-js": "^5.0.94",
48
+ "@xylabs/ts-scripts-common": "~7.7.15",
49
+ "@xylabs/ts-scripts-pnpm": "~7.7.15",
50
+ "@xylabs/tsconfig": "~7.7.15",
53
51
  "async-mutex": "~0.5.0",
54
52
  "axios": "^1.14.0",
55
- "esbuild": "^0.28.0",
56
53
  "ethers": "^6.16.0",
57
54
  "typescript": "~5.9.3",
58
55
  "zod": "^4.3.6",
59
- "@xyo-network/data": "~5.3.25",
60
- "@xyo-network/wasm": "~5.3.25"
56
+ "@xyo-network/data": "~5.3.27",
57
+ "@xyo-network/wasm": "~5.3.27"
61
58
  },
62
59
  "peerDependencies": {
63
- "@xylabs/sdk-js": "^5",
64
- "zod": "^4"
60
+ "@xylabs/sdk-js": "^5"
65
61
  },
66
62
  "publishConfig": {
67
63
  "access": "public"