Contract level messages #4370

alsrdn · 2023-10-20T19:18:09Z

Contract level messages are a facility that enable a smart contract to emit a message while executing, which eventually gets sent on the event stream and is visible from outside the network.

This PR introduces 2 new FFIs that allow contracts to manage message topics and emit messages.
Messages are sent out through DeployProcessed SSE events.

Add a new `Key::MessageTopic` variant under which message digests will be written to global state for messages emitted by contracts. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

casper-types: add a new `Key` variant for contract level messages

Added 2 new FFIs that enable contracts to register message topics and emit human readable string messages. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

… new block Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Add the message topic names along with the hashes of their names to the addressable entity to enable easy discovery. Also migrate topics to new contract on upgrade. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Also re-organize the types used for contract level messages in multiple modules and refactor naming for better consistency. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

…the SSE Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Remove unnecessary trap error, fix comments and add new test case for checking topic name limits. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

…nts-alt ee: add support for emitting contract level messages

Add test for checking that messages topics are carried over to an upgraded contract. Fix check for not allowing session code to register message topics and add test. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Now the `Message` key has the largest serialized length so the test needs to be updated. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

…sages Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Implemented a mechanism to increase the gas cost for emitting messages linearly for each execution. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Adjust the expected costs for the faucet and the host function metrics contract since the code size has increased due to the addition of the contract messages code. Also the size of the addressable entity stored value has increased because of the stored topic names. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

The `AddressableEntity` record now includes the name of the message topics so the fixture needs to be adjusted. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

When emitting messages, return an error if there's no space left in the topic. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Also add convenience methods to convert contract message related stored values to their inner types. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Don't increase the cost if the message was not emitted. Also simplify config emit message cost config. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

…nts-alt mechanism to increase gas cost for each message emitted within one execution

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Separate contract messages from the execution results; we generally don't want to store messages since they are supposed to be ephemeral. Making them part of the exec results will make them get stored automatically in the node DB with the exec results. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

mpapierski

Couple of notes regarding costs, and few nits, but overall looks good 👍

mpapierski · 2023-11-03T11:09:54Z

execution_engine/src/runtime/externals.rs

+                    )))));
+                }
+
+                let topic_name = self.string_from_mem(topic_name_ptr, topic_name_size)?;


I know we're not consistent at all with regards to this but I have suggestion that we perhaps don't deserialize a string here, but instead, pass the string directly from Wasm. The host already has access to all the data, and you just need to pass pointer to the string i.e.

// wasm fn foo(s: &str) { ext_ffi::foo(s.as_ptr(), s.len()); } // host self.checked_memory_slice(key_ptr as usize, key_size as usize, |data| { std::str::from_utf8(data).map(ToOwned::to_owned) })?

This should make it cheaper for the users as additional serialization, deserialization, etc, adds to the gas costs.

Removed serialization in 53483e1 although didn't use checked_memory_slice as it's not available yet on the feat-2.0 branch. Will do a follow-up commit after.

mpapierski · 2023-11-03T11:11:27Z

execution_engine/src/runtime/externals.rs

+                    )))));
+                }
+
+                let topic_name = self.string_from_mem(topic_name_ptr, topic_name_size)?;


Same as above

Removed serialization in 53483e1 although didn't use checked_memory_slice as it's not available yet on the feat-2.0 branch. Will do a follow-up commit after.

mpapierski · 2023-11-03T11:19:03Z

node/src/components/contract_runtime/operations.rs

            &scratch_state,
            metrics.clone(),
            state_root_hash,
            deploy_hash,
            result,
        )?;
-        execution_results.push((deploy_hash, deploy_header, execution_result));
+        execution_results.push((deploy_hash, deploy_header, execution_result, messages));


Could this be changed into a named struct at this point?

Changed in 53483e1

mpapierski · 2023-11-03T11:20:05Z

node/src/components/contract_runtime/operations.rs

-    let execution_results_checksum =
-        compute_execution_results_checksum(execution_results.iter().map(|(_, _, result)| result))?;
+    let execution_results_checksum = compute_execution_results_checksum(
+        execution_results.iter().map(|(_, _, result, _)| result),


Then you could hide the complexity

Suggested change

execution_results.iter().map(|(_, _, result, _)| result),

execution_results.into_iter().map(|execution_result| execution_result.result),

Changed in 53483e1

mpapierski · 2023-11-03T11:24:25Z

smart_contracts/contract/src/contract_api/runtime.rs

+        return Err(ApiError::InvalidArgument);
+    }
+
+    let (topic_name_ptr, topic_name_size, _bytes) = contract_api::to_ptr(topic_name);


