starkware_utils_testing
Fully qualified path: starkware_utils_testing
Modules
Modules
Modules
constants
Fully qualified path: starkware_utils_testing::constants
Constants
| WRONG_ADMIN | — |
| INITIAL_ROOT_ADMIN | — |
| GOVERNANCE_ADMIN | — |
| SECURITY_ADMIN | — |
| APP_ROLE_ADMIN | — |
| APP_GOVERNOR | — |
| OPERATOR | — |
| TOKEN_ADMIN | — |
| UPGRADE_GOVERNOR | — |
| SECURITY_AGENT | — |
| DUMMY_ADDRESS | — |
Constants
Constants
| WRONG_ADMIN | — |
| INITIAL_ROOT_ADMIN | — |
| GOVERNANCE_ADMIN | — |
| SECURITY_ADMIN | — |
| APP_ROLE_ADMIN | — |
| APP_GOVERNOR | — |
| OPERATOR | — |
| TOKEN_ADMIN | — |
| UPGRADE_GOVERNOR | — |
| SECURITY_AGENT | — |
| DUMMY_ADDRESS | — |
WRONG_ADMIN
Fully qualified path: starkware_utils_testing::constants::WRONG_ADMIN
pub const WRONG_ADMIN: ContractAddress = 'WRONG_ADMIN'
.try_into()
.unwrap(); // = 105565243291431664389802318
INITIAL_ROOT_ADMIN
Fully qualified path: starkware_utils_testing::constants::INITIAL_ROOT_ADMIN
pub const INITIAL_ROOT_ADMIN: ContractAddress = 'INITIAL_ROOT_ADMIN'
.try_into()
.unwrap(); // = 6385836368920748988865326126724073682454862
GOVERNANCE_ADMIN
Fully qualified path: starkware_utils_testing::constants::GOVERNANCE_ADMIN
pub const GOVERNANCE_ADMIN: ContractAddress = 'GOVERNANCE_ADMIN'
.try_into()
.unwrap(); // = 94787128931994781303515010203256703310
SECURITY_ADMIN
Fully qualified path: starkware_utils_testing::constants::SECURITY_ADMIN
pub const SECURITY_ADMIN: ContractAddress = 'SECURITY_ADMIN'
.try_into()
.unwrap(); // = 1688927578959512323751258541082958
APP_ROLE_ADMIN
Fully qualified path: starkware_utils_testing::constants::APP_ROLE_ADMIN
pub const APP_ROLE_ADMIN: ContractAddress = 'APP_ROLE_ADMIN'
.try_into()
.unwrap(); // = 1324719751275935135840112590276942
APP_GOVERNOR
Fully qualified path: starkware_utils_testing::constants::APP_GOVERNOR
pub const APP_GOVERNOR: ContractAddress = 'APP_GOVERNOR'
.try_into()
.unwrap(); // = 20213619250854336930698383186
OPERATOR
Fully qualified path: starkware_utils_testing::constants::OPERATOR
pub const OPERATOR: ContractAddress = 'OPERATOR'.try_into().unwrap(); // = 5715144146718838610
TOKEN_ADMIN
Fully qualified path: starkware_utils_testing::constants::TOKEN_ADMIN
pub const TOKEN_ADMIN: ContractAddress = 'TOKEN_ADMIN'
.try_into()
.unwrap(); // = 101924224299614851587459406
UPGRADE_GOVERNOR
Fully qualified path: starkware_utils_testing::constants::UPGRADE_GOVERNOR
pub const UPGRADE_GOVERNOR: ContractAddress = 'UPGRADE_GOVERNOR'
.try_into()
.unwrap(); // = 113401209958390881040369472570116689746
SECURITY_AGENT
Fully qualified path: starkware_utils_testing::constants::SECURITY_AGENT
pub const SECURITY_AGENT: ContractAddress = 'SECURITY_AGENT'
.try_into()
.unwrap(); // = 1688927578959512323751258590891604
DUMMY_ADDRESS
Fully qualified path: starkware_utils_testing::constants::DUMMY_ADDRESS
pub const DUMMY_ADDRESS: ContractAddress = 'DUMMY_ADDRESS'
.try_into()
.unwrap(); // = 5413914729363742859539197023059
event_test_utils
Fully qualified path: starkware_utils_testing::event_test_utils
Free functions
Free functions
Free functions
is_emitted
Fully qualified path: starkware_utils_testing::event_test_utils::is_emitted
pub fn is_emitted<T, impl TEvent: Event<T>, impl TDrop: Drop<T>>(
self: @Events, expected_emitted_by: @ContractAddress, expected_event: @T,
) -> bool
assert_number_of_events
Fully qualified path: starkware_utils_testing::event_test_utils::assert_number_of_events
pub fn assert_number_of_events(actual: u32, expected: u32, message: ByteArray)
panic_with_event_details
Fully qualified path: starkware_utils_testing::event_test_utils::panic_with_event_details
pub fn panic_with_event_details(expected_emitted_by: @ContractAddress, details: ByteArray)
test_utils
Fully qualified path: starkware_utils_testing::test_utils
Free functions
Structs
| TokenConfig | The TokenConfig struct is used to configure the initial settings for a token contract. It includes the initial supply of tokens and the owner’s address. |
| TokenState | The TokenState struct represents the state of a token contract. It includes the contract address and the owner’s address. |
Traits
Impls
Free functions
Free functions
set_account_as_security_admin
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_security_admin
pub fn set_account_as_security_admin(
contract: ContractAddress, account: ContractAddress, governance_admin: ContractAddress,
)
set_account_as_security_agent
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_security_agent
pub fn set_account_as_security_agent(
contract: ContractAddress, account: ContractAddress, security_admin: ContractAddress,
)
set_account_as_app_role_admin
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_app_role_admin
pub fn set_account_as_app_role_admin(
contract: ContractAddress, account: ContractAddress, governance_admin: ContractAddress,
)
set_account_as_operator
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_operator
pub fn set_account_as_operator(
contract: ContractAddress, account: ContractAddress, app_role_admin: ContractAddress,
)
set_account_as_app_governor
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_app_governor
pub fn set_account_as_app_governor(
contract: ContractAddress, account: ContractAddress, app_role_admin: ContractAddress,
)
set_account_as_upgrade_governor
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_upgrade_governor
pub fn set_account_as_upgrade_governor(
contract: ContractAddress, account: ContractAddress, governance_admin: ContractAddress,
)
set_account_as_token_admin
Fully qualified path: starkware_utils_testing::test_utils::set_account_as_token_admin
pub fn set_account_as_token_admin(
contract: ContractAddress, account: ContractAddress, app_role_admin: ContractAddress,
)
cheat_caller_address_once
Fully qualified path: starkware_utils_testing::test_utils::cheat_caller_address_once
pub fn cheat_caller_address_once(contract_address: ContractAddress, caller_address: ContractAddress)
advance_block_number_global
Fully qualified path: starkware_utils_testing::test_utils::advance_block_number_global
pub fn advance_block_number_global(blocks: u64)
check_identity
Fully qualified path: starkware_utils_testing::test_utils::check_identity
pub fn check_identity(
target: ContractAddress, expected_identity: felt252, expected_version: felt252,
)
assert_panic_with_error
Fully qualified path: starkware_utils_testing::test_utils::assert_panic_with_error
pub fn assert_panic_with_error<T, +Drop<T>>(
result: Result<T, Array<felt252>>, expected_error: ByteArray,
)
assert_panic_with_felt_error
Fully qualified path: starkware_utils_testing::test_utils::assert_panic_with_felt_error
pub fn assert_panic_with_felt_error<T, +Drop<T>>(
result: Result<T, Array<felt252>>, expected_error: felt252,
)
assert_expected_error
Fully qualified path: starkware_utils_testing::test_utils::assert_expected_error
pub fn assert_expected_error(error_data: Span<felt252>, expected_error: ByteArray)
assert_expected_event_emitted
Fully qualified path: starkware_utils_testing::test_utils::assert_expected_event_emitted
pub fn assert_expected_event_emitted<T, +starknet::Event<T>, +Drop<T>, +Debug<T>, +PartialEq<T>>(
spied_event: @(ContractAddress, Event),
expected_event: T,
expected_event_selector: @felt252,
expected_event_name: ByteArray,
)
Structs
Structs
| TokenConfig | The TokenConfig struct is used to configure the initial settings for a token contract. It includes the initial supply of tokens and the owner’s address. |
| TokenState | The TokenState struct represents the state of a token contract. It includes the contract address and the owner’s address. |
TokenConfig
The TokenConfig struct is used to configure the initial settings for a token contract.
It includes the initial supply of tokens and the owner’s address.
Fully qualified path: starkware_utils_testing::test_utils::TokenConfig
[derive(Drop)]
pub struct TokenConfig {
pub name: ByteArray,
pub symbol: ByteArray,
pub initial_supply: u256,
pub owner: ContractAddress,
}
Members
name
Fully qualified path: starkware_utils_testing::test_utils::TokenConfig::name
pub name: ByteArray
symbol
Fully qualified path: starkware_utils_testing::test_utils::TokenConfig::symbol
pub symbol: ByteArray
initial_supply
Fully qualified path: starkware_utils_testing::test_utils::TokenConfig::initial_supply
pub initial_supply: u256
owner
Fully qualified path: starkware_utils_testing::test_utils::TokenConfig::owner
pub owner: ContractAddress
TokenState
The TokenState struct represents the state of a token contract.
It includes the contract address and the owner’s address.
Fully qualified path: starkware_utils_testing::test_utils::TokenState
[derive(Drop, Copy)]
pub struct TokenState {
pub address: ContractAddress,
pub owner: ContractAddress,
}
Members
address
Fully qualified path: starkware_utils_testing::test_utils::TokenState::address
pub address: ContractAddress
owner
Fully qualified path: starkware_utils_testing::test_utils::TokenState::owner
pub owner: ContractAddress
Traits
Traits
Deployable
Fully qualified path: starkware_utils_testing::test_utils::Deployable
pub trait Deployable<T, V>
Trait functions
deploy
Fully qualified path: starkware_utils_testing::test_utils::Deployable::deploy
fn deploy(self: @T) -> V
TokenTrait
Fully qualified path: starkware_utils_testing::test_utils::TokenTrait
pub trait TokenTrait<TTokenState>
Trait functions
fund
Fully qualified path: starkware_utils_testing::test_utils::TokenTrait::fund
fn fund(self: TTokenState, recipient: ContractAddress, amount: u128)
approve
Fully qualified path: starkware_utils_testing::test_utils::TokenTrait::approve
fn approve(self: TTokenState, owner: ContractAddress, spender: ContractAddress, amount: u128)
balance_of
Fully qualified path: starkware_utils_testing::test_utils::TokenTrait::balance_of
fn balance_of(self: TTokenState, account: ContractAddress) -> u128
Impls
Impls
TokenDeployImpl
Fully qualified path: starkware_utils_testing::test_utils::TokenDeployImpl
pub impl TokenDeployImpl of Deployable<TokenConfig, TokenState>;
Impl functions
deploy
Fully qualified path: starkware_utils_testing::test_utils::TokenDeployImpl::deploy
fn deploy(self: @TokenConfig) -> TokenState
TokenImpl
Fully qualified path: starkware_utils_testing::test_utils::TokenImpl
pub impl TokenImpl of TokenTrait<TokenState>;
Impl functions
fund
Fully qualified path: starkware_utils_testing::test_utils::TokenImpl::fund
fn fund(self: TokenState, recipient: ContractAddress, amount: u128)
approve
Fully qualified path: starkware_utils_testing::test_utils::TokenImpl::approve
fn approve(self: TokenState, owner: ContractAddress, spender: ContractAddress, amount: u128)
balance_of
Fully qualified path: starkware_utils_testing::test_utils::TokenImpl::balance_of
fn balance_of(self: TokenState, account: ContractAddress) -> u128