Struct TIP20Setup 

pub struct TIP20Setup {
    action: Action,
    quote_token: Option<Address>,
    admin: Option<Address>,
    salt: Option<B256>,
    roles: Vec<(Address, B256)>,
    mints: Vec<(Address, U256)>,
    approvals: Vec<(Address, Address, U256)>,
    reward_opt_ins: Vec<Address>,
    distribute_rewards: Vec<U256>,
    clear_events: bool,
}

Available on crate features test-utils only.

Helper for TIP20 token setup in tests.

Supports creating new tokens, configuring pathUSD, or modifying existing tokens. Uses a chainable API for role grants, minting, approvals, and rewards.

Examples

// Initialize and configure pathUSD
TIP20Setup::path_usd(admin)
    .with_issuer(admin)
    .apply()?;

// Create a new token
let token = TIP20Setup::new("MyToken", "MTK", admin)
    .with_mint(user, amount)
    .apply()?;

// Configure an existing token
TIP20Setup::from_address(token_address, admin)
    .with_mint(user, amount)
    .apply()?;

Fields

action: Action

quote_token: Option<Address>

admin: Option<Address>

salt: Option<B256>

roles: Vec<(Address, B256)>

mints: Vec<(Address, U256)>

approvals: Vec<(Address, Address, U256)>

reward_opt_ins: Vec<Address>

distribute_rewards: Vec<U256>

clear_events: bool

Implementations

impl TIP20Setup

pub fn path_usd(admin: Address) -> Self

Configure pathUSD (token 0).

pub fn create(name: &'static str, symbol: &'static str, admin: Address) -> Self

Create a new token via factory. Ensures that pathUSD and TIP20Factory are initialized.

Defaults to currency: "USD", quote_token: pathUSD

pub fn config(address: Address) -> Self

Configure an existing token at the given address.

pub fn clear_events(self) -> Self

Clears emitted events for the token after applying the configuration.

SAFETY: the caller must ensure the test uses HashMapStorageProvider.

pub fn currency(self, currency: impl Into<String>) -> Self

Set the token currency (default: “USD”). Only applies to new tokens.

pub fn quote_token(self, token: Address) -> Self

Set a custom quote token (default: pathUSD).

pub fn with_salt(self, salt: B256) -> Self

Set a custom salt for token address derivation (default: random).

pub fn with_admin(self, admin: Address) -> Self

Set the admin address explicitly. Required for config() when using with_mint().

pub fn with_issuer(self, account: Address) -> Self

Grant ISSUER_ROLE to an account.

pub fn with_role(self, account: Address, role: B256) -> Self

Grant an arbitrary role to an account.

pub fn with_mint(self, to: Address, amount: U256) -> Self

Mint tokens to an address after creation.

Note: Requires ISSUER_ROLE on admin (use with_issuer(admin)).

pub fn with_approval( self, owner: Address, spender: Address, amount: U256, ) -> Self

Set an approval from owner to spender.

pub fn with_reward_opt_in(self, user: Address) -> Self

Opt a user into rewards (sets reward recipient to themselves).

pub fn with_reward(self, amount: U256) -> Self

Distribute rewards (requires tokens minted to admin first).

fn path_usd_inner(&self) -> Result<TIP20Token>

Initialize pathUSD if needed and return it.

pub fn factory() -> Result<TIP20Factory>

Returns the TIP20Factory, initializing it if not yet deployed.

pub fn apply(self) -> Result<TIP20Token>

Applies the configuration and returns the fully configured TIP20Token.

pub fn expect_err(self, expected: TempoPrecompileError)

Applies the configuration and asserts it fails with expected.

pub fn expect_tip20_err(self, expected: TIP20Error)

Applies the configuration and asserts it fails with the given TIP20Error.

Trait Implementations

impl Default for TIP20Setup

fn default() -> TIP20Setup

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 256 bytes