Skip to content

Commit

Permalink
Reinstated italics for parameter names and added type.
Browse files Browse the repository at this point in the history
  • Loading branch information
stoobie committed Apr 25, 2024
1 parent 5e1280c commit b7f1092
Showing 1 changed file with 22 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Gets the hash of a specific Starknet block within the range of `[__first_v0_12_0
=== Arguments

[horizontal,labelwidth="25",role="stripes-odd"]
`block_number u64`:: The number of the block whose hash you want to get.
`_block_number_: u64`:: The number of the block whose hash you want to get.

[discrete]
=== Return values
Expand Down Expand Up @@ -127,9 +127,9 @@ If `call_contract_syscall` fails, this can't be caught and will therefore result
=== Arguments

[horizontal,labelwidth=35]
`address`:: The address of the contract you want to call.
`entry_point_selector`:: A selector for a function within that contract.
`calldata`:: The calldata array.
`_address_: ContractAddress`:: The address of the contract you want to call.
`_entry_point_selector_: felt252`:: A selector for a function within that contract.
`_calldata_: Span<felt252>`:: The calldata array.

[discrete]
=== Return values
Expand Down Expand Up @@ -174,10 +174,10 @@ Deploys a new instance of a previously declared class.
=== Arguments

[horizontal,labelwidth=35]
`class_hash`:: The class hash of the contract to be deployed.
`contract_address_salt`:: The salt, an arbitrary value provided by the sender, used in the computation of the xref:Smart_Contracts/contract-address.adoc[contract's address].
`calldata`:: The constructor's calldata. An array of felts.
`deploy_from_zero`:: A flag used for the contract address computation. If not set, the caller address will be used as the new contract's deployer address, otherwise 0 is used.
`_class_hash_: ClassHash`:: The class hash of the contract to be deployed.
`_contract_address_salt_: felt252`:: The salt, an arbitrary value provided by the sender, used in the computation of the xref:Smart_Contracts/contract-address.adoc[contract's address].
`_calldata_: Span<felt252>`:: The constructor's calldata. An array of felts.
`_deploy_from_zero_: bool`:: A flag used for the contract address computation. If not set, the caller address will be used as the new contract's deployer address, otherwise 0 is used.

[discrete]
=== Return values
Expand Down Expand Up @@ -216,8 +216,8 @@ For more information, and for a higher-level syntax for emitting events, see xre
=== Arguments

[horizontal,labelwidth=35]
`keys`:: The event's keys. These are analogous to Ethereum's event topics, you can use the link:https://github.com/starkware-libs/starknet-specs/blob/c270b8170684bb09741672a7a4ae5003670c3f43/api/starknet_api_openrpc.json#L569RPC[starknet_getEvents] method to filter by these keys.
`data`:: The event's data.
`_keys_: Span<felt252>`:: The event's keys. These are analogous to Ethereum's event topics, you can use the link:https://github.com/starkware-libs/starknet-specs/blob/c270b8170684bb09741672a7a4ae5003670c3f43/api/starknet_api_openrpc.json#L569RPC[starknet_getEvents] method to filter by these keys.
`_data_: Span<felt252>`:: The event's data.

[discrete]
=== Return values
Expand Down Expand Up @@ -265,9 +265,9 @@ This system call replaces the known delegate call functionality from Ethereum, w
=== Arguments

[horizontal,labelwidth=35]
`class_hash`:: The hash of the class you want to use.
`function_selector`:: A selector for a function within that class.
`calldata`:: The calldata.
`_class_hash_: ClassHash`:: The hash of the class you want to use.
`_function_selector_: felt252`:: A selector for a function within that class.
`_calldata_: Span<felt252>`:: The calldata.

[discrete]
=== Return values
Expand Down Expand Up @@ -305,8 +305,8 @@ For more information, see Starknet's xref:Network_Architecture/messaging-mechani
=== Arguments

[horizontal,labelwidth=35]
`to_address`:: The recipient's L1 address.
`payload`:: The array containing the message payload
`_to_address_: felt252`:: The recipient's L1 address.
`_payload_: Span<felt252>`:: The array containing the message payload

[discrete]
=== Return values
Expand Down Expand Up @@ -362,7 +362,7 @@ the `call_contract` syscall in the same transaction (after the replacement).
=== Arguments

[horizontal,labelwidth=35]
`class_hash`:: The hash of the class you want to use as a replacement.
`class_hash_: ClassHash`:: The hash of the class you want to use as a replacement.

[discrete]
=== Return values
Expand All @@ -382,7 +382,7 @@ link:https://github.com/starkware-libs/cairo/blob/cca08c898f0eb3e58797674f20994d
[source,cairo,subs="+quotes,+macros"]
----
extern fn storage_read_syscall(
address_domain: u32, address: StorageAddress,
address_domain: u32, address: StorageAddress
) -> SyscallResult<felt252> implicits(GasBuiltin, System) nopanic;
----

Expand All @@ -399,8 +399,8 @@ For information on accessing storage by using the storage variables, see xref:./
=== Arguments

[horizontal,labelwidth=35]
`address_domain`:: The domain of the key, used to separate between different data availability modes. This separation is used in Starknet to offer different data availability modes. Currently, only the onchain mode (where all updates go to L1), indicated by domain `0`, is supported. Other address domains which will be introduced in the future will behave differently in terms of publication (in particular, they will not be posted on L1, creating a tradeoff between cost and security).
`address`:: The requested storage address.
`_address_domain_: u32`:: The domain of the key, used to separate between different data availability modes. This separation is used in Starknet to offer different data availability modes. Currently, only the onchain mode (where all updates go to L1), indicated by domain `0`, is supported. Other address domains which will be introduced in the future will behave differently in terms of publication (in particular, they will not be posted on L1, creating a tradeoff between cost and security).
`_address_: StorageAddress`:: The requested storage address.

[discrete]
=== Return values
Expand Down Expand Up @@ -451,9 +451,9 @@ For information on accessing storage by using the storage variables, see xref:./
=== Arguments

[horizontal,labelwidth=35]
`address_domain`:: The domain of the key, used to separate between different data availability modes. This separation is used in Starknet to offer different data availability modes. Currently, only the onchain mode (where all updates go to L1), indicated by domain `0`, is supported. Other address domains which will be introduced in the future will behave differently in terms of publication (in particular, they will not be posted on L1, creating a tradeoff between cost and security).
`address`:: The requested storage address.
`value`:: The value to write to the key.
`_address_domain_: u32`:: The domain of the key, used to separate between different data availability modes. This separation is used in Starknet to offer different data availability modes. Currently, only the onchain mode (where all updates go to L1), indicated by domain `0`, is supported. Other address domains which will be introduced in the future will behave differently in terms of publication (in particular, they will not be posted on L1, creating a tradeoff between cost and security).
`_address_: StorageAddress`:: The requested storage address.
`_value_: felt252`:: The value to write to the key.

[discrete]
=== Return values
Expand Down

0 comments on commit b7f1092

Please sign in to comment.