@quantovainc/qcore 0.1.8 → 0.1.9
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.
- package/package.json +2 -2
- package/pkg/LICENSE-APACHE +202 -0
- package/pkg/LICENSE-MIT +21 -0
- package/pkg/README.md +193 -0
- package/pkg-node/LICENSE-APACHE +202 -0
- package/pkg-node/LICENSE-MIT +21 -0
- package/pkg-node/README.md +193 -0
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quantovainc/qcore",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.9",
|
|
4
4
|
"description": "Quantova's post quantum client core for JavaScript. Signs with ML-DSA-65 and builds Q1 addresses.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "wasm-pack build --target bundler --out-dir pkg && wasm-pack build --target nodejs --out-dir pkg-node",
|
|
7
|
-
"test": "node test-conformance.js && node test-sign-validate.js && node test-transport.js && node test-fee-cap.js"
|
|
7
|
+
"test": "node test-conformance.js && node test-sign-validate.js && node test-transport.js && node test-fee-cap.js && node test-network.js"
|
|
8
8
|
},
|
|
9
9
|
"keywords": [
|
|
10
10
|
"post-quantum",
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/pkg/LICENSE-MIT
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Quantova Inc
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/pkg/README.md
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# QCore.js
|
|
2
|
+
|
|
3
|
+
[](https://github.com/Quantova/QCore.js/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/@quantovainc/qcore)
|
|
5
|
+
|
|
6
|
+
The post quantum client core for Quantova. It signs with ML-DSA-65, builds Q1 addresses, and runs the same compiled core in the browser and in Node.
|
|
7
|
+
|
|
8
|
+
**This npm account and this package belong to Quantova Inc. It is the official Quantova client SDK. Any similarly named package published under a different account is not this one and is not from Quantova.**
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
npm install @quantovainc/qcore
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quickstart
|
|
17
|
+
|
|
18
|
+
```js
|
|
19
|
+
const { Client, core, generateSeed } = require('@quantovainc/qcore');
|
|
20
|
+
|
|
21
|
+
async function main() {
|
|
22
|
+
// Create an account. The seed is the only backup and it never leaves the device.
|
|
23
|
+
const seed = generateSeed();
|
|
24
|
+
const phrase = core.mnemonicFromSeed(seed);
|
|
25
|
+
|
|
26
|
+
// Derive the Q1 address for account index zero, and a recipient at index one.
|
|
27
|
+
const from = core.address(seed, 0n);
|
|
28
|
+
const to = core.address(seed, 1n);
|
|
29
|
+
console.log('from', from);
|
|
30
|
+
|
|
31
|
+
// Open a client against a node you trust. Plaintext http is allowed only to a loopback node.
|
|
32
|
+
const client = new Client('http://127.0.0.1:8645');
|
|
33
|
+
|
|
34
|
+
// A fixed ceiling your app is willing to pay in fees, chosen here and never read back from the gateway.
|
|
35
|
+
const MAX_FEE_QUON = '2000';
|
|
36
|
+
|
|
37
|
+
// Amounts and the ceiling are decimal strings or BigInt values, never JavaScript numbers.
|
|
38
|
+
const { signed, outcome } = await client.transfer(seed, 0, to, '1000', MAX_FEE_QUON);
|
|
39
|
+
console.log('submitted', signed.tx_id, outcome.verdict);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
main().catch((err) => { console.error(err.message); process.exit(1); });
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
A runnable copy of this lives in [examples/quickstart.js](examples/quickstart.js).
|
|
46
|
+
|
|
47
|
+
## Security posture
|
|
48
|
+
|
|
49
|
+
Every signature is ML-DSA-65 as standardised in FIPS 204, and addresses and transaction digests are built with SHA-3. There is no elliptic curve anywhere in this package, no secp256k1 and no ECDSA. When you send through the Client you pass a maximum fee that you choose yourself, and the Client refuses to sign when the gateway reports a fee above it, so a hostile gateway cannot inflate the fee and drain the balance. The Client also refuses an unsafe transport. A remote gateway must be reached over https, and plaintext http is allowed only to a loopback node, because a fee and a nonce read back over plaintext could be rewritten on the wire. This package is at the testnet and pre audit stage, so please do not read it as audited.
|
|
50
|
+
|
|
51
|
+
## What this library is for
|
|
52
|
+
|
|
53
|
+
Any browser app, extension, or Node service that holds a Quantova account, reads the chain, and sends signed transactions. A wallet, a dApp, a block explorer front end, or a faucet page. Your code does the network fetch it prefers and QCore.js derives the key, signs the transaction, and builds the request body, so nothing about the cryptography or the byte layout of a transaction is written in JavaScript. A second implementation of the signing would be a second chance to be wrong with a user's money, so there is only ever the one.
|
|
54
|
+
|
|
55
|
+
## The post quantum cryptography it handles
|
|
56
|
+
|
|
57
|
+
Quantova is post quantum from the ground. There is no elliptic curve anywhere in it, no secp256k1, no ECDSA, no Ethereum address, and no Substrate envelope. Every primitive below is Quantova's own from scratch implementation in the Q Crypto library, carrying no third party cryptography dependency, compiled into the core module that ships with this package.
|
|
58
|
+
|
|
59
|
+
1. Key derivation. Your app holds one master seed of thirty two bytes. QCore.js grows a per account seed from it with SHAKE256 over the master seed, the scheme byte, and the account index, then derives a module lattice key pair from that seed. The node runs the identical derivation, so the account a key signs from is the account that holds the funds.
|
|
60
|
+
|
|
61
|
+
2. The signing scheme. The default is the module lattice signature ML-DSA-65 as standardised in FIPS 204, carried on the wire as scheme one. The hash based signature SLH-DSA as standardised in FIPS 205 is scheme two. Signing is deterministic, so one transaction body always signs to one exact run of bytes, which makes a signed transaction reproducible and testable in a browser.
|
|
62
|
+
|
|
63
|
+
3. The address. A Quantova address is the Bech32m Q1 string that renders the SHA3 256 hash of the scheme byte together with the whole module lattice public key of one thousand nine hundred fifty two bytes. The entire public key is bound into the address. Nothing is truncated to a twenty byte hash and there is no key recovery from a signature, so one address names exactly one post quantum key.
|
|
64
|
+
|
|
65
|
+
4. The transaction. A transaction body carries the sender, the nonce, the meter limit, the fee, and the call. The bytes a signature stands over are the SHA3 256 hash of the canonical body followed by a fixed Quantova transaction domain tag, so a transaction signature can never be replayed as another kind of signed message. QCore.js assembles the body, signs the digest inside the compiled core, and returns the wrapper bytes and the transaction id ready for the gateway.
|
|
66
|
+
|
|
67
|
+
5. The payable call. `core.signPayableCall` carries a native value and an explicit chain id alongside the sender, the nonce, the meter limit, the fee, and the call, so a call to a contract can move value in the same signed body a transfer does, and the same signature can be pinned to one network. The sender and the target never enter that signature as the rendered Q1 string, since a display convention can change over time. Each is parsed back to its raw thirty two byte payload first, and that payload, never the string, is what the preimage carries, so the signature stays bound to the account and never to how an address happened to be printed.
|
|
68
|
+
|
|
69
|
+
## How it is customised to Quantova and inherits nothing from the industry
|
|
70
|
+
|
|
71
|
+
Quantova shares no wire, no address, and no unit with any other chain, and QCore.js speaks only Quantova. The address is a Q1 Bech32m string over a full post quantum key, never a hex twenty byte address and never an SS58 string. Money is counted in Quon, the smallest unit, at one million Quon to one QTOV, and it always crosses the wire as a decimal string. You pass an amount as a decimal string or a BigInt and never as a JavaScript number, because a number silently rounds above 2^53 and would sign a wrong amount. The wire is the Quantova gateway, an HTTP POST to a named method under a version prefix with a flat JSON body, not Ethereum JSON RPC and not a Substrate WebSocket. The transaction encoding is Quantova's own canonical codec, not RLP and not SCALE. The signatures come from Q Crypto, Quantova's own implementation of the lattice and hash standards written from scratch, not a borrowed library. There is no ethers, no web3, and no polkadot here.
|
|
72
|
+
|
|
73
|
+
## Creating a wallet
|
|
74
|
+
|
|
75
|
+
```js
|
|
76
|
+
const { generateSeed, core } = require('@quantovainc/qcore');
|
|
77
|
+
|
|
78
|
+
const seed = generateSeed(); // thirty two random bytes as hex from the platform source
|
|
79
|
+
const phrase = core.mnemonicFromSeed(seed); // the only backup, shown once and kept on the device
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Using it
|
|
83
|
+
|
|
84
|
+
The last argument to a Client signing call, transfer, register, call, or callSignedOrder, is a fee
|
|
85
|
+
ceiling, the most you are ever willing to pay in fees for one transaction. You choose it yourself, as a
|
|
86
|
+
fixed number your app decides on its own, before you sign. The Client reads the gateway's reported fee,
|
|
87
|
+
compares it to your ceiling, and refuses to sign when the reported fee is above the ceiling, so an
|
|
88
|
+
independently chosen ceiling is the one limit standing between a hostile gateway and your balance. It
|
|
89
|
+
protects you only when you pick the number yourself. If you read the gateway's own reported fee and hand
|
|
90
|
+
that back as the ceiling, you have set the ceiling to whatever the gateway asked for and you have no
|
|
91
|
+
protection at all. Pass the ceiling as a decimal string or a BigInt, never a JavaScript number, for the
|
|
92
|
+
same reason as the amount, because a number silently rounds above 2^53 and could set the ceiling higher
|
|
93
|
+
than you intended.
|
|
94
|
+
|
|
95
|
+
This comparison lives in the Client and only in the Client. The raw core.* signing functions, such as
|
|
96
|
+
core.sign_transfer, take the actual fee that goes on the wire as their last argument, not a ceiling, and
|
|
97
|
+
do no gateway comparison at all. A developer who calls core.* directly has no fee cap, so reach for the
|
|
98
|
+
Client whenever a gateway you do not control reports the fee.
|
|
99
|
+
|
|
100
|
+
```js
|
|
101
|
+
const { Client } = require('@quantovainc/qcore');
|
|
102
|
+
|
|
103
|
+
const client = new Client('http://127.0.0.1:8645');
|
|
104
|
+
const seed = '0b'.repeat(32);
|
|
105
|
+
const to = client.address(seed, 1);
|
|
106
|
+
|
|
107
|
+
// A fixed ceiling your app is willing to pay, chosen here and never read back from the gateway.
|
|
108
|
+
const MAX_FEE_QUON = '2000';
|
|
109
|
+
|
|
110
|
+
// The amount is a decimal string or a BigInt, never a JavaScript number.
|
|
111
|
+
const { signed, outcome } = await client.transfer(seed, 0, to, '1000', MAX_FEE_QUON);
|
|
112
|
+
const status = await client.transaction(signed.tx_id);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The Client insists on a safe transport. A remote gateway must be reached over https, and plaintext
|
|
116
|
+
http is allowed only to a loopback node such as `127.0.0.1`, `localhost`, or `[::1]`. A base that points
|
|
117
|
+
plaintext http at any other host is refused when the Client is built, because a fee and a nonce read
|
|
118
|
+
back over plaintext are unauthenticated and rewritable on the wire and could be turned to drain funds.
|
|
119
|
+
|
|
120
|
+
An account funded by a transfer, such as a faucet claim, arrives with a balance but no key on the
|
|
121
|
+
chain, so it registers its key once before its first send. After that it sends as above.
|
|
122
|
+
|
|
123
|
+
```js
|
|
124
|
+
// Once, after the account is funded and before its first send.
|
|
125
|
+
await client.register(seed, 0, MAX_FEE_QUON);
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
A call that also moves value, such as a payable contract call, reaches for `core.signPayableCall`
|
|
129
|
+
directly. It takes the value and the chain id as explicit arguments, the value as a decimal string or a
|
|
130
|
+
BigInt for the same reason as an amount, and the chain id from `core.localChainId()`,
|
|
131
|
+
`core.mainnetChainId()`, or `core.testnetChainId()` so the network is never a magic number.
|
|
132
|
+
|
|
133
|
+
```js
|
|
134
|
+
const { core } = require('@quantovainc/qcore');
|
|
135
|
+
|
|
136
|
+
const signed = JSON.parse(
|
|
137
|
+
core.signPayableCall(seed, 0n, contract, argsHex, nonce, meterLimit, fee, '1000', core.testnetChainId()),
|
|
138
|
+
);
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## The compiled core
|
|
142
|
+
|
|
143
|
+
The compiled core in this package is only the shipping form of the one Rust core, built so the same key derivation, signing, and wire code runs in a browser and in Node. It is not a virtual machine and it is not what the chain runs. The Quantova chain executes only the QVM, the container machine that runs contracts. The compiled core here is a client side build artifact and nothing more.
|
|
144
|
+
|
|
145
|
+
## TypeScript
|
|
146
|
+
|
|
147
|
+
The package ships TypeScript types in `index.d.ts`, so the Client, the core functions, and the Network helpers are all typed with no extra install.
|
|
148
|
+
|
|
149
|
+
## Builds
|
|
150
|
+
|
|
151
|
+
The package ships one guarded surface, the Client with the fee cap and the amount guard, over two
|
|
152
|
+
builds of the one core, and every default entry hands you that same Client. Node resolves to
|
|
153
|
+
the node entry, which loads the nodejs build from `pkg-node`, reads it from disk, needs no
|
|
154
|
+
experimental flag, works on every supported Node for both require and import, and is the build the tests
|
|
155
|
+
run against. A browser, or a bundler such as webpack or Vite, resolves through the exports map to the
|
|
156
|
+
browser entry, which wraps the bundler build in `pkg` in the identical Client, so a browser wallet gets
|
|
157
|
+
the fee cap and the amount guard and never the bare signing functions.
|
|
158
|
+
|
|
159
|
+
The raw builds are still reachable on their own subpaths, `@quantovainc/qcore/pkg` for the bundler build
|
|
160
|
+
and `@quantovainc/qcore/pkg-node` for the nodejs build. Those export only the core.* functions, with no
|
|
161
|
+
Client, no fee cap, and no amount guard, and are for an advanced caller who assembles the fee comparison
|
|
162
|
+
alone. The default browser, import, node, and require resolutions never reach them.
|
|
163
|
+
|
|
164
|
+
To build both from source, run the two documented builds or `npm run build`.
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
wasm-pack build --target bundler --out-dir pkg
|
|
168
|
+
wasm-pack build --target nodejs --out-dir pkg-node
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
The offline test scripts run with `npm test`, and they need no network and no running gateway.
|
|
172
|
+
|
|
173
|
+
## Conformance vectors
|
|
174
|
+
|
|
175
|
+
The frozen conformance vectors live in the [conformance](conformance) folder of this repository. The address derivation is in `conformance/address.derivation.json`, the transfer in `conformance/transaction.transfer.json`, and the payable call in `conformance/transaction.payable.json`. The offline test `test-conformance.js` signs from these vectors and checks the binding matches them byte for byte, so a change that would move a signed transaction fails the test.
|
|
176
|
+
|
|
177
|
+
## Examples
|
|
178
|
+
|
|
179
|
+
The [examples](examples) folder holds a runnable quickstart that mirrors the one above. For fuller starters, see the Q-Scaffold and the Q-Forge repositories under the Quantova org, at https://github.com/Quantova/Q-Scaffold and https://github.com/Quantova/Q-Forge.
|
|
180
|
+
|
|
181
|
+
## Releases and provenance
|
|
182
|
+
|
|
183
|
+
Releases are published from CI by the publish workflow in `.github/workflows/publish.yml`, which runs on a pushed git tag. It builds the two wasm targets, runs the offline tests, and publishes with npm provenance, so the copy of the package on the registry carries a verified provenance badge that ties it to this exact public commit. Nothing is published to a registry without an explicit tag. This package handles a user's keys and a published version cannot be taken back.
|
|
184
|
+
|
|
185
|
+
For the provenance publish to run, the maintainer adds an `NPM_TOKEN` automation secret to the repository, or configures npm trusted publishing for the package so the workflow authenticates over OIDC with no stored token.
|
|
186
|
+
|
|
187
|
+
## Security
|
|
188
|
+
|
|
189
|
+
To report a vulnerability, see [SECURITY.md](SECURITY.md). Please report privately and not through a public issue.
|
|
190
|
+
|
|
191
|
+
## Ownership and license
|
|
192
|
+
|
|
193
|
+
QCore.js is built and owned by Quantova Inc, and the signing lives in one compiled core and is never rewritten in JavaScript. It carries none of the industry stack and inherits nothing from it. It is dual licensed under the Apache 2.0 and MIT licenses so any wallet, explorer, or service may build on it, and the copyright stays with Quantova Inc.
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Quantova Inc
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# QCore.js
|
|
2
|
+
|
|
3
|
+
[](https://github.com/Quantova/QCore.js/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/@quantovainc/qcore)
|
|
5
|
+
|
|
6
|
+
The post quantum client core for Quantova. It signs with ML-DSA-65, builds Q1 addresses, and runs the same compiled core in the browser and in Node.
|
|
7
|
+
|
|
8
|
+
**This npm account and this package belong to Quantova Inc. It is the official Quantova client SDK. Any similarly named package published under a different account is not this one and is not from Quantova.**
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
npm install @quantovainc/qcore
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quickstart
|
|
17
|
+
|
|
18
|
+
```js
|
|
19
|
+
const { Client, core, generateSeed } = require('@quantovainc/qcore');
|
|
20
|
+
|
|
21
|
+
async function main() {
|
|
22
|
+
// Create an account. The seed is the only backup and it never leaves the device.
|
|
23
|
+
const seed = generateSeed();
|
|
24
|
+
const phrase = core.mnemonicFromSeed(seed);
|
|
25
|
+
|
|
26
|
+
// Derive the Q1 address for account index zero, and a recipient at index one.
|
|
27
|
+
const from = core.address(seed, 0n);
|
|
28
|
+
const to = core.address(seed, 1n);
|
|
29
|
+
console.log('from', from);
|
|
30
|
+
|
|
31
|
+
// Open a client against a node you trust. Plaintext http is allowed only to a loopback node.
|
|
32
|
+
const client = new Client('http://127.0.0.1:8645');
|
|
33
|
+
|
|
34
|
+
// A fixed ceiling your app is willing to pay in fees, chosen here and never read back from the gateway.
|
|
35
|
+
const MAX_FEE_QUON = '2000';
|
|
36
|
+
|
|
37
|
+
// Amounts and the ceiling are decimal strings or BigInt values, never JavaScript numbers.
|
|
38
|
+
const { signed, outcome } = await client.transfer(seed, 0, to, '1000', MAX_FEE_QUON);
|
|
39
|
+
console.log('submitted', signed.tx_id, outcome.verdict);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
main().catch((err) => { console.error(err.message); process.exit(1); });
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
A runnable copy of this lives in [examples/quickstart.js](examples/quickstart.js).
|
|
46
|
+
|
|
47
|
+
## Security posture
|
|
48
|
+
|
|
49
|
+
Every signature is ML-DSA-65 as standardised in FIPS 204, and addresses and transaction digests are built with SHA-3. There is no elliptic curve anywhere in this package, no secp256k1 and no ECDSA. When you send through the Client you pass a maximum fee that you choose yourself, and the Client refuses to sign when the gateway reports a fee above it, so a hostile gateway cannot inflate the fee and drain the balance. The Client also refuses an unsafe transport. A remote gateway must be reached over https, and plaintext http is allowed only to a loopback node, because a fee and a nonce read back over plaintext could be rewritten on the wire. This package is at the testnet and pre audit stage, so please do not read it as audited.
|
|
50
|
+
|
|
51
|
+
## What this library is for
|
|
52
|
+
|
|
53
|
+
Any browser app, extension, or Node service that holds a Quantova account, reads the chain, and sends signed transactions. A wallet, a dApp, a block explorer front end, or a faucet page. Your code does the network fetch it prefers and QCore.js derives the key, signs the transaction, and builds the request body, so nothing about the cryptography or the byte layout of a transaction is written in JavaScript. A second implementation of the signing would be a second chance to be wrong with a user's money, so there is only ever the one.
|
|
54
|
+
|
|
55
|
+
## The post quantum cryptography it handles
|
|
56
|
+
|
|
57
|
+
Quantova is post quantum from the ground. There is no elliptic curve anywhere in it, no secp256k1, no ECDSA, no Ethereum address, and no Substrate envelope. Every primitive below is Quantova's own from scratch implementation in the Q Crypto library, carrying no third party cryptography dependency, compiled into the core module that ships with this package.
|
|
58
|
+
|
|
59
|
+
1. Key derivation. Your app holds one master seed of thirty two bytes. QCore.js grows a per account seed from it with SHAKE256 over the master seed, the scheme byte, and the account index, then derives a module lattice key pair from that seed. The node runs the identical derivation, so the account a key signs from is the account that holds the funds.
|
|
60
|
+
|
|
61
|
+
2. The signing scheme. The default is the module lattice signature ML-DSA-65 as standardised in FIPS 204, carried on the wire as scheme one. The hash based signature SLH-DSA as standardised in FIPS 205 is scheme two. Signing is deterministic, so one transaction body always signs to one exact run of bytes, which makes a signed transaction reproducible and testable in a browser.
|
|
62
|
+
|
|
63
|
+
3. The address. A Quantova address is the Bech32m Q1 string that renders the SHA3 256 hash of the scheme byte together with the whole module lattice public key of one thousand nine hundred fifty two bytes. The entire public key is bound into the address. Nothing is truncated to a twenty byte hash and there is no key recovery from a signature, so one address names exactly one post quantum key.
|
|
64
|
+
|
|
65
|
+
4. The transaction. A transaction body carries the sender, the nonce, the meter limit, the fee, and the call. The bytes a signature stands over are the SHA3 256 hash of the canonical body followed by a fixed Quantova transaction domain tag, so a transaction signature can never be replayed as another kind of signed message. QCore.js assembles the body, signs the digest inside the compiled core, and returns the wrapper bytes and the transaction id ready for the gateway.
|
|
66
|
+
|
|
67
|
+
5. The payable call. `core.signPayableCall` carries a native value and an explicit chain id alongside the sender, the nonce, the meter limit, the fee, and the call, so a call to a contract can move value in the same signed body a transfer does, and the same signature can be pinned to one network. The sender and the target never enter that signature as the rendered Q1 string, since a display convention can change over time. Each is parsed back to its raw thirty two byte payload first, and that payload, never the string, is what the preimage carries, so the signature stays bound to the account and never to how an address happened to be printed.
|
|
68
|
+
|
|
69
|
+
## How it is customised to Quantova and inherits nothing from the industry
|
|
70
|
+
|
|
71
|
+
Quantova shares no wire, no address, and no unit with any other chain, and QCore.js speaks only Quantova. The address is a Q1 Bech32m string over a full post quantum key, never a hex twenty byte address and never an SS58 string. Money is counted in Quon, the smallest unit, at one million Quon to one QTOV, and it always crosses the wire as a decimal string. You pass an amount as a decimal string or a BigInt and never as a JavaScript number, because a number silently rounds above 2^53 and would sign a wrong amount. The wire is the Quantova gateway, an HTTP POST to a named method under a version prefix with a flat JSON body, not Ethereum JSON RPC and not a Substrate WebSocket. The transaction encoding is Quantova's own canonical codec, not RLP and not SCALE. The signatures come from Q Crypto, Quantova's own implementation of the lattice and hash standards written from scratch, not a borrowed library. There is no ethers, no web3, and no polkadot here.
|
|
72
|
+
|
|
73
|
+
## Creating a wallet
|
|
74
|
+
|
|
75
|
+
```js
|
|
76
|
+
const { generateSeed, core } = require('@quantovainc/qcore');
|
|
77
|
+
|
|
78
|
+
const seed = generateSeed(); // thirty two random bytes as hex from the platform source
|
|
79
|
+
const phrase = core.mnemonicFromSeed(seed); // the only backup, shown once and kept on the device
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Using it
|
|
83
|
+
|
|
84
|
+
The last argument to a Client signing call, transfer, register, call, or callSignedOrder, is a fee
|
|
85
|
+
ceiling, the most you are ever willing to pay in fees for one transaction. You choose it yourself, as a
|
|
86
|
+
fixed number your app decides on its own, before you sign. The Client reads the gateway's reported fee,
|
|
87
|
+
compares it to your ceiling, and refuses to sign when the reported fee is above the ceiling, so an
|
|
88
|
+
independently chosen ceiling is the one limit standing between a hostile gateway and your balance. It
|
|
89
|
+
protects you only when you pick the number yourself. If you read the gateway's own reported fee and hand
|
|
90
|
+
that back as the ceiling, you have set the ceiling to whatever the gateway asked for and you have no
|
|
91
|
+
protection at all. Pass the ceiling as a decimal string or a BigInt, never a JavaScript number, for the
|
|
92
|
+
same reason as the amount, because a number silently rounds above 2^53 and could set the ceiling higher
|
|
93
|
+
than you intended.
|
|
94
|
+
|
|
95
|
+
This comparison lives in the Client and only in the Client. The raw core.* signing functions, such as
|
|
96
|
+
core.sign_transfer, take the actual fee that goes on the wire as their last argument, not a ceiling, and
|
|
97
|
+
do no gateway comparison at all. A developer who calls core.* directly has no fee cap, so reach for the
|
|
98
|
+
Client whenever a gateway you do not control reports the fee.
|
|
99
|
+
|
|
100
|
+
```js
|
|
101
|
+
const { Client } = require('@quantovainc/qcore');
|
|
102
|
+
|
|
103
|
+
const client = new Client('http://127.0.0.1:8645');
|
|
104
|
+
const seed = '0b'.repeat(32);
|
|
105
|
+
const to = client.address(seed, 1);
|
|
106
|
+
|
|
107
|
+
// A fixed ceiling your app is willing to pay, chosen here and never read back from the gateway.
|
|
108
|
+
const MAX_FEE_QUON = '2000';
|
|
109
|
+
|
|
110
|
+
// The amount is a decimal string or a BigInt, never a JavaScript number.
|
|
111
|
+
const { signed, outcome } = await client.transfer(seed, 0, to, '1000', MAX_FEE_QUON);
|
|
112
|
+
const status = await client.transaction(signed.tx_id);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The Client insists on a safe transport. A remote gateway must be reached over https, and plaintext
|
|
116
|
+
http is allowed only to a loopback node such as `127.0.0.1`, `localhost`, or `[::1]`. A base that points
|
|
117
|
+
plaintext http at any other host is refused when the Client is built, because a fee and a nonce read
|
|
118
|
+
back over plaintext are unauthenticated and rewritable on the wire and could be turned to drain funds.
|
|
119
|
+
|
|
120
|
+
An account funded by a transfer, such as a faucet claim, arrives with a balance but no key on the
|
|
121
|
+
chain, so it registers its key once before its first send. After that it sends as above.
|
|
122
|
+
|
|
123
|
+
```js
|
|
124
|
+
// Once, after the account is funded and before its first send.
|
|
125
|
+
await client.register(seed, 0, MAX_FEE_QUON);
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
A call that also moves value, such as a payable contract call, reaches for `core.signPayableCall`
|
|
129
|
+
directly. It takes the value and the chain id as explicit arguments, the value as a decimal string or a
|
|
130
|
+
BigInt for the same reason as an amount, and the chain id from `core.localChainId()`,
|
|
131
|
+
`core.mainnetChainId()`, or `core.testnetChainId()` so the network is never a magic number.
|
|
132
|
+
|
|
133
|
+
```js
|
|
134
|
+
const { core } = require('@quantovainc/qcore');
|
|
135
|
+
|
|
136
|
+
const signed = JSON.parse(
|
|
137
|
+
core.signPayableCall(seed, 0n, contract, argsHex, nonce, meterLimit, fee, '1000', core.testnetChainId()),
|
|
138
|
+
);
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## The compiled core
|
|
142
|
+
|
|
143
|
+
The compiled core in this package is only the shipping form of the one Rust core, built so the same key derivation, signing, and wire code runs in a browser and in Node. It is not a virtual machine and it is not what the chain runs. The Quantova chain executes only the QVM, the container machine that runs contracts. The compiled core here is a client side build artifact and nothing more.
|
|
144
|
+
|
|
145
|
+
## TypeScript
|
|
146
|
+
|
|
147
|
+
The package ships TypeScript types in `index.d.ts`, so the Client, the core functions, and the Network helpers are all typed with no extra install.
|
|
148
|
+
|
|
149
|
+
## Builds
|
|
150
|
+
|
|
151
|
+
The package ships one guarded surface, the Client with the fee cap and the amount guard, over two
|
|
152
|
+
builds of the one core, and every default entry hands you that same Client. Node resolves to
|
|
153
|
+
the node entry, which loads the nodejs build from `pkg-node`, reads it from disk, needs no
|
|
154
|
+
experimental flag, works on every supported Node for both require and import, and is the build the tests
|
|
155
|
+
run against. A browser, or a bundler such as webpack or Vite, resolves through the exports map to the
|
|
156
|
+
browser entry, which wraps the bundler build in `pkg` in the identical Client, so a browser wallet gets
|
|
157
|
+
the fee cap and the amount guard and never the bare signing functions.
|
|
158
|
+
|
|
159
|
+
The raw builds are still reachable on their own subpaths, `@quantovainc/qcore/pkg` for the bundler build
|
|
160
|
+
and `@quantovainc/qcore/pkg-node` for the nodejs build. Those export only the core.* functions, with no
|
|
161
|
+
Client, no fee cap, and no amount guard, and are for an advanced caller who assembles the fee comparison
|
|
162
|
+
alone. The default browser, import, node, and require resolutions never reach them.
|
|
163
|
+
|
|
164
|
+
To build both from source, run the two documented builds or `npm run build`.
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
wasm-pack build --target bundler --out-dir pkg
|
|
168
|
+
wasm-pack build --target nodejs --out-dir pkg-node
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
The offline test scripts run with `npm test`, and they need no network and no running gateway.
|
|
172
|
+
|
|
173
|
+
## Conformance vectors
|
|
174
|
+
|
|
175
|
+
The frozen conformance vectors live in the [conformance](conformance) folder of this repository. The address derivation is in `conformance/address.derivation.json`, the transfer in `conformance/transaction.transfer.json`, and the payable call in `conformance/transaction.payable.json`. The offline test `test-conformance.js` signs from these vectors and checks the binding matches them byte for byte, so a change that would move a signed transaction fails the test.
|
|
176
|
+
|
|
177
|
+
## Examples
|
|
178
|
+
|
|
179
|
+
The [examples](examples) folder holds a runnable quickstart that mirrors the one above. For fuller starters, see the Q-Scaffold and the Q-Forge repositories under the Quantova org, at https://github.com/Quantova/Q-Scaffold and https://github.com/Quantova/Q-Forge.
|
|
180
|
+
|
|
181
|
+
## Releases and provenance
|
|
182
|
+
|
|
183
|
+
Releases are published from CI by the publish workflow in `.github/workflows/publish.yml`, which runs on a pushed git tag. It builds the two wasm targets, runs the offline tests, and publishes with npm provenance, so the copy of the package on the registry carries a verified provenance badge that ties it to this exact public commit. Nothing is published to a registry without an explicit tag. This package handles a user's keys and a published version cannot be taken back.
|
|
184
|
+
|
|
185
|
+
For the provenance publish to run, the maintainer adds an `NPM_TOKEN` automation secret to the repository, or configures npm trusted publishing for the package so the workflow authenticates over OIDC with no stored token.
|
|
186
|
+
|
|
187
|
+
## Security
|
|
188
|
+
|
|
189
|
+
To report a vulnerability, see [SECURITY.md](SECURITY.md). Please report privately and not through a public issue.
|
|
190
|
+
|
|
191
|
+
## Ownership and license
|
|
192
|
+
|
|
193
|
+
QCore.js is built and owned by Quantova Inc, and the signing lives in one compiled core and is never rewritten in JavaScript. It carries none of the industry stack and inherits nothing from it. It is dual licensed under the Apache 2.0 and MIT licenses so any wallet, explorer, or service may build on it, and the copyright stays with Quantova Inc.
|