Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Derive StorageAccess for EthAddress and abi Dispatcher builtin types #3247

Merged
merged 6 commits into from
May 31, 2023
Merged

Derive StorageAccess for EthAddress and abi Dispatcher builtin types #3247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d898ae
Derive StorageAccess for builtin types
maciejka May 26, 2023
9fa11be
Merge remote-tracking branch 'origin/main' into mk/derive_storage_acc…
maciejka May 31, 2023
892aeca
run rust_fmt
maciejka May 31, 2023
2ae6009
fix ETH_ADDRESS_BOUND
maciejka May 31, 2023
afcdeec
cleanup
maciejka May 31, 2023
bc36d23
run cairo_fmt
maciejka May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions corelib/src/starknet/eth_address.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ use traits::{Into, TryInto};
use zeroable::Zeroable;

// An Ethereum address (160 bits).
#[derive(Copy, Drop)]
#[derive(Copy, Drop, storage_access::StorageAccess)]
struct EthAddress {
address: felt252,
}
impl Felt252TryIntoEthAddress of TryInto<felt252, EthAddress> {
fn try_into(self: felt252) -> Option<EthAddress> {
// TODO(yuval): change to a constant once u256 literals are supported.
let ETH_ADDRESS_BOUND = u256 { high: 0x100000000_u128, low: 0_u128 }; // 2 ** 160
let ETH_ADDRESS_BOUND = 0x10000000000000000000000000000000000000000_u256; // 2 ** 160

if self.into() < ETH_ADDRESS_BOUND {
Option::Some(EthAddress { address: self })
Expand Down
9 changes: 7 additions & 2 deletions crates/cairo-lang-starknet/cairo_level_tests/storage_access.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
use core::option::OptionTrait;
use core::traits::Into;
use core::traits::{Into, TryInto};
use array::{ArrayTrait, SpanTrait};
use starknet::{
ClassHash, ContractAddress, StorageAddress, StorageBaseAddress, SyscallResult,
ClassHash, ContractAddress, EthAddress, StorageAddress, SyscallResult,
storage_address_to_felt252, storage_address_try_from_felt252
};
use starknet::eth_address::Felt252TryIntoEthAddress;
use super::utils::{serialized_element, single_deserialize};
use integer::BoundedInt;
use zeroable::Zeroable;
Expand Down Expand Up @@ -37,6 +38,8 @@ struct AbcEtc {
g: ContractAddress,
h: ClassHash,
i: StorageAddress,
j: bool,
k: EthAddress,
abc: Abc,
}

Expand Down Expand Up @@ -74,6 +77,8 @@ fn write_read_struct() {
g: Zeroable::zero(),
h: Zeroable::zero(),
i: storage_address_try_from_felt252(123_felt252).unwrap(),
j: true,
k: 123_felt252.try_into().unwrap(),
abc: Abc {
a: 1_u8, b: 2_u16, c: 3_u32,
}
Expand Down
51 changes: 4 additions & 47 deletions crates/cairo-lang-starknet/src/plugin/dispatcher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ pub fn handle_trait(db: &dyn SyntaxGroup, trait_ast: ast::ItemTrait) -> PluginRe
$dispatcher_signatures$
}}

#[derive(Copy, Drop)]
#[derive(Copy, Drop, storage_access::StorageAccess)]
struct {contract_caller_name} {{
contract_address: starknet::ContractAddress,
}}
Expand All @@ -156,58 +156,14 @@ pub fn handle_trait(db: &dyn SyntaxGroup, trait_ast: ast::ItemTrait) -> PluginRe
$contract_caller_method_impls$
}}

#[derive(Copy, Drop)]
#[derive(Copy, Drop, storage_access::StorageAccess)]
struct {library_caller_name} {{
class_hash: starknet::ClassHash,
}}

impl {library_caller_name}Impl of {dispatcher_name}::<{library_caller_name}> {{
$library_caller_method_impls$
}}

