Account

Reference of interfaces, presets, and utilities related to account contracts.

Core

ISRC6 

use openzeppelin::account::interface::ISRC6;

Interface of the SRC6 Standard Account as defined in the SNIP-6.

SRC5 ID

0x2ceccef7f994940b3962a6c67e0ba4fcd37df7d131417c604f91e03caecc1cd

Functions

Functions

__execute__(calls: Array<Call>) → Array<Span<felt252>> external

Executes the list of calls as a transaction after validation.

Returns an array with each call’s output.

The Call struct is defined in corelib.

__validate__(calls: Array<Call>) → felt252 external

Validates a transaction before execution.

Returns the short string 'VALID' if valid, otherwise it reverts.

is_valid_signature(hash: felt252, signature: Array<felt252>) → felt252 external

Validates whether a signature is valid or not for the given message hash.

Returns the short string 'VALID' if valid, otherwise it reverts.

AccountComponent 

use openzeppelin::account::AccountComponent;

Account component implementing ISRC6.

Implementing SRC5Component is a requirement for this component to be implemented.
Embeddable Implementations (camelCase)
SRC6CamelOnlyImpl
PublicKeyCamelImpl
Internal Implementations
InternalImpl
Events

Embeddable Functions

__execute__(self: @ContractState, calls: Array<Call>) → Array<Span<felt252>> external

See ISRC6::__execute__.

__validate__(self: @ContractState, calls: Array<Call>) → felt252 external

See ISRC6::__validate__.

is_valid_signature(self: @ContractState, hash: felt252, signature: Array<felt252>) → felt252 external

See ISRC6::is_valid_signature.

__validate_declare__(self: @ContractState, class_hash: felt252) → felt252 external

Validates a Declare transaction.

Returns the short string 'VALID' if valid, otherwise it reverts.

__validate_deploy__(self: @ContractState, class_hash: felt252, contract_address_salt: felt252, public_key: felt252) → felt252 external

Validates a DeployAccount transaction. See Counterfactual Deployments.

Returns the short string 'VALID' if valid, otherwise it reverts.

get_public_key(self: @ContractState) → felt252 external

Returns the current public key of the account.

set_public_key(ref self: ContractState, new_public_key: felt252) external

Sets a new public key for the account. Only accessible by the account calling itself through __execute__.

Emits both an OwnerRemoved and an OwnerAdded event.

camelCase Support

isValidSignature(self: @ContractState, hash: felt252, signature: Array<felt252>) → felt252 external

See ISRC6::is_valid_signature.

getPublicKey(self: @ContractState) → felt252 external

See get_public_key.

setPublicKey(ref self: ContractState, newPublicKey: felt252) external

See set_public_key.

Internal Functions

initializer(ref self: ComponentState, public_key: felt252) internal

Initializes the account with the given public key, and registers the ISRC6 interface ID.

Emits an OwnerAdded event.

assert_only_self(self: @ComponentState) internal

Validates that the caller is the account itself. Otherwise it reverts.

validate_transaction(self: @ComponentState) → felt252 internal

Validates a transaction signature from the global context.

Returns the short string 'VALID' if valid, otherwise it reverts.

_set_public_key(ref self: ComponentState, new_public_key: felt252) internal

Set the public key without validating the caller.

Emits an OwnerAdded event.

The usage of this method outside the set_public_key function is discouraged.

_is_valid_signature(self: @ComponentState, hash: felt252, signature: Span<felt252>) → bool internal

Validates the provided signature for the hash, using the account’s current public key.

Events

OwnerAdded(new_owner_guid: felt252) event

Emitted when a public_key is added.

OwnerRemoved(removed_owner_guid: felt252) event

Emitted when a public_key is removed.

Presets

Account 

use openzeppelin::presets::Account;

Basic account contract leveraging AccountComponent.

Sierra class hash

0x061dac032f228abef9c6626f995015233097ae253a7f72d68552db02f2971b8f

Constructor
Embedded Implementations
AccountComponent
SRC5Component

Constructor

constructor(ref self: ContractState, public_key: felt252) constructor

Sets the account public_key and registers the interfaces the contract supports.

← Accounts
Introspection →