forked from ava-labs/hypersdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
fill_order.go
212 lines (188 loc) · 6.42 KB
/
fill_order.go
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
// Copyright (C) 2023, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package actions
import (
"context"
"github.com/ava-labs/avalanchego/ids"
smath "github.com/ava-labs/avalanchego/utils/math"
"github.com/ava-labs/avalanchego/vms/platformvm/warp"
"github.com/ava-labs/hypersdk/chain"
"github.com/ava-labs/hypersdk/codec"
"github.com/ava-labs/hypersdk/consts"
"github.com/ava-labs/hypersdk/examples/tokenvm/storage"
"github.com/ava-labs/hypersdk/state"
"github.com/ava-labs/hypersdk/utils"
)
var _ chain.Action = (*FillOrder)(nil)
type FillOrder struct {
// [Order] is the OrderID you wish to close.
Order ids.ID `json:"order"`
// [Owner] is the owner of the order and the recipient of the trade
// proceeds.
Owner codec.Address `json:"owner"`
// [In] is the asset that will be sent to the owner from the fill. We need to provide this to
// populate [StateKeys].
In ids.ID `json:"in"`
// [Out] is the asset that will be received from the fill. We need to provide this to
// populate [StateKeys].
Out ids.ID `json:"out"`
// [Value] is the max amount of [In] that will be swapped for [Out].
Value uint64 `json:"value"`
}
func (*FillOrder) GetTypeID() uint8 {
return fillOrderID
}
func (f *FillOrder) StateKeys(actor codec.Address, _ ids.ID) []string {
return []string{
string(storage.OrderKey(f.Order)),
string(storage.BalanceKey(f.Owner, f.In)),
string(storage.BalanceKey(actor, f.In)),
string(storage.BalanceKey(actor, f.Out)),
}
}
func (*FillOrder) StateKeysMaxChunks() []uint16 {
return []uint16{storage.OrderChunks, storage.BalanceChunks, storage.BalanceChunks, storage.BalanceChunks}
}
func (*FillOrder) OutputsWarpMessage() bool {
return false
}
func (f *FillOrder) Execute(
ctx context.Context,
_ chain.Rules,
mu state.Mutable,
_ int64,
actor codec.Address,
_ ids.ID,
_ bool,
) (bool, uint64, []byte, *warp.UnsignedMessage, error) {
exists, in, inTick, out, outTick, remaining, owner, err := storage.GetOrder(ctx, mu, f.Order)
if err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
if !exists {
return false, NoFillOrderComputeUnits, OutputOrderMissing, nil, nil
}
if owner != f.Owner {
return false, NoFillOrderComputeUnits, OutputWrongOwner, nil, nil
}
if in != f.In {
return false, NoFillOrderComputeUnits, OutputWrongIn, nil, nil
}
if out != f.Out {
return false, NoFillOrderComputeUnits, OutputWrongOut, nil, nil
}
if f.Value == 0 {
// This should be guarded via [Unmarshal] but we check anyways.
return false, NoFillOrderComputeUnits, OutputValueZero, nil, nil
}
if f.Value%inTick != 0 {
return false, NoFillOrderComputeUnits, OutputValueMisaligned, nil, nil
}
// Determine amount of [Out] counterparty will receive if the trade is
// successful.
outputAmount, err := smath.Mul64(outTick, f.Value/inTick)
if err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
if outputAmount == 0 {
// This should never happen because [f.Value] > 0
return false, NoFillOrderComputeUnits, OutputInsufficientOutput, nil, nil
}
var (
inputAmount = f.Value
shouldDelete = false
orderRemaining uint64
)
switch {
case outputAmount > remaining:
// Calculate correct input given remaining supply
//
// This may happen if 2 people try to trade the same order at once.
blocksOver := (outputAmount - remaining) / outTick
inputAmount -= blocksOver * inTick
// If the [outputAmount] is greater than remaining, take what is left.
outputAmount = remaining
shouldDelete = true
case outputAmount == remaining:
// If the [outputAmount] is equal to remaining, take all of it.
shouldDelete = true
default:
orderRemaining = remaining - outputAmount
}
if inputAmount == 0 {
// Don't allow free trades (can happen due to refund rounding)
return false, NoFillOrderComputeUnits, OutputInsufficientInput, nil, nil
}
if err := storage.SubBalance(ctx, mu, actor, f.In, inputAmount); err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
if err := storage.AddBalance(ctx, mu, f.Owner, f.In, inputAmount, true); err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
if err := storage.AddBalance(ctx, mu, actor, f.Out, outputAmount, true); err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
if shouldDelete {
if err := storage.DeleteOrder(ctx, mu, f.Order); err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
} else {
if err := storage.SetOrder(ctx, mu, f.Order, in, inTick, out, outTick, orderRemaining, owner); err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
}
or := &OrderResult{In: inputAmount, Out: outputAmount, Remaining: orderRemaining}
output, err := or.Marshal()
if err != nil {
return false, NoFillOrderComputeUnits, utils.ErrBytes(err), nil, nil
}
return true, FillOrderComputeUnits, output, nil, nil
}
func (*FillOrder) MaxComputeUnits(chain.Rules) uint64 {
return FillOrderComputeUnits
}
func (*FillOrder) Size() int {
return consts.IDLen*3 + codec.AddressLen + consts.Uint64Len
}
func (f *FillOrder) Marshal(p *codec.Packer) {
p.PackID(f.Order)
p.PackAddress(f.Owner)
p.PackID(f.In)
p.PackID(f.Out)
p.PackUint64(f.Value)
}
func UnmarshalFillOrder(p *codec.Packer, _ *warp.Message) (chain.Action, error) {
var fill FillOrder
p.UnpackID(true, &fill.Order)
p.UnpackAddress(&fill.Owner)
p.UnpackID(false, &fill.In) // empty ID is the native asset
p.UnpackID(false, &fill.Out) // empty ID is the native asset
fill.Value = p.UnpackUint64(true)
return &fill, p.Err()
}
func (*FillOrder) ValidRange(chain.Rules) (int64, int64) {
// Returning -1, -1 means that the action is always valid.
return -1, -1
}
// OrderResult is a custom successful response output that provides information
// about a successful trade.
type OrderResult struct {
In uint64 `json:"in"`
Out uint64 `json:"out"`
Remaining uint64 `json:"remaining"`
}
func UnmarshalOrderResult(b []byte) (*OrderResult, error) {
p := codec.NewReader(b, consts.Uint64Len*3)
var result OrderResult
result.In = p.UnpackUint64(true)
result.Out = p.UnpackUint64(true)
result.Remaining = p.UnpackUint64(false) // if 0, deleted
return &result, p.Err()
}
func (o *OrderResult) Marshal() ([]byte, error) {
p := codec.NewWriter(consts.Uint64Len*3, consts.Uint64Len*3)
p.PackUint64(o.In)
p.PackUint64(o.Out)
p.PackUint64(o.Remaining)
return p.Bytes(), p.Err()
}