Added data transformation documentation #2555

integraledelebesgue · 2024-10-04T10:57:22Z

Stack:

⚠️ Part of a stack created by spr. Do not merge manually using the UI - doing so may have unexpected results.

kkawula · 2024-10-04T13:01:52Z

docs/src/starknet/calldata-transformation.md

+
+It's **not allowed** to write any function call expressions, either builtin, or user-defined.


I would make it more verbose, the message of this line isn't obvious to me

cptartur · 2024-10-04T16:23:24Z

docs/src/starknet/calldata-transformation.md

+      call \
+      --url http://127.0.0.1:5050 \
+      --contract-address 0x016ad425af4585102e139d4fb2c76ce786d1aaa1cfcd88a51f3ed66601b23cdd \
+      --function tuple_fn \


I think it should be this

complex_struct_fn

cptartur · 2024-10-04T16:23:43Z

docs/src/starknet/calldata-transformation.md

+      --contract-address 0x016ad425af4585102e139d4fb2c76ce786d1aaa1cfcd88a51f3ed66601b23cdd \
+      --function tuple_fn \
+      --calldata \
+          data_transformer_contract::ComplexStruct { \


We never show the definition of ComplexStruct.

It should be NestedStructWithField instead, my fault

cptartur · 2024-10-04T16:24:50Z

docs/src/starknet/calldata-transformation.md

+      call \
+      --url http://127.0.0.1:5050 \
+      --contract-address 0x016ad425af4585102e139d4fb2c76ce786d1aaa1cfcd88a51f3ed66601b23cdd \
+      --function tuple_fn \


I think it should be complex_fn

cptartur · 2024-10-04T16:26:23Z

docs/src/starknet/calldata-transformation.md

+### Caveats
+
+Reasoning about calldata serialization logic is not always possible for Cast. **In particular, Cast doesn't verify serialized calldata against the ABI**.
+
+When given a calldata, Cast first tries to transform it according to the contract ABI.
+When failed, in case of type or length mismatch, it will then try to interpret it as an already serialized data.
+
+Thus, calldata written in hex-encoded form is not always going to be interpreted as a list of felts and treated as serialized. Let's see an example:
+
+Our `DataTransformerContract` exposes a method with signature:
+```rust
+fn u256_fn(self: @ContractState, a: u256) { ... }
+```
+
+We can write:
+```shell
+$ sncast --account myuser \
+  call \
+  --url http://127.0.0.1:5050 \
+  --contract-address 0x016ad425af4585102e139d4fb2c76ce786d1aaa1cfcd88a51f3ed66601b23cdd \
+  --function u256_fn \
+  --calldata 0x10 \
+  --block-id latest
+```
+
+Despite the call data **not being** the proper serialization of an `u256` (which would be `0x10 0x0`), call succeeds.


Maybe this should be a bit more strongly worded e.g. explicitly warn users to always use type suffixes etc. so their data doesn't become serialized incorrectly

Also it would probably make sense to add a flag that disables data transformation just to be extra sure. This could be a separate issue and tackled by someone else though

cptartur · 2024-10-04T16:31:21Z

docs/src/starknet/index.md

+Please note the notation of the argument. The default way of passing calldata is a list of hexadecimally encoded field elements - the *serialized* calldata.
+To obtain the serialized form of the wished data, one must write a Cairo program calling `Serde::serialize` on subsequent arguments and displaying the results.
+
+It is also possible to pass calldata in more friendly, human readable form due to the [calldata transformation](./calldata-transformation.md) feature present in Cast.


Suggested change

It is also possible to pass calldata in more friendly, human readable form due to the [calldata transformation](./calldata-transformation.md) feature present in Cast.

It is also possible to pass calldata in more friendly, human readable form thanks to the [calldata transformation](./calldata-transformation.md) feature present in Cast.

cptartur · 2024-10-04T16:31:33Z

docs/src/starknet/index.md

+It is also possible to pass calldata in more friendly, human readable form due to the [calldata transformation](./calldata-transformation.md) feature present in Cast.
+
+> ⚠️ **Warning**
+> Cast will not werify the serialized calldata. Any errors caused by passing improper calldata in a serialized form will originate from the network.


Suggested change

> Cast will not werify the serialized calldata. Any errors caused by passing improper calldata in a serialized form will originate from the network.

> Cast will not verify the serialized calldata. Any errors caused by passing improper calldata in a serialized form will originate from the network.

commit-id:f00574d8

integraledelebesgue requested review from ksew1, cptartur and ddoktorski as code owners October 4, 2024 10:57

This was referenced Oct 4, 2024

Refactored call, deploy and invoke command handlers #2546

Open

Introduced data transformer #2547

Open

Integrated data transformer with sncast commands #2548

Open

Implemented representations of Cairo u256 and u512 #2545

Open

integraledelebesgue force-pushed the spr/master/f00574d8 branch from 6326189 to c04a9a6 Compare October 4, 2024 11:29

kkawula reviewed Oct 4, 2024

View reviewed changes

cptartur reviewed Oct 4, 2024

View reviewed changes

integraledelebesgue force-pushed the spr/master/f00574d8 branch from c04a9a6 to 985d9dd Compare October 4, 2024 17:46

integraledelebesgue force-pushed the spr/master/9557f1ee branch from 39e1aa9 to 98dac87 Compare October 4, 2024 17:46

integraledelebesgue force-pushed the spr/master/f00574d8 branch from 985d9dd to 78f40e3 Compare October 4, 2024 19:08

integraledelebesgue force-pushed the spr/master/9557f1ee branch 2 times, most recently from a8be152 to 19e21c3 Compare October 4, 2024 19:16

integraledelebesgue force-pushed the spr/master/f00574d8 branch from 78f40e3 to 9257615 Compare October 4, 2024 19:16

Added data transformation documentation

5327631

commit-id:f00574d8

integraledelebesgue force-pushed the spr/master/f00574d8 branch from 9257615 to 5327631 Compare October 4, 2024 19:33

integraledelebesgue force-pushed the spr/master/9557f1ee branch from 19e21c3 to ade2c54 Compare October 4, 2024 19:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added data transformation documentation #2555

Added data transformation documentation #2555

integraledelebesgue commented Oct 4, 2024 •

edited

Loading

kkawula Oct 4, 2024

cptartur Oct 4, 2024

cptartur Oct 4, 2024

integraledelebesgue Oct 4, 2024

cptartur Oct 4, 2024

cptartur Oct 4, 2024

cptartur Oct 4, 2024

cptartur Oct 4, 2024

cptartur Oct 4, 2024


		It's not allowed to write any function call expressions, either builtin, or user-defined.

	It is also possible to pass calldata in more friendly, human readable form due to the [calldata transformation](./calldata-transformation.md) feature present in Cast.
	It is also possible to pass calldata in more friendly, human readable form thanks to the [calldata transformation](./calldata-transformation.md) feature present in Cast.

	> Cast will not werify the serialized calldata. Any errors caused by passing improper calldata in a serialized form will originate from the network.
	> Cast will not verify the serialized calldata. Any errors caused by passing improper calldata in a serialized form will originate from the network.

Added data transformation documentation #2555

Are you sure you want to change the base?

Added data transformation documentation #2555

Conversation

integraledelebesgue commented Oct 4, 2024 • 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

integraledelebesgue commented Oct 4, 2024 •

edited

Loading