impl {contract_caller_name}StorageAccess of starknet::StorageAccess::<{contract_caller_name}> {{
fn read(address_domain: u32, base: starknet::StorageBaseAddress) -> starknet::SyscallResult<{contract_caller_name}> {{
starknet::StorageAccess::<{contract_caller_name}>::read_at_offset_internal(address_domain, base, 0_u8)
}}
fn write(address_domain: u32, base: starknet::StorageBaseAddress, value: {contract_caller_name}) -> starknet::SyscallResult<()> {{
starknet::StorageAccess::<{contract_caller_name}>::write_at_offset_internal(address_domain, base, 0_u8, value)
}}
fn read_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8) -> starknet::SyscallResult<{contract_caller_name}> {{
starknet::SyscallResult::Ok(
{contract_caller_name} {{
contract_address: starknet::StorageAccess::<starknet::ContractAddress>::read_at_offset_internal(address_domain, base, offset)?
}}
)
}}
fn write_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8, value: {contract_caller_name}) -> starknet::SyscallResult<()> {{
starknet::StorageAccess::<starknet::ContractAddress>::write_at_offset_internal(address_domain, base, offset, value.contract_address)
}}
fn size_internal(value: {contract_caller_name}) -> u8 {{
1_u8
}}
}}

impl {library_caller_name}StorageAccess of starknet::StorageAccess::<{library_caller_name}> {{
fn read(address_domain: u32, base: starknet::StorageBaseAddress) -> starknet::SyscallResult<{library_caller_name}> {{
starknet::StorageAccess::<{library_caller_name}>::read_at_offset_internal(address_domain, base, 0_u8)
}}
fn write(address_domain: u32, base: starknet::StorageBaseAddress, value: {library_caller_name}) -> starknet::SyscallResult<()> {{
starknet::StorageAccess::<{library_caller_name}>::write_at_offset_internal(address_domain, base, 0_u8, value)
}}
fn read_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8) -> starknet::SyscallResult<{library_caller_name}> {{
starknet::SyscallResult::Ok(
{library_caller_name} {{
class_hash: starknet::StorageAccess::<starknet::ClassHash>::read_at_offset_internal(address_domain, base, offset)?
}}
)
}}
fn write_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8, value: {library_caller_name}) -> starknet::SyscallResult<()> {{
starknet::StorageAccess::<starknet::ClassHash>::write_at_offset_internal(address_domain, base, offset, value.class_hash)
}}
fn size_internal(value: {library_caller_name}) -> u8 {{
1_u8
}}
}}
",
),
[
Expand All @@ -220,7 +176,8 @@ pub fn handle_trait(db: &dyn SyntaxGroup, trait_ast: ast::ItemTrait) -> PluginRe
"library_caller_method_impls".to_string(),
RewriteNode::new_modified(library_caller_method_impls),
),
].into(),
]
.into(),
));

PluginResult {
Expand Down
77 changes: 51 additions & 26 deletions crates/cairo-lang-starknet/src/plugin/plugin_test_data/dispatcher
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ trait IContractDispatcherTrait<T> {
fn empty(self: T, );
}

#[derive(Copy, Drop)]
#[derive(Copy, Drop, storage_access::StorageAccess)]
struct IContractDispatcher {
contract_address: starknet::ContractAddress,
}
Expand Down Expand Up @@ -82,7 +82,7 @@ impl IContractDispatcherImpl of IContractDispatcherTrait::<IContractDispatcher>

}

#[derive(Copy, Drop)]
#[derive(Copy, Drop, storage_access::StorageAccess)]
struct IContractLibraryDispatcher {
class_hash: starknet::ClassHash,
}
Expand Down Expand Up @@ -122,62 +122,87 @@ impl IContractLibraryDispatcherImpl of IContractDispatcherTrait::<IContractLibra

}

