-
Notifications
You must be signed in to change notification settings - Fork 0
/
gwrelayer.go
414 lines (350 loc) · 13.5 KB
/
gwrelayer.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
// The GatewayRelayer manages the interface to the ibcTranslator smart contract on deltachain. It is called when a signed VAA with quorum gets published.
// It forwards all payload three VAAs destined for the ibcTranslator contract on deltachain to that contract.
package gwrelayer
import (
"context"
"encoding/hex"
"encoding/json"
"fmt"
"strings"
"time"
"github.com/deltaswapio/deltaswap/node/pkg/common"
"github.com/deltaswapio/deltaswap/node/pkg/supervisor"
"github.com/deltaswapio/deltaswap/sdk"
"github.com/deltaswapio/deltaswap/sdk/vaa"
wasmdtypes "github.com/CosmWasm/wasmd/x/wasm/types"
sdktypes "github.com/cosmos/cosmos-sdk/types"
sdktx "github.com/cosmos/cosmos-sdk/types/tx"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"go.uber.org/zap"
)
type (
GatewayRelayerDeltachainConn interface {
Close()
SenderAddress() string
SubmitQuery(ctx context.Context, contractAddress string, query []byte) ([]byte, error)
SignAndBroadcastTx(ctx context.Context, msg sdktypes.Msg) (*sdktx.BroadcastTxResponse, error)
BroadcastTxResponseToString(txResp *sdktx.BroadcastTxResponse) string
}
)
// GatewayRelayer is the object that manages the interface to the deltachain accountant smart contract.
type (
GatewayRelayer struct {
ctx context.Context
logger *zap.Logger
ibcTranslatorAddress string
deltachainConn GatewayRelayerDeltachainConn
env common.Environment
subChan chan *VaaToPublish
tokenBridges tokenBridgeMap
tokenBridgeAddress string
ibcTranslatorPayloadAddress vaa.Address
}
tokenBridgeMap map[tokenBridgeKey]struct{}
tokenBridgeKey struct {
emitterChainId vaa.ChainID
emitterAddr vaa.Address
}
VaaToPublish struct {
V *vaa.VAA
ContractAddress string
VType VaaType
}
VaaType uint8
)
const (
IbcTranslator VaaType = iota
TokenBridge
)
// subChanSize is the capacity of the submit channel used to publish VAAs.
const subChanSize = 50
var (
vaasSubmittedToIbcTranslator = promauto.NewCounter(
prometheus.CounterOpts{
Name: "gwrelayer_vaas_submitted_to_ibc_translator",
Help: "Total number of VAAs submitted to the ibc translator contract by the gateway relayer",
})
vaasSubmittedToTokenBridge = promauto.NewCounter(
prometheus.CounterOpts{
Name: "gwrelayer_vaas_submitted_to_token_bridge",
Help: "Total number of VAAs submitted to the token bridge contract by the gateway relayer",
})
channelFullErrors = promauto.NewCounter(
prometheus.CounterOpts{
Name: "gwrelayer_channel_full_errors",
Help: "Total number of VAAs dropped because the gateway relayer channel was full",
})
submitErrors = promauto.NewCounter(
prometheus.CounterOpts{
Name: "gwrelayer_submit_errors",
Help: "Total number of errors encountered while submitting VAAs",
})
)
// NewGatewayRelayer creates a new instance of the GatewayRelayer object.
func NewGatewayRelayer(
ctx context.Context,
logger *zap.Logger,
ibcTranslatorAddress string,
deltachainConn GatewayRelayerDeltachainConn,
env common.Environment,
) *GatewayRelayer {
if ibcTranslatorAddress == "" {
return nil // This is not an error, it just means the feature is not enabled.
}
return &GatewayRelayer{
ctx: ctx,
logger: logger.With(zap.String("component", "gwrelayer")),
ibcTranslatorAddress: ibcTranslatorAddress,
deltachainConn: deltachainConn,
env: env,
subChan: make(chan *VaaToPublish, subChanSize),
// tokenBridgeAddress and tokenBridges are initialized in Start().
}
}
// Start initializes the gateway relayer and starts the worker runnable that submits VAAs to the contract.
func (gwr *GatewayRelayer) Start(ctx context.Context) error {
var err error
gwr.ibcTranslatorPayloadAddress, err = convertBech32AddressToDeltaswap(gwr.ibcTranslatorAddress)
if err != nil {
return err
}
gwr.tokenBridges, gwr.tokenBridgeAddress, err = buildTokenBridgeMap(gwr.logger, gwr.env)
if err != nil {
return fmt.Errorf("failed to build token bridge map: %w", err)
}
if gwr.tokenBridgeAddress == "" {
return fmt.Errorf("failed to look up token bridge address for gateway")
}
gwr.logger.Info("starting gateway relayer",
zap.String("ibcTranslatorAddress", gwr.ibcTranslatorAddress),
zap.String("ibcTranslatorPayloadAddress", hex.EncodeToString(gwr.ibcTranslatorPayloadAddress.Bytes())),
zap.String("tokenBridgeAddress", gwr.tokenBridgeAddress),
)
// Start the watcher to listen to transfer events from the smart contract.
if gwr.env == common.GoTest {
// We're not in a runnable context, so we can't use supervisor.
go func() {
_ = gwr.worker(ctx)
}()
} else {
if err := supervisor.Run(ctx, "gwrworker", common.WrapWithScissors(gwr.worker, "gwrworker")); err != nil {
return fmt.Errorf("failed to start submit vaa worker: %w", err)
}
}
return nil
}
// buildTokenBridgeMap builds a set of all token bridge emitter chain / emitter addresses.
func buildTokenBridgeMap(logger *zap.Logger, env common.Environment) (tokenBridgeMap, string, error) {
emitterMap := sdk.KnownTokenbridgeEmitters
if env == common.TestNet {
emitterMap = sdk.KnownTestnetTokenbridgeEmitters
} else if env == common.UnsafeDevNet || env == common.GoTest || env == common.AccountantMock {
emitterMap = sdk.KnownDevnetTokenbridgeEmitters
}
// Build the map of token bridges to be monitored.
tokenBridges := make(tokenBridgeMap)
tokenBridgeAddress := ""
for chainId, emitterAddrBytes := range emitterMap {
if chainId == vaa.ChainIDDeltachain {
var err error
tokenBridgeAddress, err = sdktypes.Bech32ifyAddressBytes("deltaswap", emitterAddrBytes)
if err != nil {
return nil, "", fmt.Errorf(`failed to convert gateway emitter address "%s" to bech32: %v`, hex.EncodeToString(emitterAddrBytes), err)
}
// We don't want to forward stuff that originated on Gateway, so don't add it to the map.
continue
}
emitterAddr, err := vaa.BytesToAddress(emitterAddrBytes)
if err != nil {
return nil, "", fmt.Errorf("failed to convert emitter address for chain: %v", chainId)
}
tbk := tokenBridgeKey{emitterChainId: chainId, emitterAddr: emitterAddr}
_, exists := tokenBridges[tbk]
if exists {
return nil, "", fmt.Errorf("detected duplicate token bridge for chain: %v", chainId)
}
tokenBridges[tbk] = struct{}{}
logger.Info("will monitor token bridge:", zap.Stringer("emitterChainId", tbk.emitterChainId), zap.Stringer("emitterAddr", tbk.emitterAddr))
}
return tokenBridges, tokenBridgeAddress, nil
}
// Close closes the connection to the smart contract.
func (gwr *GatewayRelayer) Close() {
if gwr.deltachainConn != nil {
gwr.deltachainConn.Close()
gwr.deltachainConn = nil
}
}
// convertBech32AddressToDeltaswap converts a bech32 address to a deltaswap address.
func convertBech32AddressToDeltaswap(contractAddress string) (vaa.Address, error) {
addrBytes, err := sdktypes.GetFromBech32(contractAddress, "deltaswap")
if err != nil {
return vaa.Address{}, fmt.Errorf(`failed to decode target address "%s": %w`, contractAddress, err)
}
return vaa.Address(addrBytes), nil
}
// SubmitVAA checks to see if the VAA should be submitted to the smart contract, and if so, writes it to the channel for publishing.
func (gwr *GatewayRelayer) SubmitVAA(v *vaa.VAA) {
var v2p VaaToPublish
if shouldPub, err := shouldPublishToIbcTranslator(v.Payload, vaa.ChainIDDeltachain, gwr.ibcTranslatorPayloadAddress); err != nil {
gwr.logger.Error("failed to check if vaa should be published", zap.String("msgId", v.MessageID()), zap.Error(err))
return
} else if shouldPub {
v2p.VType = IbcTranslator
v2p.ContractAddress = gwr.ibcTranslatorAddress
} else if shouldPub = shouldPublishToTokenBridge(gwr.tokenBridges, v); shouldPub {
v2p.VType = TokenBridge
v2p.ContractAddress = gwr.tokenBridgeAddress
} else {
gwr.logger.Debug("not relaying vaa", zap.String("msgId", v.MessageID()))
return
}
v2p.V = v
select {
case gwr.subChan <- &v2p:
gwr.logger.Debug("submitted vaa to channel", zap.String("msgId", v.MessageID()), zap.String("contract", v2p.ContractAddress), zap.Uint8("vaaType", uint8(v2p.VType)))
default:
channelFullErrors.Inc()
gwr.logger.Error("unable to submit vaa because the channel is full, dropping it", zap.String("msgId", v.MessageID()), zap.String("contract", v2p.ContractAddress), zap.Uint8("vaaType", uint8(v2p.VType)))
}
}
// shouldPublishToIbcTranslator returns true if a message should be forwarded to the contract on deltachain, false if not.
func shouldPublishToIbcTranslator(payload []byte, targetChain vaa.ChainID, targetAddress vaa.Address) (bool, error) {
if len(payload) == 0 {
return false, nil
}
if payload[0] != 3 {
return false, nil
}
hdr, err := vaa.DecodeTransferPayloadHdr(payload)
if err != nil {
return false, fmt.Errorf("failed to decode payload: %w", err)
}
if hdr.TargetChain != targetChain || hdr.TargetAddress != targetAddress {
return false, nil
}
return true, nil
}
// shouldPublishToTokenBridge returns true if a message should be forwarded to the token bridge, false if not.
func shouldPublishToTokenBridge(tokenBridges tokenBridgeMap, v *vaa.VAA) bool {
if _, exists := tokenBridges[tokenBridgeKey{emitterChainId: v.EmitterChain, emitterAddr: v.EmitterAddress}]; !exists {
return false
}
if len(v.Payload) == 0 {
return false
}
// We only forward attestations (type two).
if v.Payload[0] != 2 {
return false
}
return true
}
// worker listens for VAAs and submits them to the smart contract.
func (gwr *GatewayRelayer) worker(ctx context.Context) error {
for {
select {
case <-ctx.Done():
return nil
case v2p := <-gwr.subChan:
if err := gwr.submitVAAToContract(v2p); err != nil {
gwr.logger.Error("failed to submit vaa to contract", zap.String("msgId", v2p.V.MessageID()), zap.String("contract", v2p.ContractAddress), zap.Uint8("vaaType", uint8(v2p.VType)), zap.Error(err))
// TODO: For now we don't want to restart because this will happen if the VAA has already been submitted by another phylax.
//return fmt.Errorf("failed to submit vaa to contract: %w", err)
}
}
}
}
// submitVAAToContract submits a VAA to the smart contract on deltachain.
func (gwr *GatewayRelayer) submitVAAToContract(v2p *VaaToPublish) error {
_, err := SubmitVAAToContract(gwr.ctx, gwr.logger, gwr.deltachainConn, v2p)
if err != nil {
submitErrors.Inc()
return err
}
if v2p.VType == IbcTranslator {
vaasSubmittedToIbcTranslator.Inc()
} else {
vaasSubmittedToTokenBridge.Inc()
}
return nil
}
type (
// completeTransferAndConvertMsg is used to submit a VAA to the IBC translator contract.
completeTransferAndConvertMsg struct {
Params completeTransferAndConvertParams `json:"complete_transfer_and_convert"`
}
completeTransferAndConvertParams struct {
VAA []byte `json:"vaa"`
}
// submitVAA is used to submit a VAA to the token bridge contract.
submitVAA struct {
Params submitVAAParams `json:"submit_vaa"`
}
submitVAAParams struct {
Data []byte `json:"data"`
}
)
// SubmitVAAToContract submits a VAA to the smart contract on deltachain.
func SubmitVAAToContract(
ctx context.Context,
logger *zap.Logger,
deltachainConn GatewayRelayerDeltachainConn,
v2p *VaaToPublish,
) (*sdktx.BroadcastTxResponse, error) {
logger.Info("submitting VAA to contract", zap.String("message_id", v2p.V.MessageID()), zap.String("contract", v2p.ContractAddress), zap.Uint8("vaaType", uint8(v2p.VType)))
vaaBytes, err := v2p.V.Marshal()
if err != nil {
return nil, fmt.Errorf("failed to marshal vaa: %w", err)
}
var msgBytes []byte
if v2p.VType == IbcTranslator {
msgData := completeTransferAndConvertMsg{
Params: completeTransferAndConvertParams{
VAA: vaaBytes,
},
}
msgBytes, err = json.Marshal(msgData)
} else if v2p.VType == TokenBridge {
msgData := submitVAA{
Params: submitVAAParams{
Data: vaaBytes,
},
}
msgBytes, err = json.Marshal(msgData)
} else {
return nil, fmt.Errorf("invalid vtype: %d", uint8(v2p.VType))
}
if err != nil {
return nil, fmt.Errorf("failed to marshal request: %w", err)
}
subMsg := wasmdtypes.MsgExecuteContract{
Sender: deltachainConn.SenderAddress(),
Contract: v2p.ContractAddress,
Msg: msgBytes,
Funds: sdktypes.Coins{},
}
start := time.Now()
txResp, err := deltachainConn.SignAndBroadcastTx(ctx, &subMsg)
if err != nil {
return txResp, fmt.Errorf("failed to send broadcast: %w", err)
}
if txResp == nil {
return txResp, fmt.Errorf("sent broadcast but returned txResp is nil")
}
if txResp.TxResponse == nil {
return txResp, fmt.Errorf("sent broadcast but returned txResp.TxResponse is nil")
}
if txResp.TxResponse.RawLog == "" {
return txResp, fmt.Errorf("sent broadcast but raw_log is not set, unable to analyze the result")
}
if strings.Contains(txResp.TxResponse.RawLog, "out of gas") {
return txResp, fmt.Errorf("out of gas: %s", txResp.TxResponse.RawLog)
}
if strings.Contains(txResp.TxResponse.RawLog, "failed") && !strings.Contains(txResp.TxResponse.RawLog, "VaaAlreadyExecuted") {
return txResp, fmt.Errorf("submit failed: %s", txResp.TxResponse.RawLog)
}
logger.Info("done sending broadcast", zap.String("msgId", v2p.V.MessageID()), zap.String("contract", v2p.ContractAddress), zap.Uint8("vaaType", uint8(v2p.VType)), zap.Int64("gasUsed", txResp.TxResponse.GasUsed), zap.Stringer("elapsedTime", time.Since(start)))
logger.Debug("in SubmitVAAToContract, done sending broadcast", zap.String("resp", deltachainConn.BroadcastTxResponseToString(txResp)))
return txResp, nil
}