See my other comment regarding passing strings

Changed in 53483e1

mpapierski · 2023-11-03T11:25:52Z

smart_contracts/contract/src/contract_api/runtime.rs

+    }
+
+    let (topic_name_ptr, topic_name_size, _bytes) = contract_api::to_ptr(topic_name);
+    let (operation_ptr, operation_size, _bytes) = contract_api::to_ptr(operation);


To be fair, looking at the definition this could be passed as a number to the host - unless you plan to add more variants with fields etc. in the future. Adding #[derive(ToPrimitive, FromPrimitive)] to MessageTopicOperation could help with convenience

Indeed, now we could pass it as a plain number, and it would probably work for a new operation like Remove. Though my thinking was that if we're going to support more complex operations in the future like Rename, or to allow selection of the checksum algorithm we would need space for some parameters.

mpapierski · 2023-11-03T11:38:51Z

types/src/chainspec/vm_config/opcode_costs.rs

+    }
+
+    fn is_zero(&self) -> bool {
+        self.bit.is_zero()


Can you use let OpcodeCosts { bit, add, .. } = self etc just so we wouldn't accidentally forget to update this if it grows new fields?

Changed in 53483e1

types/src/contract_messages/messages.rs

mpapierski · 2023-11-03T11:45:19Z

types/src/key.rs

+        if let Self::AddressableEntity(PackageKindTag::SmartContract, _) = self {
+            return true;
+        }
+
+        false
+    }


nit

Suggested change

if let Self::AddressableEntity(PackageKindTag::SmartContract, _) = self {

return true;

}

false

}

matches!(self, Self::AddressableEntity(PackageKindTag::SmartContract, _))

The other implementations follow the same (e.g. is_bid_addr_key, is_dictionary_key etc) follow the same style so I would prefer to keep it like this.

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

alsrdn · 2023-11-03T16:35:27Z

bors r+

4370: Contract level messages r=alsrdn a=alsrdn Contract level messages are a facility that enable a smart contract to emit a message while executing, which eventually gets sent on the event stream and is visible from outside the network. This PR introduces 2 new FFIs that allow contracts to manage message topics and emit messages. Messages are sent out through `DeployProcessed` SSE events. Co-authored-by: Alexandru Sardan <alexandru@casperlabs.io> Co-authored-by: Joe Sacher <321623+sacherjj@users.noreply.github.com> Co-authored-by: Luca B <93586856+bradjohnl@users.noreply.github.com>

casperlabs-bors-ng · 2023-11-03T17:15:59Z

Build failed:

continuous-integration/drone/push

alsrdn · 2023-11-03T17:28:39Z

bors merge

4370: Contract level messages r=alsrdn a=alsrdn Contract level messages are a facility that enable a smart contract to emit a message while executing, which eventually gets sent on the event stream and is visible from outside the network. This PR introduces 2 new FFIs that allow contracts to manage message topics and emit messages. Messages are sent out through `DeployProcessed` SSE events. Co-authored-by: Alexandru Sardan <alexandru@casperlabs.io> Co-authored-by: Joe Sacher <321623+sacherjj@users.noreply.github.com> Co-authored-by: Luca B <93586856+bradjohnl@users.noreply.github.com>

casperlabs-bors-ng · 2023-11-03T18:38:42Z

Build failed:

continuous-integration/drone/push

alsrdn · 2023-11-03T18:39:26Z

bors r+

casperlabs-bors-ng · 2023-11-03T21:46:59Z

Build succeeded:

continuous-integration/drone/push

Alexandru Sardan and others added 29 commits September 22, 2023 16:11

casper-types: add a new Key variant for contract level messages

c8199a7

Add a new `Key::MessageTopic` variant under which message digests will be written to global state for messages emitted by contracts. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Merge pull request casper-network#4304 from alsrdn/contract-level-events

10b2388

casper-types: add a new `Key` variant for contract level messages

ee: add support for emitting contract level messages

0263a79

Added 2 new FFIs that enable contracts to register message topics and emit human readable string messages. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee: prune old contract messages from GS with every new execution in a…

94f14da

… new block Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee: add message topics to the addressable entity record

5a1f0ec

Add the message topic names along with the hashes of their names to the addressable entity to enable easy discovery. Also migrate topics to new contract on upgrade. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

tests/contract_messages: fix lint errors

