-
Notifications
You must be signed in to change notification settings - Fork 0
/
gridiron.go
414 lines (375 loc) · 12.9 KB
/
gridiron.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
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
package gridiron
import (
"context"
"encoding/json"
"fmt"
"strconv"
"github.com/cosmos/cosmos-sdk/codec"
cdctypes "github.com/cosmos/cosmos-sdk/codec/types"
cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
"github.com/gridfoundation/cosmosclient/cosmosclient"
rollapptypes "github.com/gridfoundation/gridiron/x/rollapp/types"
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
sequencertypes "github.com/gridfoundation/gridiron/x/sequencer/types"
"github.com/gridfoundation/furyint/da"
"github.com/gridfoundation/furyint/log"
"github.com/gridfoundation/furyint/settlement"
"github.com/gridfoundation/furyint/types"
"github.com/hashicorp/go-multierror"
"github.com/ignite/cli/ignite/pkg/cosmosaccount"
"github.com/tendermint/tendermint/libs/pubsub"
ctypes "github.com/tendermint/tendermint/rpc/core/types"
)
const (
addressPrefix = "fury"
furyRollappVersion = 0
defaultNodeAddress = "http://localhost:26657"
defaultGasLimit = 300000
)
const (
eventStateUpdate = "state_update.rollapp_id='%s'"
eventSequencersListUpdate = "sequencers_list_update.rollapp_id='%s'"
)
// LayerClient is intended only for usage in tests.
type LayerClient struct {
*settlement.BaseLayerClient
}
// Config for the GridironLayerClient
type Config struct {
KeyringBackend cosmosaccount.KeyringBackend `json:"keyring_backend"`
NodeAddress string `json:"node_address"`
KeyRingHomeDir string `json:"keyring_home_dir"`
FuryAccountName string `json:"fury_account_name"`
RollappID string `json:"rollapp_id"`
GasLimit uint64 `json:"gas_limit"`
GasPrices string `json:"gas_prices"`
GasFees string `json:"gas_fees"`
}
var _ settlement.LayerClient = &LayerClient{}
// Init is called once. it initializes the struct members.
func (dlc *LayerClient) Init(config []byte, pubsub *pubsub.Server, logger log.Logger, options ...settlement.Option) error {
GridironCosmosClient, err := newGridironHubClient(config, pubsub, logger)
if err != nil {
return err
}
baseOptions := []settlement.Option{
settlement.WithHubClient(GridironCosmosClient),
}
if options == nil {
options = baseOptions
} else {
options = append(baseOptions, options...)
}
dlc.BaseLayerClient = &settlement.BaseLayerClient{}
err = dlc.BaseLayerClient.Init(config, pubsub, logger, options...)
if err != nil {
return err
}
return nil
}
// PostBatchResp is the response after posting a batch to the Gridiron Hub.
type PostBatchResp struct {
resp cosmosclient.Response
}
// GetTxHash returns the transaction hash.
func (d PostBatchResp) GetTxHash() string {
return d.resp.TxHash
}
// GetCode returns the response code.
func (d PostBatchResp) GetCode() uint32 {
return uint32(d.resp.Code)
}
// HubClient is the client for the Gridiron Hub.
type HubClient struct {
config *Config
logger log.Logger
pubsub *pubsub.Server
client CosmosClient
ctx context.Context
cancel context.CancelFunc
rollappQueryClient rollapptypes.QueryClient
sequencerQueryClient sequencertypes.QueryClient
protoCodec *codec.ProtoCodec
eventMap map[string]string
}
var _ settlement.HubClient = &HubClient{}
// Option is a function that configures the HubClient.
type Option func(*HubClient)
// WithCosmosClient is an option that sets the CosmosClient.
func WithCosmosClient(cosmosClient CosmosClient) Option {
return func(d *HubClient) {
d.client = cosmosClient
}
}
func newGridironHubClient(config []byte, pubsub *pubsub.Server, logger log.Logger, options ...Option) (*HubClient, error) {
conf, err := getConfig(config)
if err != nil {
return nil, err
}
ctx, cancel := context.WithCancel(context.Background())
eventMap := map[string]string{
fmt.Sprintf(eventStateUpdate, conf.RollappID): settlement.EventNewSettlementBatchAccepted,
fmt.Sprintf(eventSequencersListUpdate, conf.RollappID): settlement.EventSequencersListUpdated,
}
interfaceRegistry := cdctypes.NewInterfaceRegistry()
cryptocodec.RegisterInterfaces(interfaceRegistry)
protoCodec := codec.NewProtoCodec(interfaceRegistry)
furyesionHubClient := &HubClient{
config: conf,
logger: logger,
pubsub: pubsub,
ctx: ctx,
cancel: cancel,
eventMap: eventMap,
protoCodec: protoCodec,
}
for _, option := range options {
option(furyesionHubClient)
}
if furyesionHubClient.client == nil {
client, err := cosmosclient.New(
ctx,
getCosmosClientOptions(conf)...,
)
if err != nil {
return nil, err
}
furyesionHubClient.client = NewCosmosClient(client)
}
furyesionHubClient.rollappQueryClient = furyesionHubClient.client.GetRollappClient()
furyesionHubClient.sequencerQueryClient = furyesionHubClient.client.GetSequencerClient()
return furyesionHubClient, nil
}
func decodeConfig(config []byte) (*Config, error) {
var c Config
err := json.Unmarshal(config, &c)
return &c, err
}
func getConfig(config []byte) (*Config, error) {
var c *Config
if len(config) > 0 {
var err error
c, err = decodeConfig(config)
if err != nil {
return nil, err
}
} else {
c = &Config{
KeyringBackend: cosmosaccount.KeyringTest,
NodeAddress: defaultNodeAddress,
}
}
return c, nil
}
// Start starts the HubClient.
func (d *HubClient) Start() error {
err := d.client.StartEventListener()
if err != nil {
return err
}
go d.eventHandler()
return nil
}
// Stop stops the HubClient.
func (d *HubClient) Stop() error {
err := d.client.StopEventListener()
if err != nil {
return err
}
d.cancel()
return nil
}
// PostBatch posts a batch to the Gridiron Hub.
func (d *HubClient) PostBatch(batch *types.Batch, daClient da.Client, daResult *da.ResultSubmitBatch) (settlement.PostBatchResp, error) {
msgUpdateState, err := d.convertBatchToMsgUpdateState(batch, daClient, daResult)
if err != nil {
return nil, err
}
txResp, err := d.client.BroadcastTx(d.config.FuryAccountName, msgUpdateState)
if err != nil || txResp.Code != 0 {
d.logger.Error("Error sending batch to settlement layer", "error", err)
return PostBatchResp{resp: txResp}, err
}
return PostBatchResp{resp: txResp}, nil
}
// GetLatestBatch returns the latest batch from the Gridiron Hub.
func (d *HubClient) GetLatestBatch(rollappID string) (*settlement.ResultRetrieveBatch, error) {
latestStateInfoIndexResp, err := d.rollappQueryClient.LatestStateInfoIndex(d.ctx,
&rollapptypes.QueryGetLatestStateInfoIndexRequest{RollappId: d.config.RollappID})
if latestStateInfoIndexResp == nil {
return nil, settlement.ErrBatchNotFound
}
if err != nil {
return nil, err
}
latestBatch, err := d.GetBatchAtIndex(rollappID, latestStateInfoIndexResp.LatestStateInfoIndex.Index)
if err != nil {
return nil, err
}
return latestBatch, nil
}
// GetBatchAtIndex returns the batch at the given index from the Gridiron Hub.
func (d *HubClient) GetBatchAtIndex(rollappID string, index uint64) (*settlement.ResultRetrieveBatch, error) {
stateInfoResp, err := d.rollappQueryClient.StateInfo(d.ctx,
&rollapptypes.QueryGetStateInfoRequest{RollappId: d.config.RollappID, Index: index})
if stateInfoResp == nil {
return nil, settlement.ErrBatchNotFound
}
if err != nil {
return nil, err
}
return d.convertStateInfoToResultRetrieveBatch(&stateInfoResp.StateInfo)
}
// GetSequencers returns the sequence of the given rollapp.
func (d *HubClient) GetSequencers(rollappID string) ([]*types.Sequencer, error) {
sequencers, err := d.sequencerQueryClient.SequencersByRollapp(d.ctx, &sequencertypes.QueryGetSequencersByRollappRequest{RollappId: d.config.RollappID})
if err != nil {
return nil, settlement.ErrNoSequencerForRollapp
}
sequencersList := []*types.Sequencer{}
for _, sequencer := range sequencers.SequencerInfoList {
var pubKey cryptotypes.PubKey
err := d.protoCodec.UnpackAny(sequencer.Sequencer.FuryintPubKey, &pubKey)
if err != nil {
return nil, err
}
var status types.SequencerStatus
if sequencer.Status == sequencertypes.Proposer {
status = types.Proposer
} else {
status = types.Inactive
}
if err != nil {
return nil, err
}
sequencersList = append(sequencersList, &types.Sequencer{
PublicKey: pubKey,
Status: status,
})
}
return sequencersList, nil
}
func (d *HubClient) eventHandler() {
// TODO(omritoptix): eventsChannel should be a generic channel which is later filtered by the event type.
eventsChannel, err := d.client.SubscribeToEvents(context.Background(), "gridiron-client", fmt.Sprintf(eventStateUpdate, d.config.RollappID))
if err != nil {
panic("Error subscribing to events")
}
for {
select {
case <-d.ctx.Done():
return
case <-d.client.EventListenerQuit():
panic("Settlement WS disconnected")
case event := <-eventsChannel:
// Assert value is in map and publish it to the event bus
d.logger.Debug("Received event from settlement layer")
_, ok := d.eventMap[event.Query]
if !ok {
d.logger.Debug("Ignoring event. Type not supported", "event", event)
continue
}
eventData, err := d.getEventData(d.eventMap[event.Query], event)
if err != nil {
d.logger.Error("Failed to get event data", "err", err)
continue
}
err = d.pubsub.PublishWithEvents(d.ctx, eventData, map[string][]string{settlement.EventTypeKey: {d.eventMap[event.Query]}})
if err != nil {
d.logger.Error("Error publishing event", "err", err)
}
}
}
}
func (d *HubClient) convertBatchToMsgUpdateState(batch *types.Batch, daClient da.Client, daResult *da.ResultSubmitBatch) (*rollapptypes.MsgUpdateState, error) {
account, err := d.client.GetAccount(d.config.FuryAccountName)
if err != nil {
return nil, err
}
addr := account.Address(addressPrefix)
DAMetaData := &settlement.DAMetaData{
Height: daResult.DAHeight,
Client: daClient,
}
blockDescriptors := make([]rollapptypes.BlockDescriptor, len(batch.Blocks))
for index, block := range batch.Blocks {
blockDescriptor := rollapptypes.BlockDescriptor{
Height: block.Header.Height,
StateRoot: block.Header.AppHash[:],
// TODO(omritoptix): Change to a real ISR once supported
IntermediateStatesRoot: make([]byte, 32),
}
blockDescriptors[index] = blockDescriptor
}
settlementBatch := &rollapptypes.MsgUpdateState{
Creator: addr,
RollappId: d.config.RollappID,
StartHeight: batch.StartHeight,
NumBlocks: batch.EndHeight - batch.StartHeight + 1,
DAPath: DAMetaData.ToPath(),
Version: furyRollappVersion,
BDs: rollapptypes.BlockDescriptors{BD: blockDescriptors},
}
return settlementBatch, nil
}
func getCosmosClientOptions(config *Config) []cosmosclient.Option {
if config.GasLimit == 0 {
config.GasLimit = defaultGasLimit
}
options := []cosmosclient.Option{
cosmosclient.WithAddressPrefix(addressPrefix),
cosmosclient.WithNodeAddress(config.NodeAddress),
cosmosclient.WithGasFees(config.GasFees),
cosmosclient.WithGasLimit(config.GasLimit),
cosmosclient.WithGasPrices(config.GasPrices),
}
if config.KeyringBackend != "" {
options = append(options,
cosmosclient.WithKeyringBackend(config.KeyringBackend),
cosmosclient.WithHome(config.KeyRingHomeDir))
}
return options
}
func (d *HubClient) getEventData(eventType string, rawEventData ctypes.ResultEvent) (interface{}, error) {
switch eventType {
case settlement.EventNewSettlementBatchAccepted:
return d.convertToNewBatchEvent(rawEventData)
}
return nil, fmt.Errorf("event type %s not recognized", eventType)
}
func (d *HubClient) convertToNewBatchEvent(rawEventData ctypes.ResultEvent) (*settlement.EventDataNewSettlementBatchAccepted, error) {
var multiErr *multierror.Error
numBlocks, err := strconv.ParseInt(rawEventData.Events["state_update.num_blocks"][0], 10, 64)
multiErr = multierror.Append(multiErr, err)
startHeight, err := strconv.ParseInt(rawEventData.Events["state_update.start_height"][0], 10, 64)
multiErr = multierror.Append(multiErr, err)
stateIndex, err := strconv.ParseInt(rawEventData.Events["state_update.state_info_index"][0], 10, 64)
multiErr = multierror.Append(multiErr, err)
err = multiErr.ErrorOrNil()
if err != nil {
return nil, multiErr
}
endHeight := uint64(startHeight + numBlocks - 1)
NewBatchEvent := &settlement.EventDataNewSettlementBatchAccepted{
EndHeight: endHeight,
StateIndex: uint64(stateIndex),
}
return NewBatchEvent, nil
}
func (d *HubClient) convertStateInfoToResultRetrieveBatch(stateInfo *rollapptypes.StateInfo) (*settlement.ResultRetrieveBatch, error) {
daMetaData := &settlement.DAMetaData{}
daMetaData, err := daMetaData.FromPath(stateInfo.DAPath)
if err != nil {
return nil, err
}
batchResult := &settlement.Batch{
StartHeight: stateInfo.StartHeight,
EndHeight: stateInfo.StartHeight + stateInfo.NumBlocks - 1,
MetaData: &settlement.BatchMetaData{
DA: daMetaData,
},
}
return &settlement.ResultRetrieveBatch{
BaseResult: settlement.BaseResult{Code: settlement.StatusSuccess, StateIndex: stateInfo.StateInfoIndex.Index},
Batch: batchResult}, nil
}