-
Notifications
You must be signed in to change notification settings - Fork 2
/
Exchange.ts
566 lines (475 loc) · 16 KB
/
Exchange.ts
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
import { Token } from './Token.js'
import {
DeployArgs,
Field,
MerkleTree,
MerkleWitness,
Permissions,
Poseidon,
PrivateKey,
PublicKey,
Signature,
SmartContract,
State,
Struct,
UInt64,
method,
state,
} from 'o1js'
import { Vault } from './Vault.js'
// These are only for testing purposes.
export const AUTHORITY_PRIVATE_KEY = PrivateKey.fromBase58('EKEvp6bPR2D9BCQYPmKgTC9swtxok5JKQvsovNeffV7487SjkqPu')
export const AUTHORITY_PUBLIC_KEY = PublicKey.fromBase58('B62qqaK8H6CXjtFXMeHFk6WQxW7ynYiRMjCKKPCQimZCGucMTCzTj1i')
/**
* Creates the type of the object specifiying the layout of `Struct` from given type.
*
* So you can make sure that both types are the same.
*
* # Usage
*
* ```ts
* type UserObject = {
* name: Field
* age: UInt32
* }
*
* class User extends Struct({
* name: Field,
* age: UInt32,
* } satisfies StructLayout<UserObject>) {}
* ```
*/
type StructLayout<T> = {
[P in keyof T]: { new (...args: any[]): T[P] }
}
const FIELD_ZERO = Field.from(0)
export const ORDERS_HEIGHT = 10
export const PAIRS_HEIGHT = 10
export class OrderWitness extends MerkleWitness(ORDERS_HEIGHT) {}
export class PairWitness extends MerkleWitness(PAIRS_HEIGHT) {}
export enum Errors {
SameCurrencies = "A pair can't have the same currencies.",
PairAlreadyExists = 'The pair already exists.',
MistakenPair = 'The pair provided is mistaken.',
InvalidSignature = 'The authority signature is not valid.',
}
export function getErrorMessage(error: any): string {
const msg: string | undefined = error?.toString().split('Error: ').at(1)?.split('\n')[0]
if (typeof msg === 'undefined') {
console.error("Exchange conract's error message is unknown:")
console.error(error)
throw new Error("`getErrorMessage` function didn't work properly")
} else {
return msg
}
}
export type PairObject = {
baseCurrency: PublicKey
quoteCurrency: PublicKey
buyOrdersRoot: Field
sellOrdersRoot: Field
}
class Pair extends Struct({
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrdersRoot: Field,
sellOrdersRoot: Field,
} satisfies StructLayout<PairObject>) {
hash(): Field {
return Poseidon.hash([
...this.baseCurrency.toFields(),
...this.quoteCurrency.toFields(),
this.buyOrdersRoot,
this.sellOrdersRoot,
])
}
}
export type OrderObject = {
maker: PublicKey
amount: UInt64
price: UInt64
}
class Order extends Struct({
maker: PublicKey,
amount: UInt64,
price: UInt64,
} satisfies StructLayout<OrderObject>) {
hash(): Field {
return Poseidon.hash([...this.maker.toFields(), ...this.amount.toFields(), ...this.price.toFields()])
}
}
/**
* An order book decentralized exchange that allows trading of tokens.
*/
export class Exchange extends SmartContract {
/**
* Root of the merkle tree that stores all the pairs.
*/
@state(Field) root = State<Field>()
/**
* Hash of the public key of the authority.
*/
@state(PublicKey) authority = State<PublicKey>()
deploy(args?: DeployArgs) {
super.deploy(args)
this.account.permissions.set({
...Permissions.default(),
editState: Permissions.proofOrSignature(),
editActionState: Permissions.proofOrSignature(),
incrementNonce: Permissions.proofOrSignature(),
setVerificationKey: Permissions.none(),
setPermissions: Permissions.proofOrSignature(),
send: Permissions.proof(),
})
}
initialize(authority: PublicKey) {
this.authority.requireEquals(PublicKey.empty())
this.root.set(new MerkleTree(PAIRS_HEIGHT).getRoot())
this.authority.set(authority)
}
/**
* Creates a new pair.
*/
@method createPair(
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
pairWitness: PairWitness,
authoritySignature: Signature
) {
baseCurrency.equals(quoteCurrency).assertFalse(Errors.SameCurrencies)
const pairsRoot = pairWitness.calculateRoot(FIELD_ZERO)
this.root.getAndRequireEquals().assertEquals(pairsRoot, Errors.PairAlreadyExists)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const emptyRoot = new MerkleTree(ORDERS_HEIGHT).getRoot()
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot: emptyRoot,
sellOrdersRoot: emptyRoot,
})
const newPairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.set(newPairsRoot)
}
/**
* Places a BUY order.
*/
@method placeBuyOrder(
amount: UInt64,
price: UInt64,
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrderWitness: OrderWitness,
sellOrdersRoot: Field,
pairWitness: PairWitness,
authoritySignature: Signature
) {
const buyOrdersRoot = buyOrderWitness.calculateRoot(FIELD_ZERO)
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot,
})
const pairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.getAndRequireEquals().assertEquals(pairsRoot, Errors.MistakenPair)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...amount.toFields(),
...price.toFields(),
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...sellOrdersRoot.toFields(),
...buyOrderWitness.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const quoteToken = new Token(quoteCurrency)
quoteToken.transfer(this.sender, this.address, amount.mul(price))
const order = new Order({
maker: this.sender,
amount,
price,
})
const newBuyOrdersRoot = buyOrderWitness.calculateRoot(order.hash())
const newPair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot: newBuyOrdersRoot,
sellOrdersRoot,
})
const newPairsRoot = pairWitness.calculateRoot(newPair.hash())
this.root.set(newPairsRoot)
}
/**
* Places a SELL order.
*/
@method placeSellOrder(
amount: UInt64,
price: UInt64,
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrdersRoot: Field,
sellOrderWitness: OrderWitness,
pairWitness: PairWitness,
authoritySignature: Signature
) {
const sellOrdersRoot = sellOrderWitness.calculateRoot(FIELD_ZERO)
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot,
})
const pairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.getAndRequireEquals().assertEquals(pairsRoot, Errors.MistakenPair)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...amount.toFields(),
...price.toFields(),
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...buyOrdersRoot.toFields(),
...sellOrderWitness.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const baseToken = new Token(baseCurrency)
baseToken.transfer(this.sender, this.address, amount)
const order = new Order({
maker: this.sender,
amount,
price,
})
const newSellOrdersRoot = sellOrderWitness.calculateRoot(order.hash())
const newPair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot: newSellOrdersRoot,
})
const newPairsRoot = pairWitness.calculateRoot(newPair.hash())
this.root.set(newPairsRoot)
}
/**
* Cancels a BUY order.
*/
@method cancelBuyOrder(
amount: UInt64,
price: UInt64,
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrderWitness: OrderWitness,
sellOrdersRoot: Field,
pairWitness: PairWitness,
authoritySignature: Signature
) {
const order = new Order({
maker: this.sender,
amount,
price,
})
const buyOrdersRoot = buyOrderWitness.calculateRoot(order.hash())
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot: buyOrdersRoot,
sellOrdersRoot,
})
const pairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.getAndRequireEquals().assertEquals(pairsRoot, Errors.MistakenPair)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...amount.toFields(),
...price.toFields(),
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...sellOrdersRoot.toFields(),
...buyOrderWitness.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const quoteToken = new Token(quoteCurrency)
const vault = new Vault(this.address, quoteToken.token.id)
vault.decrementBalance(amount.mul(price))
quoteToken.approveUpdateAndTransfer(vault.self, this.sender, amount.mul(price))
const newBuyOrdersRoot = buyOrderWitness.calculateRoot(FIELD_ZERO)
const newPair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot: newBuyOrdersRoot,
sellOrdersRoot,
})
const newPairsRoot = pairWitness.calculateRoot(newPair.hash())
this.root.set(newPairsRoot)
}
/**
* Cancels a SELL order.
*/
@method cancelSellOrder(
amount: UInt64,
price: UInt64,
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrdersRoot: Field,
sellOrderWitness: OrderWitness,
pairWitness: PairWitness,
authoritySignature: Signature
) {
const order = new Order({
maker: this.sender,
amount,
price,
})
const sellOrdersRoot = sellOrderWitness.calculateRoot(order.hash())
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot: sellOrdersRoot,
})
const pairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.getAndRequireEquals().assertEquals(pairsRoot, Errors.MistakenPair)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...amount.toFields(),
...price.toFields(),
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...buyOrdersRoot.toFields(),
...sellOrderWitness.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const baseToken = new Token(baseCurrency)
const vault = new Vault(this.address, baseToken.token.id)
vault.decrementBalance(amount)
baseToken.approveUpdateAndTransfer(vault.self, this.sender, amount)
const newSellOrdersRoot = sellOrderWitness.calculateRoot(FIELD_ZERO)
const newPair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot: newSellOrdersRoot,
})
const newPairsRoot = pairWitness.calculateRoot(newPair.hash())
this.root.set(newPairsRoot)
}
/**
* Executes given BUY order.
*/
@method executeBuyOrder(
maker: PublicKey,
amount: UInt64,
price: UInt64,
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrderWitness: OrderWitness,
sellOrdersRoot: Field,
pairWitness: PairWitness,
authoritySignature: Signature
) {
const order = new Order({
amount,
price,
maker,
})
const buyOrdersRoot = buyOrderWitness.calculateRoot(order.hash())
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot,
})
const pairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.getAndRequireEquals().assertEquals(pairsRoot, Errors.MistakenPair)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...maker.toFields(),
...amount.toFields(),
...price.toFields(),
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...sellOrdersRoot.toFields(),
...buyOrderWitness.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const baseToken = new Token(baseCurrency)
const quoteToken = new Token(quoteCurrency)
baseToken.transfer(this.sender, maker, amount)
const vault = new Vault(this.address, quoteToken.token.id)
vault.decrementBalance(amount.mul(price))
quoteToken.approveUpdateAndTransfer(vault.self, this.sender, amount.mul(price))
const newBuyOrdersRoot = buyOrderWitness.calculateRoot(FIELD_ZERO)
const newPair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot: newBuyOrdersRoot,
sellOrdersRoot,
})
const newPairsRoot = pairWitness.calculateRoot(newPair.hash())
this.root.set(newPairsRoot)
}
/**
* Executes given SELL order.
*/
@method executeSellOrder(
maker: PublicKey,
amount: UInt64,
price: UInt64,
baseCurrency: PublicKey,
quoteCurrency: PublicKey,
buyOrdersRoot: Field,
sellOrderWitness: OrderWitness,
pairWitness: PairWitness,
authoritySignature: Signature
) {
const order = new Order({
amount,
price,
maker,
})
const sellOrdersRoot = sellOrderWitness.calculateRoot(order.hash())
const pair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot,
})
const pairsRoot = pairWitness.calculateRoot(pair.hash())
this.root.requireEquals(pairsRoot)
authoritySignature
.verify(this.authority.getAndRequireEquals(), [
...maker.toFields(),
...amount.toFields(),
...price.toFields(),
...baseCurrency.toFields(),
...quoteCurrency.toFields(),
...buyOrdersRoot.toFields(),
...sellOrderWitness.toFields(),
...pairWitness.toFields(),
])
.assertTrue(Errors.InvalidSignature)
const quoteToken = new Token(quoteCurrency)
const baseToken = new Token(baseCurrency)
quoteToken.transfer(this.sender, maker, amount.mul(price))
const vault = new Vault(this.address, baseToken.token.id)
vault.decrementBalance(amount)
baseToken.approveUpdateAndTransfer(vault.self, this.sender, amount)
const newSellOrdersRoot = sellOrderWitness.calculateRoot(FIELD_ZERO)
const newPair = new Pair({
baseCurrency,
quoteCurrency,
buyOrdersRoot,
sellOrdersRoot: newSellOrdersRoot,
})
const newPairsRoot = pairWitness.calculateRoot(newPair.hash())
this.root.set(newPairsRoot)
}
}