24fe54d

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: fix JSON schema for topic name hash

27af40b

Also re-organize the types used for contract level messages in multiple modules and refactor naming for better consistency. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: add topic name hash to the message sent out on …

0d4571b

…the SSE Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/execution_results: fix lint issue

c8214ec

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: minor cleanups

1252643

Remove unnecessary trap error, fix comments and add new test case for checking topic name limits. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_level_messages: address CR comments

566b353

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: fix further CR comments

3190647

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Merge pull request casper-network#4315 from alsrdn/contract-level-eve…

3b90c2f

…nts-alt ee: add support for emitting contract level messages

ee/contract_messages: add more tests

30acebb

Add test for checking that messages topics are carried over to an upgraded contract. Fix check for not allowing session code to register message topics and add test. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/chainspec: fix WasmConfig serialization for message limits

a956dc3

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/key: fix key_max_serialized_length test

ee87c9d

Now the `Message` key has the largest serialized length so the test needs to be updated. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/key: fix display test for Key::Message variants

f6cd4a4

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/contract_messages: fix MessageAddr from string parsing

8a706e8

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types: fix lint errors caused by the import of Key for contract mes…

c405dbf

…sages Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: increase gas cost for each emitted message

f1bf8d3

Implemented a mechanism to increase the gas cost for emitting messages linearly for each execution. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

casper-validation: fix fixture for AddressableEntity

6df9553

The `AddressableEntity` record now includes the name of the message topics so the fixture needs to be adjusted. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: return error if topic is full

c77dfd0

When emitting messages, return an error if there's no space left in the topic. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: fix CR comments

ffe7e18

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/contract_messages: add getters for Message fields

68cfc48

Also add convenience methods to convert contract message related stored values to their inner types. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

ee/contract_messages: always charge for emit_message

8171806

Don't increase the cost if the message was not emitted. Also simplify config emit message cost config. Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Merge pull request casper-network#4344 from alsrdn/contract-level-eve…

d05a946

…nts-alt mechanism to increase gas cost for each message emitted within one execution

Merge branch 'feat-2.0' into feat-contract-level-events

3b13cd3

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

alsrdn requested a review from darthsiroftardis October 20, 2023 19:18

alsrdn requested review from Fraser999, EdHastingsCasperAssociation, mpapierski, rafal-ch and jacek-casper October 20, 2023 19:18

alsrdn self-assigned this Oct 20, 2023

Merge branch 'feat-2.0' into contract-level-events-merge

9880642

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

EdHastingsCasperAssociation approved these changes Oct 30, 2023

View reviewed changes

Alexandru Sardan added 2 commits October 30, 2023 18:25

Merge branch 'feat-2.0' into contract-level-events-merge

97bcc54

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

types/contract_messages: serialize message checksum to string

8da9ebc

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

mpapierski approved these changes Nov 3, 2023

View reviewed changes

Alexandru Sardan added 2 commits November 3, 2023 15:20

contract_messages: address CR comments

53483e1

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

Merge branch 'feat-2.0' into contract-level-events-merge

dbc56fe

Signed-off-by: Alexandru Sardan <alexandru@casperlabs.io>

casperlabs-bors-ng bot merged commit fd01a5a into casper-network:feat-2.0 Nov 3, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contract level messages #4370

Contract level messages #4370

alsrdn commented Oct 20, 2023

mpapierski left a comment

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023 •

edited

Loading

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

mpapierski Nov 3, 2023

alsrdn Nov 3, 2023

alsrdn commented Nov 3, 2023

casperlabs-bors-ng bot commented Nov 3, 2023

alsrdn commented Nov 3, 2023

casperlabs-bors-ng bot commented Nov 3, 2023

alsrdn commented Nov 3, 2023

casperlabs-bors-ng bot commented Nov 3, 2023

	execution_results.iter().map(\|(_, _, result, _)\| result),
	execution_results.into_iter().map(\|execution_result\| execution_result.result),

Contract level messages #4370

Contract level messages #4370

Conversation

alsrdn commented Oct 20, 2023

mpapierski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alsrdn Nov 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alsrdn commented Nov 3, 2023

casperlabs-bors-ng bot commented Nov 3, 2023

alsrdn commented Nov 3, 2023

casperlabs-bors-ng bot commented Nov 3, 2023

alsrdn commented Nov 3, 2023

casperlabs-bors-ng bot commented Nov 3, 2023

alsrdn Nov 3, 2023 •

edited

Loading