-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #156 from ava-labs/off-chain-warp-messages
Off chain warp messages
- Loading branch information
Showing
20 changed files
with
682 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package offchainregistry | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common" | ||
| ) | ||
|
|
||
| type Config struct { | ||
| TeleporterRegistryAddress string `json:"teleporter-registry-address"` | ||
| } | ||
|
|
||
| func (c *Config) Validate() error { | ||
| if !common.IsHexAddress(c.TeleporterRegistryAddress) { | ||
| return fmt.Errorf("invalid address for TeleporterRegistry: %s", c.TeleporterRegistryAddress) | ||
| } | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| package offchainregistry | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/ava-labs/avalanchego/ids" | ||
| "github.com/ava-labs/avalanchego/utils/logging" | ||
| "github.com/ava-labs/avalanchego/vms/platformvm/warp" | ||
| warpPayload "github.com/ava-labs/avalanchego/vms/platformvm/warp/payload" | ||
| "github.com/ava-labs/awm-relayer/config" | ||
| "github.com/ava-labs/awm-relayer/vms" | ||
| "github.com/ava-labs/subnet-evm/accounts/abi/bind" | ||
| "github.com/ava-labs/subnet-evm/ethclient" | ||
| teleporterregistry "github.com/ava-labs/teleporter/abi-bindings/go/Teleporter/upgrades/TeleporterRegistry" | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| var ( | ||
| OffChainRegistrySourceAddress = common.HexToAddress("0x0000000000000000000000000000000000000000") | ||
| ) | ||
|
|
||
| const ( | ||
| addProtocolVersionGasLimit uint64 = 500_000 | ||
| revertVersionNotFoundString = "TeleporterRegistry: version not found" | ||
| ) | ||
|
|
||
| type messageManager struct { | ||
| logger logging.Logger | ||
| destinationClients map[ids.ID]vms.DestinationClient | ||
| registryAddress common.Address | ||
| } | ||
|
|
||
| func NewMessageManager( | ||
| logger logging.Logger, | ||
| messageProtocolConfig config.MessageProtocolConfig, | ||
| destinationClients map[ids.ID]vms.DestinationClient, | ||
| ) (*messageManager, error) { | ||
| // Marshal the map and unmarshal into the off-chain registry config | ||
| data, err := json.Marshal(messageProtocolConfig.Settings) | ||
| if err != nil { | ||
| logger.Error("Failed to marshal off-chain registry config") | ||
| return nil, err | ||
| } | ||
| var messageConfig Config | ||
| if err := json.Unmarshal(data, &messageConfig); err != nil { | ||
| logger.Error("Failed to unmarshal off-chain registry config") | ||
| return nil, err | ||
| } | ||
|
|
||
| if err := messageConfig.Validate(); err != nil { | ||
| logger.Error( | ||
| "Invalid off-chain registry config.", | ||
| zap.Error(err), | ||
| ) | ||
| return nil, err | ||
| } | ||
| return &messageManager{ | ||
| logger: logger, | ||
| destinationClients: destinationClients, | ||
| registryAddress: common.HexToAddress(messageConfig.TeleporterRegistryAddress), | ||
| }, nil | ||
| } | ||
|
|
||
| // ShouldSendMessage returns false if any contract is already registered as the specified version in the TeleporterRegistry contract. | ||
| // This is because a single contract address can be registered to multiple versions, but each version may only map to a single contract address. | ||
| func (m *messageManager) ShouldSendMessage(unsignedMessage *warp.UnsignedMessage, destinationBlockchainID ids.ID) (bool, error) { | ||
| addressedPayload, err := warpPayload.ParseAddressedCall(unsignedMessage.Payload) | ||
| if err != nil { | ||
| m.logger.Error( | ||
| "Failed parsing addressed payload", | ||
| zap.Error(err), | ||
| ) | ||
| return false, err | ||
| } | ||
| entry, destination, err := teleporterregistry.UnpackTeleporterRegistryWarpPayload(addressedPayload.Payload) | ||
| if err != nil { | ||
| m.logger.Error( | ||
| "Failed unpacking teleporter registry warp payload", | ||
| zap.Error(err), | ||
| ) | ||
| return false, err | ||
| } | ||
| if destination != m.registryAddress { | ||
| m.logger.Info( | ||
| "Message is not intended for the configured registry", | ||
| zap.String("destination", destination.String()), | ||
| zap.String("configuredRegistry", m.registryAddress.String()), | ||
| ) | ||
| return false, nil | ||
| } | ||
|
|
||
| // Get the correct destination client from the global map | ||
| destinationClient, ok := m.destinationClients[destinationBlockchainID] | ||
| if !ok { | ||
| return false, fmt.Errorf("relayer not configured to deliver to destination. destinationBlockchainID=%s", destinationBlockchainID.String()) | ||
| } | ||
| client, ok := destinationClient.Client().(ethclient.Client) | ||
| if !ok { | ||
| panic(fmt.Sprintf("Destination client for chain %s is not an Ethereum client", destinationClient.DestinationBlockchainID().String())) | ||
| } | ||
|
|
||
| // Check if the version is already registered in the TeleporterRegistry contract. | ||
| registry, err := teleporterregistry.NewTeleporterRegistryCaller(m.registryAddress, client) | ||
| if err != nil { | ||
| m.logger.Error( | ||
| "Failed to create TeleporterRegistry caller", | ||
| zap.Error(err), | ||
| ) | ||
| return false, err | ||
| } | ||
| address, err := registry.GetAddressFromVersion(&bind.CallOpts{}, entry.Version) | ||
| if err != nil { | ||
| if strings.Contains(err.Error(), revertVersionNotFoundString) { | ||
| return true, nil | ||
| } | ||
| m.logger.Error( | ||
| "Failed to get address from version", | ||
| zap.Error(err), | ||
| ) | ||
| return false, err | ||
| } | ||
|
|
||
| m.logger.Info( | ||
| "Version is already registered in the TeleporterRegistry contract", | ||
| zap.String("version", entry.Version.String()), | ||
| zap.String("registeredAddress", address.String()), | ||
| ) | ||
| return false, nil | ||
| } | ||
|
|
||
| func (m *messageManager) SendMessage(signedMessage *warp.Message, destinationBlockchainID ids.ID) error { | ||
| // Get the correct destination client from the global map | ||
| destinationClient, ok := m.destinationClients[destinationBlockchainID] | ||
| if !ok { | ||
| return fmt.Errorf("relayer not configured to deliver to destination. DestinationBlockchainID=%s", destinationBlockchainID) | ||
| } | ||
|
|
||
| // Construct the transaction call data to call the TeleporterRegistry contract. | ||
| // Only one off-chain registry Warp message is sent at a time, so we hardcode the index to 0 in the call. | ||
| callData, err := teleporterregistry.PackAddProtocolVersion(0) | ||
| if err != nil { | ||
| m.logger.Error( | ||
| "Failed packing receiveCrossChainMessage call data", | ||
| zap.String("destinationBlockchainID", destinationBlockchainID.String()), | ||
| zap.String("warpMessageID", signedMessage.ID().String()), | ||
| ) | ||
| return err | ||
| } | ||
|
|
||
| err = destinationClient.SendTx(signedMessage, m.registryAddress.Hex(), addProtocolVersionGasLimit, callData) | ||
| if err != nil { | ||
| m.logger.Error( | ||
| "Failed to send tx.", | ||
| zap.String("destinationBlockchainID", destinationBlockchainID.String()), | ||
| zap.String("warpMessageID", signedMessage.ID().String()), | ||
| zap.Error(err), | ||
| ) | ||
| return err | ||
| } | ||
| m.logger.Info( | ||
| "Sent message to destination chain", | ||
| zap.String("destinationBlockchainID", destinationBlockchainID.String()), | ||
| zap.String("warpMessageID", signedMessage.ID().String()), | ||
| ) | ||
| return nil | ||
| } | ||
|
|
||
| func (m *messageManager) GetDestinationBlockchainID(unsignedMessage *warp.UnsignedMessage) (ids.ID, error) { | ||
| return unsignedMessage.SourceChainID, nil | ||
| } |
Oops, something went wrong.