-
Notifications
You must be signed in to change notification settings - Fork 4
/
signature.js
450 lines (416 loc) · 14.9 KB
/
signature.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/////////////////////////////////////////////////////////////////////////////////
// Copyright 2019 StarkWare Industries Ltd. //
// //
// Licensed under the Apache License, Version 2.0 (the "License"). //
// You may not use this file except in compliance with the License. //
// You may obtain a copy of the License at //
// //
// https://www.starkware.co/open-source-license/ //
// //
// Unless required by applicable law or agreed to in writing, //
// software distributed under the License is distributed on an "AS IS" BASIS, //
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. //
// See the License for the specific language governing permissions //
// and limitations under the License. //
/////////////////////////////////////////////////////////////////////////////////
const BN = require('bn.js');
const hash = require('hash.js');
const { curves: eCurves, ec: EllipticCurve } = require('elliptic');
const assert = require('assert');
const constantPointsHex = require('./constant_points.json');
// Equals 2**251 + 17 * 2**192 + 1.
const prime = new BN('800000000000011000000000000000000000000000000000000000000000001', 16);
// Equals 2**251. This value limits msgHash and the signature parts.
const maxEcdsaVal =
new BN('800000000000000000000000000000000000000000000000000000000000000', 16);
// Generate BN of used constants.
const zeroBn = new BN('0', 16);
const oneBn = new BN('1', 16);
const twoBn = new BN('2', 16);
const fourBn = new BN('4', 16);
const fiveBn = new BN('5', 16);
const twoPow22Bn = new BN('400000', 16);
const twoPow31Bn = new BN('80000000', 16);
const twoPow63Bn = new BN('8000000000000000', 16);
// Create a curve with stark curve parameters.
const starkEc = new EllipticCurve(
new eCurves.PresetCurve({
type: 'short',
prime: null,
p: prime,
a: '00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000001',
b: '06f21413 efbe40de 150e596d 72f7a8c5 609ad26c 15c915c1 f4cdfcb9 9cee9e89',
n: '08000000 00000010 ffffffff ffffffff b781126d cae7b232 1e66a241 adc64d2f',
hash: hash.sha256,
gRed: false,
g: constantPointsHex[1]
})
);
const constantPoints = constantPointsHex.map(coords => (
starkEc.curve.point(new BN(coords[0], 16), new BN(coords[1], 16))));
const shiftPoint = constantPoints[0];
/*
Checks that the string str start with '0x'.
*/
function hasHexPrefix(str) {
return str.substring(0, 2) === '0x';
}
/*
Asserts input is equal to or greater then lowerBound and lower then upperBound.
Assert message specifies inputName.
input, lowerBound, and upperBound should be of type BN.
inputName should be a string.
*/
function assertInRange(
input,
lowerBound,
upperBound,
inputName = ''
) {
const messageSuffix = inputName === '' ? 'invalid length' : `invalid ${inputName} length`;
assert(
input.gte(lowerBound) && input.lt(upperBound), `Message not signable, ${messageSuffix}.`
);
}
/*
Full specification of the hash function can be found here:
https://starkware.co/starkex/docs/signatures.html#pedersen-hash-function
shiftPoint was added for technical reasons to make sure the zero point on the elliptic curve does
not appear during the computation. constantPoints are multiples by powers of 2 of the constant
points defined in the documentation.
*/
function pedersen(input) {
let point = shiftPoint;
for (let i = 0; i < input.length; i++) {
let x = new BN(input[i], 16);
assert(x.gte(zeroBn) && x.lt(prime), 'Invalid input: ' + input[i]);
for (let j = 0; j < 252; j++) {
const pt = constantPoints[2 + i * 252 + j];
assert(!point.getX().eq(pt.getX()));
if (x.and(oneBn).toNumber() !== 0) {
point = point.add(pt);
}
x = x.shrn(1);
}
}
return point.getX().toString(16);
}
function hashMsg(
instructionTypeBn,
vault0Bn,
vault1Bn,
amount0Bn,
amount1Bn,
nonceBn,
expirationTimestampBn,
token0,
token1OrPubKey,
condition = null
) {
let packedMessage = instructionTypeBn;
packedMessage = packedMessage.ushln(31).add(vault0Bn);
packedMessage = packedMessage.ushln(31).add(vault1Bn);
packedMessage = packedMessage.ushln(63).add(amount0Bn);
packedMessage = packedMessage.ushln(63).add(amount1Bn);
packedMessage = packedMessage.ushln(31).add(nonceBn);
packedMessage = packedMessage.ushln(22).add(expirationTimestampBn);
let msgHash = null;
if (condition === null) {
msgHash = pedersen([
pedersen([token0, token1OrPubKey]), packedMessage.toString(16)
]);
} else {
msgHash = pedersen([
pedersen([
pedersen([token0, token1OrPubKey]), condition
]), packedMessage.toString(16)
]);
}
const msgHashBN = new BN(msgHash, 16);
assertInRange(msgHashBN, zeroBn, maxEcdsaVal, 'msgHash');
return msgHash;
}
/*
Serializes the order message in the canonical format expected by the verifier.
party_a sells amountSell coins of tokenSell from vaultSell.
party_a buys amountBuy coins of tokenBuy into vaultBuy.
Expected types:
---------------
vaultSell, vaultBuy - uint31 (as int)
amountSell, amountBuy - uint63 (as decimal string)
tokenSell, tokenBuy - uint256 field element strictly less than the prime (as hex string with 0x)
nonce - uint31 (as int)
expirationTimestamp - uint22 (as int).
*/
function getLimitOrderMsgHash(
vaultSell,
vaultBuy,
amountSell,
amountBuy,
tokenSell,
tokenBuy,
nonce,
expirationTimestamp
) {
assert(
hasHexPrefix(tokenSell) && hasHexPrefix(tokenBuy),
'Hex strings expected to be prefixed with 0x.'
);
const vaultSellBn = new BN(vaultSell);
const vaultBuyBn = new BN(vaultBuy);
const amountSellBn = new BN(amountSell, 10);
const amountBuyBn = new BN(amountBuy, 10);
const tokenSellBn = new BN(tokenSell.substring(2), 16);
const tokenBuyBn = new BN(tokenBuy.substring(2), 16);
const nonceBn = new BN(nonce);
const expirationTimestampBn = new BN(expirationTimestamp);
assertInRange(vaultSellBn, zeroBn, twoPow31Bn);
assertInRange(vaultBuyBn, zeroBn, twoPow31Bn);
assertInRange(amountSellBn, zeroBn, twoPow63Bn);
assertInRange(amountBuyBn, zeroBn, twoPow63Bn);
assertInRange(tokenSellBn, zeroBn, prime);
assertInRange(tokenBuyBn, zeroBn, prime);
assertInRange(nonceBn, zeroBn, twoPow31Bn);
assertInRange(expirationTimestampBn, zeroBn, twoPow22Bn);
const instructionType = zeroBn;
return hashMsg(
instructionType,
vaultSellBn,
vaultBuyBn,
amountSellBn,
amountBuyBn,
nonceBn,
expirationTimestampBn,
tokenSell.substring(2),
tokenBuy.substring(2)
);
}
/*
Serializes the transfer message in the canonical format expected by the verifier.
The sender transfer 'amount' coins of 'token' from vault with id senderVaultId to vault with id
receiverVaultId. The receiver's public key is receiverPublicKey.
If a condition is added, it is verified before executing the transfer. The format of the condition
is defined by the application.
Expected types:
---------------
amount - uint63 (as decimal string)
nonce - uint31 (as int)
senderVaultId uint31 (as int)
token - uint256 field element strictly less than the prime (as hex string with 0x)
receiverVaultId - uint31 (as int)
receiverPublicKey - uint256 field element strictly less than the prime (as hex string with 0x)
expirationTimestamp - uint22 (as int).
condition - uint256 field element strictly less than the prime (as hex string with 0x)
*/
function getTransferMsgHash(
amount,
nonce,
senderVaultId,
token,
receiverVaultId,
receiverPublicKey,
expirationTimestamp,
condition = null
) {
assert(
hasHexPrefix(token) && hasHexPrefix(receiverPublicKey) && (condition === null ||
hasHexPrefix(condition)), 'Hex strings expected to be prefixed with 0x.'
);
const amountBn = new BN(amount, 10);
const nonceBn = new BN(nonce);
const senderVaultIdBn = new BN(senderVaultId);
const tokenBn = new BN(token.substring(2), 16);
const receiverVaultIdBn = new BN(receiverVaultId);
const receiverPublicKeyBn = new BN(receiverPublicKey.substring(2), 16);
const expirationTimestampBn = new BN(expirationTimestamp);
assertInRange(amountBn, zeroBn, twoPow63Bn);
assertInRange(nonceBn, zeroBn, twoPow31Bn);
assertInRange(senderVaultIdBn, zeroBn, twoPow31Bn);
assertInRange(tokenBn, zeroBn, prime);
assertInRange(receiverVaultIdBn, zeroBn, twoPow31Bn);
assertInRange(receiverPublicKeyBn, zeroBn, prime);
assertInRange(expirationTimestampBn, zeroBn, twoPow22Bn);
let instructionType = oneBn;
if (condition !== null) {
condition = condition.substring(2);
assertInRange(new BN(condition), zeroBn, prime, 'condition');
instructionType = twoBn;
}
return hashMsg(
instructionType,
senderVaultIdBn,
receiverVaultIdBn,
amountBn,
zeroBn,
nonceBn,
expirationTimestampBn,
token.substring(2),
receiverPublicKey.substring(2),
condition
);
}
function hashTransfeMsg(
instructionTypeBn,
vault0Bn,
vault1Bn,
feeVault1Bn,
amountBn,
feeAmountBn,
nonceBn,
expirationTimestampBn,
token0,
feeToken,
receiverPublicKey,
condition = null
) {
let w4Message = vault0Bn
.ushln(64).add(vault1Bn)
.ushln(64).add(feeVault1Bn)
.ushln(32).add(nonceBn)
w4Message = w4Message.toString(16, 251)
let w5Message = instructionTypeBn
.ushln(64).add(amountBn)
.ushln(64).add(feeAmountBn)
.ushln(32).add(expirationTimestampBn)
.ushln(81)
w5Message = w5Message.toString(16, 251)
const wordsToHash = [
token0,
feeToken,
receiverPublicKey,
// Condition fact is w6
...(!condition
? []
: [pedersen([condition.factRegistryAddress, condition.fact])]),
w4Message,
w5Message
]
const msgHash = wordsToHash.reduce((prevHash, component) =>
!prevHash
? component
: pedersen([prevHash, component])
)
const msgHashBN = new BN(msgHash, 16);
assertInRange(msgHashBN, zeroBn, maxEcdsaVal, 'msgHash');
return msgHash;
}
function getTransferWithFeesMsgHash(
amount,
feeAmount,
nonce,
senderVaultId,
token,
feeToken,
receiverVaultId,
feeVaultId,
receiverPublicKey,
expirationTimestamp,
condition = null
) {
assert(
hasHexPrefix(token) && hasHexPrefix(feeToken) &&
hasHexPrefix(receiverPublicKey)
);
const amountBn = new BN(amount, 10);
const feeAmountBn = new BN(feeAmount, 10);
const nonceBn = new BN(nonce);
const senderVaultIdBn = new BN(senderVaultId);
const tokenBn = new BN(token.substring(2), 16);
const feeTokenBn = new BN(feeToken.substring(2), 16);
const receiverVaultIdBn = new BN(receiverVaultId);
const feeVaultIdBn = new BN(feeVaultId);
const receiverPublicKeyBn = new BN(receiverPublicKey.substring(2), 16);
const expirationTimestampBn = new BN(expirationTimestamp);
assertInRange(amountBn, zeroBn, twoPow63Bn);
assertInRange(feeAmountBn, zeroBn, twoPow63Bn);
assertInRange(nonceBn, zeroBn, twoPow31Bn);
assertInRange(senderVaultIdBn, zeroBn, twoPow31Bn);
assertInRange(tokenBn, zeroBn, prime);
assertInRange(feeTokenBn, zeroBn, prime);
assertInRange(receiverVaultIdBn, zeroBn, twoPow31Bn);
assertInRange(feeVaultIdBn, zeroBn, twoPow31Bn);
assertInRange(receiverPublicKeyBn, zeroBn, prime);
assertInRange(expirationTimestampBn, zeroBn, twoPow22Bn);
let instructionType = fourBn;
if (condition !== null) {
// { fact, factRegistryAddress }
const { fact, factRegistryAddress } = condition
condition = { fact, factRegistryAddress: factRegistryAddress.substring(2) }
instructionType = fiveBn;
}
// Hash it
return hashTransfeMsg(
instructionType,
senderVaultIdBn,
receiverVaultIdBn,
feeVaultIdBn,
amountBn,
feeAmountBn,
nonceBn,
expirationTimestampBn,
token.substring(2),
feeToken.substring(2),
receiverPublicKey.substring(2),
condition
);
}
/*
The function _truncateToN in lib/elliptic/ec/index.js does a shift-right of delta bits,
if delta is positive, where
delta = msgHash.byteLength() * 8 - starkEx.n.bitLength().
This function does the opposite operation so that
_truncateToN(fixMsgHashLen(msgHash)) == msgHash.
*/
function fixMsgHashLen(msgHash) {
// Convert to BN to remove leading zeros.
msgHash = new BN(msgHash, 16).toString(16);
if (msgHash.length <= 62) {
// In this case, msgHash should not be transformed, as the byteLength() is at most 31,
// so delta < 0 (see _truncateToN).
return msgHash;
}
assert(msgHash.length === 63);
// In this case delta will be 4 so we perform a shift-left of 4 bits by adding a zero.
return msgHash + '0';
}
/*
Signs a message using the provided key.
privateKey should be an elliptic.keyPair with a valid private key.
Returns an elliptic.Signature.
*/
function sign(privateKey, msgHash) {
const msgHashBN = new BN(msgHash, 16);
// Verify message hash has valid length.
assertInRange(msgHashBN, zeroBn, maxEcdsaVal, 'msgHash');
const msgSignature = privateKey.sign(fixMsgHashLen(msgHash));
const { r, s } = msgSignature;
const w = s.invm(starkEc.n);
// Verify signature has valid length.
assertInRange(r, oneBn, maxEcdsaVal, 'r');
assertInRange(s, oneBn, starkEc.n, 's');
assertInRange(w, oneBn, maxEcdsaVal, 'w');
return msgSignature;
}
/*
Verifies a message using the provided key.
publicKey should be an elliptic.keyPair with a valid public key.
msgSignature should be an elliptic.Signature.
Returns a boolean true if the verification succeeds.
*/
function verify(publicKey, msgHash, msgSignature) {
const msgHashBN = new BN(msgHash, 16);
// Verify message hash has valid length.
assertInRange(msgHashBN, zeroBn, maxEcdsaVal, 'msgHash');
const { r, s } = msgSignature;
const w = s.invm(starkEc.n);
// Verify signature has valid length.
assertInRange(r, oneBn, maxEcdsaVal, 'r');
assertInRange(s, oneBn, starkEc.n, 's');
assertInRange(w, oneBn, maxEcdsaVal, 'w');
return publicKey.verify(fixMsgHashLen(msgHash), msgSignature);
}
module.exports = {
prime, ec: starkEc, constantPoints, shiftPoint, maxEcdsaVal, // Data.
getTransferWithFeesMsgHash, // With fee hash functions
pedersen, getLimitOrderMsgHash, getTransferMsgHash, sign, verify // Function.
};