String encoding for return values (#185)

* String encoding for return values * cleanup * cleanup * tmp * Fix tests * Remove unneeded identifier * Renamee encodeStatements to codegenValuesEncoder * Rename data to log_buffer * More documentation * Remove spaces
Pi-Squared-Inc · Nov 25, 2024 · 4b974ad · 4b974ad
1 parent d63ac0c
commit 4b974ad
Show file tree

Hide file tree

Showing 18 changed files with 356 additions and 92 deletions.
diff --git a/rust-semantics/error.md b/rust-semantics/error.md
@@ -12,6 +12,7 @@ module RUST-ERROR-SYNTAX
     syntax TypePathOrError ::= injectOrError(TypePathSegmentsOrError) [function, total]
     syntax TypePathSegmentsOrError ::= concat(TypePathSegment, TypePathSegmentsOrError)  [function, total]
     syntax ExpressionOrError ::= andOrError(ExpressionOrError, ExpressionOrError)  [function, total]
+    syntax ExpressionOrError ::= addOrError(ExpressionOrError, ExpressionOrError)  [function, total]
     syntax ValueOrError ::= tupleOrError(ValueListOrError)  [function, total]
 endmodule
 
@@ -52,6 +53,10 @@ module RUST-ERROR
     rule andOrError(e(E:SemanticsError), v(_:Expression)) => e(E)
     rule andOrError(v(E1:Expression), v(E2:Expression)) => v(E1 && E2)
 
+    rule addOrError(_:ExpressionOrError, e(E:SemanticsError)) => e(E)
+    rule addOrError(e(E:SemanticsError), v(_:Expression)) => e(E)
+    rule addOrError(v(E1:Expression), v(E2:Expression)) => v(E1 + E2)
+
     rule tupleOrError(L:ValueList) => tuple(L)
     rule tupleOrError(E:SemanticsError) => E
 endmodule

diff --git a/tests/ulm-contracts/bytes_hooks.rs b/tests/ulm-contracts/bytes_hooks.rs
@@ -13,13 +13,16 @@ extern "C" {
   fn append_bool(bytes_id: u64, value: bool) -> u64;
   fn append_str(bytes_id: u64, value: &str) -> u64;
 
+  fn append_bytes_raw(bytes_id: u64, to_append: u64) -> u64;
+
   fn decode_u256(bytes_id: u64) -> (u64, u256);
   fn decode_u160(bytes_id: u64) -> (u64, u160);
   fn decode_u128(bytes_id: u64) -> (u64, u128);
   fn decode_u64(bytes_id: u64) -> (u64, u64);
   fn decode_u32(bytes_id: u64) -> (u64, u32);
   fn decode_u16(bytes_id: u64) -> (u64, u16);
   fn decode_u8(bytes_id: u64) -> (u64, u8);
+  fn decode_str(bytes_id: u64) -> (u64, str);
 
   fn decode_signature(bytes_id: u64) -> (u64, u64);
   fn hash(bytes_id: u64) -> u256;

diff --git a/tests/ulm-contracts/test_helpers.rs b/tests/ulm-contracts/test_helpers.rs
@@ -14,3 +14,15 @@ fn decode_single_u256(bytes_id: u64) -> u256 {
   };
   value
 }
+
+fn decode_single_str(bytes_id: u64) -> str {
+  let (remaining_id, prefix_size) = :: bytes_hooks :: decode_u256(bytes_id);
+  if prefix_size != 32_u256 {
+      fail();
+  };
+  let (remaining_id, value) = :: bytes_hooks :: decode_str(remaining_id);
+  if :: bytes_hooks :: length(remaining_id) > 0_u32 {
+      fail();
+  };
+  value
+}
diff --git a/tests/ulm-no-contract/test_bytes_hooks.appendstr.run b/tests/ulm-no-contract/test_bytes_hooks.appendstr.run
@@ -3,11 +3,11 @@ call :: test_bytes_hooks :: append_str;
 return_value_to_arg;
 call :: bytes_hooks :: length;
 return_value;
-check_eq 7_u32;
+check_eq 64_u32;
 
-push "Everyone";
+push "Everyone12345678901234567890123456789012";
 call :: test_bytes_hooks :: append_str;
 return_value_to_arg;
 call :: bytes_hooks :: length;
 return_value;
-check_eq 10_u32
+check_eq 96_u32
diff --git a/tests/ulm-with-contract/erc_20_token.1.run b/tests/ulm-with-contract/erc_20_token.1.run
@@ -1,28 +1,28 @@
-list_mock GetAccountStorageHook ( 11059124170230400219182520145867018696635045254189466511817698468614930762963 ) ulmIntResult(0, u256);
-list_mock SetAccountStorageHook ( 11059124170230400219182520145867018696635045254189466511817698468614930762963 , 10000 ) ulmNoResult();
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(0, u256);
-list_mock SetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 , 10000 ) ulmNoResult();
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(10000, u256);
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(10000, u256);
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(10000, u256);
-list_mock SetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 , 9900 ) ulmNoResult();
-list_mock GetAccountStorageHook ( 17171626450567201640701347902808840427582371480602455275836469707331258301780 ) ulmIntResult(0, u256);
-list_mock SetAccountStorageHook ( 17171626450567201640701347902808840427582371480602455275836469707331258301780 , 100 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 13032332009337290780939164280742955473285243463246449969298152790977293574652 ) ulmIntResult(0, u256);
+list_mock SetAccountStorageHook ( 13032332009337290780939164280742955473285243463246449969298152790977293574652 , 10000 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(0, u256);
+list_mock SetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 , 10000 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(10000, u256);
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(10000, u256);
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(10000, u256);
+list_mock SetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 , 9900 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 107935355587284645605585039702009686485686559005730386557515578263121021727641 ) ulmIntResult(0, u256);
+list_mock SetAccountStorageHook ( 107935355587284645605585039702009686485686559005730386557515578263121021727641 , 100 ) ulmNoResult();
 list_mock Log3Hook ( 100389287136786176327247604509743168900146139575972864366142685224231313322991 , 1010101 , 2020202 , b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00d" ) ulmNoResult();
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(9900, u256);
-list_mock GetAccountStorageHook ( 17171626450567201640701347902808840427582371480602455275836469707331258301780 ) ulmIntResult(100, u256);
-list_mock SetAccountStorageHook ( 97321503972240892886219376522881926110074550168465622121824657360422868161783 , 200 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(9900, u256);
+list_mock GetAccountStorageHook ( 107935355587284645605585039702009686485686559005730386557515578263121021727641 ) ulmIntResult(100, u256);
+list_mock SetAccountStorageHook ( 6299478510657022222390882510197411465571447485061513230872540120223652878023 , 200 ) ulmNoResult();
 list_mock Log3Hook ( 63486140976153616755203102783360879283472101686154884697241723088393386309925 , 1010101 , 3030303 , b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xc8" ) ulmNoResult();
-list_mock GetAccountStorageHook ( 97321503972240892886219376522881926110074550168465622121824657360422868161783 ) ulmIntResult(200, u256);
-list_mock SetAccountStorageHook ( 97321503972240892886219376522881926110074550168465622121824657360422868161783 , 0 ) ulmNoResult();
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(9900, u256);
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(9900, u256);
-list_mock SetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 , 9700 ) ulmNoResult();
-list_mock GetAccountStorageHook ( 17171626450567201640701347902808840427582371480602455275836469707331258301780 ) ulmIntResult(100, u256);
-list_mock SetAccountStorageHook ( 17171626450567201640701347902808840427582371480602455275836469707331258301780 , 300 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 6299478510657022222390882510197411465571447485061513230872540120223652878023 ) ulmIntResult(200, u256);
+list_mock SetAccountStorageHook ( 6299478510657022222390882510197411465571447485061513230872540120223652878023 , 0 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(9900, u256);
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(9900, u256);
+list_mock SetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 , 9700 ) ulmNoResult();
+list_mock GetAccountStorageHook ( 107935355587284645605585039702009686485686559005730386557515578263121021727641 ) ulmIntResult(100, u256);
+list_mock SetAccountStorageHook ( 107935355587284645605585039702009686485686559005730386557515578263121021727641 , 300 ) ulmNoResult();
 list_mock Log3Hook ( 100389287136786176327247604509743168900146139575972864366142685224231313322991 , 1010101 , 2020202 , b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xc8" ) ulmNoResult();
-list_mock GetAccountStorageHook ( 115494845046723600673943990597816811669707739681772931244236289759170204726560 ) ulmIntResult(9700, u256);
-list_mock GetAccountStorageHook ( 17171626450567201640701347902808840427582371480602455275836469707331258301780 ) ulmIntResult(300, u256);
+list_mock GetAccountStorageHook ( 61159765391625381932700807532824927387505868579121206115135228514320059425645 ) ulmIntResult(9700, u256);
+list_mock GetAccountStorageHook ( 107935355587284645605585039702009686485686559005730386557515578263121021727641 ) ulmIntResult(300, u256);
 
 push "uint256";
 hold_list_values_from_test_stack;

diff --git a/tests/ulm-with-contract/storage.256.run b/tests/ulm-with-contract/storage.256.run
@@ -1,5 +1,5 @@
-mock SetAccountStorageHook ( 47586510880955265726688953653028435069486243252926274554489699639913455891751 , 1000000000000000000000000000000000000000000000000000000000000 ) ulmNoResult();
-mock GetAccountStorageHook ( 47586510880955265726688953653028435069486243252926274554489699639913455891751 ) ulmIntResult(1000000000000000000000000000000000000000000000000000000000000, u256);
+mock SetAccountStorageHook ( 81899343944223093934060911023235694134954301913235101281428181165721203435003 , 1000000000000000000000000000000000000000000000000000000000000 ) ulmNoResult();
+mock GetAccountStorageHook ( 81899343944223093934060911023235694134954301913235101281428181165721203435003 ) ulmIntResult(1000000000000000000000000000000000000000000000000000000000000, u256);
 
 push "setMyData256";
 hold_string_from_test_stack;

diff --git a/tests/ulm-with-contract/storage.key.run b/tests/ulm-with-contract/storage.key.run
@@ -1,5 +1,5 @@
-mock SetAccountStorageHook ( 10244917065751466042072482011607924022453580028001931068470547844249081769915 , 123 ) ulmNoResult();
-mock GetAccountStorageHook ( 10244917065751466042072482011607924022453580028001931068470547844249081769915 ) ulmIntResult(123, u256);
+mock SetAccountStorageHook ( 89307555350153532481150451243271458944170707741354029868021544305102042370102 , 123 ) ulmNoResult();
+mock GetAccountStorageHook ( 89307555350153532481150451243271458944170707741354029868021544305102042370102 ) ulmIntResult(123, u256);
 
 push "setMyDataKey";
 hold_string_from_test_stack;

diff --git a/tests/ulm-with-contract/storage.simple.run b/tests/ulm-with-contract/storage.simple.run
@@ -1,5 +1,5 @@
-mock SetAccountStorageHook ( 73866358942311723187445361469509963283744060252826659833950887638461707973283 , 123 ) ulmNoResult();
-mock GetAccountStorageHook ( 73866358942311723187445361469509963283744060252826659833950887638461707973283 ) ulmIntResult(123, u256);
+mock SetAccountStorageHook ( 2566766180763832229052383091904627608042490431692515280991237530682175269032 , 123 ) ulmNoResult();
+mock GetAccountStorageHook ( 2566766180763832229052383091904627608042490431692515280991237530682175269032 ) ulmIntResult(123, u256);
 
 push "setMyData";
 hold_string_from_test_stack;

diff --git a/tests/ulm-with-contract/types.rs b/tests/ulm-with-contract/types.rs
@@ -0,0 +1,15 @@
+#![no_std]
+
+#[allow(unused_imports)]
+use ulm::*;
+
+#[ulm::contract]
+pub trait Types {
+    #[init]
+    fn init(&self) {}
+
+    #[endpoint(strEndpoint)]
+    fn str_endpoint(&self) -> str {
+        "Hello"
+    }
+}
diff --git a/tests/ulm-with-contract/types.str-raw.run b/tests/ulm-with-contract/types.str-raw.run
@@ -0,0 +1,21 @@
+push "strEndpoint";
+hold_string_from_test_stack;
+hold_list_values_from_test_stack;
+hold_list_values_from_test_stack;
+encode_call_data;
+
+return_value;
+mock CallData;
+
+call_contract 12345;
+return_value;
+check_eq ();
+
+push_status;
+check_eq 2;
+
+check_raw_output
+    b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20" +
+    b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x05" +
+    b"Hello\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+
diff --git a/tests/ulm-with-contract/types.str.run b/tests/ulm-with-contract/types.str.run
@@ -0,0 +1,19 @@
+push "strEndpoint";
+hold_string_from_test_stack;
+hold_list_values_from_test_stack;
+hold_list_values_from_test_stack;
+encode_call_data;
+
+return_value;
+mock CallData;
+
+call_contract 12345;
+return_value;
+check_eq ();
+
+push_status;
+check_eq 2;
+output_to_arg;
+call :: test_helpers :: decode_single_str;
+return_value;
+check_eq "Hello"