impl IContractDispatcherStorageAccess of starknet::StorageAccess::<IContractDispatcher> {

impls:

impl IContractDispatcherCopy<> of Copy::<IContractDispatcher<>>;
impl IContractDispatcherDrop<> of Drop::<IContractDispatcher<>>;


storage_access_impl:

impl StorageAccessIContractDispatcher of starknet::StorageAccess::<IContractDispatcher> {
fn read(address_domain: u32, base: starknet::StorageBaseAddress) -> starknet::SyscallResult<IContractDispatcher> {
starknet::StorageAccess::<IContractDispatcher>::read_at_offset_internal(address_domain, base, 0_u8)
let contract_address = starknet::StorageAccess::<starknet::ContractAddress>::read(address_domain, base)?;
starknet::SyscallResult::Ok(
IContractDispatcher {
contract_address,
}
)
}
fn write(address_domain: u32, base: starknet::StorageBaseAddress, value: IContractDispatcher) -> starknet::SyscallResult<()> {
starknet::StorageAccess::<IContractDispatcher>::write_at_offset_internal(address_domain, base, 0_u8, value)
starknet::StorageAccess::<starknet::ContractAddress>::write(address_domain, base, value.contract_address)?;
starknet::SyscallResult::Ok(())
}
fn read_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8) -> starknet::SyscallResult<IContractDispatcher> {
let contract_address = starknet::StorageAccess::<starknet::ContractAddress>::read_at_offset_internal(address_domain, base, offset)?;
starknet::SyscallResult::Ok(
IContractDispatcher {
contract_address: starknet::StorageAccess::<starknet::ContractAddress>::read_at_offset_internal(address_domain, base, offset)?
contract_address,
}
)
}
#[inline(always)]
fn write_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8, value: IContractDispatcher) -> starknet::SyscallResult<()> {
starknet::StorageAccess::<starknet::ContractAddress>::write_at_offset_internal(address_domain, base, offset, value.contract_address)
starknet::StorageAccess::<starknet::ContractAddress>::write_at_offset_internal(address_domain, base, offset, value.contract_address)?;
starknet::SyscallResult::Ok(())
}
#[inline(always)]
fn size_internal(value: IContractDispatcher) -> u8 {
1_u8
starknet::StorageAccess::<starknet::ContractAddress>::size_internal(value.contract_address)
}
}

impl IContractLibraryDispatcherStorageAccess of starknet::StorageAccess::<IContractLibraryDispatcher> {
impls:

impl IContractLibraryDispatcherCopy<> of Copy::<IContractLibraryDispatcher<>>;
impl IContractLibraryDispatcherDrop<> of Drop::<IContractLibraryDispatcher<>>;


storage_access_impl:

impl StorageAccessIContractLibraryDispatcher of starknet::StorageAccess::<IContractLibraryDispatcher> {
fn read(address_domain: u32, base: starknet::StorageBaseAddress) -> starknet::SyscallResult<IContractLibraryDispatcher> {
starknet::StorageAccess::<IContractLibraryDispatcher>::read_at_offset_internal(address_domain, base, 0_u8)
let class_hash = starknet::StorageAccess::<starknet::ClassHash>::read(address_domain, base)?;
starknet::SyscallResult::Ok(
IContractLibraryDispatcher {
class_hash,
}
)
}
fn write(address_domain: u32, base: starknet::StorageBaseAddress, value: IContractLibraryDispatcher) -> starknet::SyscallResult<()> {
starknet::StorageAccess::<IContractLibraryDispatcher>::write_at_offset_internal(address_domain, base, 0_u8, value)
starknet::StorageAccess::<starknet::ClassHash>::write(address_domain, base, value.class_hash)?;
starknet::SyscallResult::Ok(())
}
fn read_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8) -> starknet::SyscallResult<IContractLibraryDispatcher> {
let class_hash = starknet::StorageAccess::<starknet::ClassHash>::read_at_offset_internal(address_domain, base, offset)?;
starknet::SyscallResult::Ok(
IContractLibraryDispatcher {
class_hash: starknet::StorageAccess::<starknet::ClassHash>::read_at_offset_internal(address_domain, base, offset)?
class_hash,
}
)
}
#[inline(always)]
fn write_at_offset_internal(address_domain: u32, base: starknet::StorageBaseAddress, offset: u8, value: IContractLibraryDispatcher) -> starknet::SyscallResult<()> {
starknet::StorageAccess::<starknet::ClassHash>::write_at_offset_internal(address_domain, base, offset, value.class_hash)
starknet::StorageAccess::<starknet::ClassHash>::write_at_offset_internal(address_domain, base, offset, value.class_hash)?;
starknet::SyscallResult::Ok(())
}
#[inline(always)]
fn size_internal(value: IContractLibraryDispatcher) -> u8 {
1_u8
starknet::StorageAccess::<starknet::ClassHash>::size_internal(value.class_hash)
}
}


impls:

impl IContractDispatcherCopy<> of Copy::<IContractDispatcher<>>;
impl IContractDispatcherDrop<> of Drop::<IContractDispatcher<>>;


impls:

impl IContractLibraryDispatcherCopy<> of Copy::<IContractLibraryDispatcher<>>;
impl IContractLibraryDispatcherDrop<> of Drop::<IContractLibraryDispatcher<>>;

//! > expected_diagnostics
error: Plugin diagnostic: `ref` parameters are not supported in the ABI of a contract.
--> lib.cairo:7:16
Expand Down