[PoC] Message Queue contract #789
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,29 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.15; | ||
|
|
||
| import "../lib/IMessageQueue.sol"; | ||
|
|
||
| struct Message { | ||
| bytes data; | ||
| address sender; | ||
| } | ||
|
|
||
| contract MessageQueue is IMessageQueue{ | ||
| function sendRawTransaction(bytes calldata _message) external override { | ||
|
Contributor
There was a problem hiding this comment. What are thoughts around supporting attaching
Contributor
Author
There was a problem hiding this comment. Value is attached inside this message. It's out InternalTransactionPayload encoded with SSZ. Do we need to send SSZ inside EVM at all. Or should be accept only ABI packed data and only then we need to repack into SSZ |
||
| queue.push(Message({ | ||
| data: _message, | ||
| sender: msg.sender | ||
| })); | ||
| } | ||
|
|
||
| function getMessages() external view returns (Message[] memory) { | ||
| return queue; | ||
| } | ||
|
|
||
| function clearQueue() external { | ||
| require(msg.sender == address(this), "clearQueue: only MessageQueue contract can be caller of this function"); | ||
| delete queue; | ||
| } | ||
|
|
||
| Message[] private queue; | ||
|
Contributor
There was a problem hiding this comment. Maybe it is worth to separate this array by shard. So the other shard can fetch only messages addressed to him:
Contributor
Author
There was a problem hiding this comment. Right now we don't have a special interface to send data to specific shard. Our smart accounts operates with raw calldata and we can extract destination shard only after decoding a message. But we don't have a SSZ decoder in Solidity. So here we have single queue for all messages. In future then we will pass destination shards/address explicitly it will be possible.
Contributor
There was a problem hiding this comment. What are the limits on the size of the queue or message size in queue?
Contributor
There was a problem hiding this comment. Also how would this compare to another approach such as emitting an event instead?
Contributor
Author
There was a problem hiding this comment.
Right now there is no any limits but we can add them
I didn't think about emitting events but this looks like an attempt to move all magic out of EVM. Sounds interesting but I'm not sure it's what we expect. Should be discussed. Thanks for idea. |
||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,126 @@ | ||
| package execution | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/NilFoundation/nil/nil/internal/config" | ||
| "github.com/NilFoundation/nil/nil/internal/contracts" | ||
| "github.com/NilFoundation/nil/nil/internal/types" | ||
| "github.com/NilFoundation/nil/nil/internal/vm" | ||
| ) | ||
|
|
||
| type message struct { | ||
| Data []byte | ||
| Address types.Address | ||
| } | ||
|
|
||
| func CreateMQPruneTransaction(shardId types.ShardId, bn types.BlockNumber) (*types.Transaction, error) { | ||
| abi, err := contracts.GetAbi(contracts.NameMessageQueue) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get MessageQueue ABI: %w", err) | ||
| } | ||
|
|
||
| calldata, err := abi.Pack("clearQueue") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to pack clearQueue calldata: %w", err) | ||
| } | ||
|
|
||
| addr := types.GetMessageQueueAddress(shardId) | ||
| txn := &types.Transaction{ | ||
| TransactionDigest: types.TransactionDigest{ | ||
| Flags: types.NewTransactionFlags(types.TransactionFlagInternal), | ||
| To: addr, | ||
| FeeCredit: types.GasToValue(types.DefaultMaxGasInBlock.Uint64()), | ||
| MaxFeePerGas: types.MaxFeePerGasDefault, | ||
| MaxPriorityFeePerGas: types.Value0, | ||
| Data: calldata, | ||
| Seqno: types.Seqno(bn + 1), | ||
| }, | ||
| RefundTo: addr, | ||
| From: addr, | ||
| } | ||
|
|
||
| return txn, nil | ||
| } | ||
|
|
||
| func GetMessageQueueContent(es *ExecutionState) ([]message, error) { | ||
| addr := types.GetMessageQueueAddress(es.ShardId) | ||
| account, err := es.GetAccount(addr) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get message queue smart contract: %w", err) | ||
| } | ||
|
|
||
| abi, err := contracts.GetAbi(contracts.NameMessageQueue) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get MessageQueue ABI: %w", err) | ||
| } | ||
|
|
||
| calldata, err := abi.Pack("getMessages") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to pack getMessages calldata: %w", err) | ||
| } | ||
|
|
||
| if err := es.newVm(true, addr, nil); err != nil { | ||
| return nil, fmt.Errorf("failed to create VM: %w", err) | ||
| } | ||
| defer es.resetVm() | ||
|
|
||
| ret, _, err := es.evm.StaticCall( | ||
| (vm.AccountRef)(account.address), account.address, calldata, types.DefaultMaxGasInBlock.Uint64()) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get message queue content: %w", err) | ||
| } | ||
|
|
||
| var result []message | ||
| if err := abi.UnpackIntoInterface(&result, "getMessages", ret); err != nil { | ||
| return nil, fmt.Errorf("failed to unpack getMessages return data: %w", err) | ||
| } | ||
|
|
||
| return result, nil | ||
| } | ||
|
|
||
| func HandleOutMessage(es *ExecutionState, msg *message) error { | ||
| var payload types.InternalTransactionPayload | ||
| if err := payload.UnmarshalSSZ(msg.Data); err != nil { | ||
| return types.NewWrapError(types.ErrorInvalidTransactionInputUnmarshalFailed, err) | ||
| } | ||
|
|
||
| cfgAccessor := es.GetConfigAccessor() | ||
| nShards, err := config.GetParamNShards(cfgAccessor) | ||
| if err != nil { | ||
| return types.NewVmVerboseError(types.ErrorPrecompileConfigGetParamFailed, err.Error()) | ||
| } | ||
|
|
||
| if uint32(payload.To.ShardId()) >= nShards { | ||
| return vm.ErrShardIdIsTooBig | ||
| } | ||
|
|
||
| if payload.To.ShardId().IsMainShard() { | ||
| return vm.ErrTransactionToMainShard | ||
| } | ||
|
|
||
| // TODO: support estimate fee for such messages | ||
| payload.FeeCredit = types.MaxFeePerGasDefault | ||
|
|
||
| // TODO: withdrawFunds should be implemneted | ||
| // if err := withdrawFunds(es, msg.Address, payload.Value); err != nil { | ||
| // return nil, fmt.Errorf("withdraw value failed: %w", err) | ||
| // } | ||
|
|
||
| // if payload.ForwardKind == types.ForwardKindNone { | ||
| // if err := withdrawFunds(es, msg.Address, payload.FeeCredit); err != nil { | ||
| // return nil, fmt.Errorf("withdraw FeeCredit failed: %w", err) | ||
| // } | ||
| // } | ||
|
|
||
| // TODO: We should consider non-refundable transactions | ||
| if payload.RefundTo == types.EmptyAddress { | ||
| payload.RefundTo = msg.Address | ||
| } | ||
| if payload.BounceTo == types.EmptyAddress { | ||
| payload.BounceTo = msg.Address | ||
| } | ||
|
|
||
| _, err = es.AddOutTransaction(msg.Address, &payload) | ||
| return err | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,6 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.15; | ||
|
|
||
| interface IMessageQueue { | ||
| function sendRawTransaction(bytes calldata _message) external; | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it may be convenient to introduce more fields here (e.g. tokens)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the first version I'd just want to check that it will work at all. basic test passed. We can discussed it and extends current implementation.