Struct ITIP20Instance 

pub struct ITIP20Instance<P, N = Ethereum> {
    address: Address,
    provider: P,
    _network: PhantomData<N>,
}

A ITIP20 instance.

Contains type-safe methods for interacting with an on-chain instance of the ITIP20 contract located at a given address, using a given provider P.

If the contract bytecode is available (see the sol! documentation on how to provide it), the deploy and deploy_builder methods can be used to deploy a new instance of the contract.

See the module-level documentation for all the available methods.

Fields

address: Address

provider: P

_network: PhantomData<N>

Implementations

impl<P: Provider<N>, N: Network> ITIP20Instance<P, N>

Instantiation and getters/setters.

pub const fn new(address: Address, __provider: P) -> Self

Creates a new wrapper around an on-chain ITIP20 contract instance.

See the wrapper’s documentation for more details.

pub const fn address(&self) -> &Address

Returns a reference to the address.

pub fn set_address(&mut self, address: Address)

Sets the address.

pub fn at(self, address: Address) -> Self

Sets the address and returns self.

pub const fn provider(&self) -> &P

Returns a reference to the provider.

impl<P: Clone, N> ITIP20Instance<&P, N>

pub fn with_cloned_provider(self) -> ITIP20Instance<P, N>

Clones the provider and returns a new instance with the cloned provider.

impl<P: Provider<N>, N: Network> ITIP20Instance<P, N>

Function calls.

pub fn call_builder<C: SolCall>(&self, call: &C) -> SolCallBuilder<&P, C, N>

Creates a new call builder using this contract instance’s provider and address.

Note that the call can be any function call, not just those defined in this contract. Prefer using the other methods for building type-safe contract calls.

pub fn name(&self) -> SolCallBuilder<&P, nameCall, N>

Creates a new call builder for the [name] function.

pub fn symbol(&self) -> SolCallBuilder<&P, symbolCall, N>

Creates a new call builder for the [symbol] function.

pub fn decimals(&self) -> SolCallBuilder<&P, decimalsCall, N>

Creates a new call builder for the [decimals] function.

pub fn totalSupply(&self) -> SolCallBuilder<&P, totalSupplyCall, N>

Creates a new call builder for the [totalSupply] function.

pub fn quoteToken(&self) -> SolCallBuilder<&P, quoteTokenCall, N>

Creates a new call builder for the [quoteToken] function.

pub fn nextQuoteToken(&self) -> SolCallBuilder<&P, nextQuoteTokenCall, N>

Creates a new call builder for the [nextQuoteToken] function.

pub fn balanceOf( &self, account: Address, ) -> SolCallBuilder<&P, balanceOfCall, N>

Creates a new call builder for the [balanceOf] function.

pub fn transfer( &self, to: Address, amount: U256, ) -> SolCallBuilder<&P, transferCall, N>

Creates a new call builder for the [transfer] function.

pub fn approve( &self, spender: Address, amount: U256, ) -> SolCallBuilder<&P, approveCall, N>

Creates a new call builder for the [approve] function.

pub fn allowance( &self, owner: Address, spender: Address, ) -> SolCallBuilder<&P, allowanceCall, N>

Creates a new call builder for the [allowance] function.

pub fn transferFrom( &self, from: Address, to: Address, amount: U256, ) -> SolCallBuilder<&P, transferFromCall, N>

Creates a new call builder for the [transferFrom] function.

pub fn mint(&self, to: Address, amount: U256) -> SolCallBuilder<&P, mintCall, N>

Creates a new call builder for the [mint] function.

pub fn burn(&self, amount: U256) -> SolCallBuilder<&P, burnCall, N>

Creates a new call builder for the [burn] function.

pub fn currency(&self) -> SolCallBuilder<&P, currencyCall, N>

Creates a new call builder for the [currency] function.

pub fn supplyCap(&self) -> SolCallBuilder<&P, supplyCapCall, N>

Creates a new call builder for the [supplyCap] function.

pub fn paused(&self) -> SolCallBuilder<&P, pausedCall, N>

Creates a new call builder for the [paused] function.

pub fn transferPolicyId(&self) -> SolCallBuilder<&P, transferPolicyIdCall, N>

Creates a new call builder for the [transferPolicyId] function.

pub fn burnBlocked( &self, from: Address, amount: U256, ) -> SolCallBuilder<&P, burnBlockedCall, N>

Creates a new call builder for the [burnBlocked] function.

pub fn mintWithMemo( &self, to: Address, amount: U256, memo: FixedBytes<32>, ) -> SolCallBuilder<&P, mintWithMemoCall, N>

Creates a new call builder for the [mintWithMemo] function.

pub fn burnWithMemo( &self, amount: U256, memo: FixedBytes<32>, ) -> SolCallBuilder<&P, burnWithMemoCall, N>

Creates a new call builder for the [burnWithMemo] function.

pub fn transferWithMemo( &self, to: Address, amount: U256, memo: FixedBytes<32>, ) -> SolCallBuilder<&P, transferWithMemoCall, N>

Creates a new call builder for the [transferWithMemo] function.

pub fn transferFromWithMemo( &self, from: Address, to: Address, amount: U256, memo: FixedBytes<32>, ) -> SolCallBuilder<&P, transferFromWithMemoCall, N>

Creates a new call builder for the [transferFromWithMemo] function.

pub fn feeRecipient(&self) -> SolCallBuilder<&P, feeRecipientCall, N>

Creates a new call builder for the [feeRecipient] function.

pub fn setFeeRecipient( &self, newRecipient: Address, ) -> SolCallBuilder<&P, setFeeRecipientCall, N>

Creates a new call builder for the [setFeeRecipient] function.

pub fn changeTransferPolicyId( &self, newPolicyId: u64, ) -> SolCallBuilder<&P, changeTransferPolicyIdCall, N>

Creates a new call builder for the [changeTransferPolicyId] function.

pub fn setSupplyCap( &self, newSupplyCap: U256, ) -> SolCallBuilder<&P, setSupplyCapCall, N>

Creates a new call builder for the [setSupplyCap] function.

pub fn pause(&self) -> SolCallBuilder<&P, pauseCall, N>

Creates a new call builder for the [pause] function.

pub fn unpause(&self) -> SolCallBuilder<&P, unpauseCall, N>

Creates a new call builder for the [unpause] function.

pub fn setNextQuoteToken( &self, newQuoteToken: Address, ) -> SolCallBuilder<&P, setNextQuoteTokenCall, N>

Creates a new call builder for the [setNextQuoteToken] function.

pub fn completeQuoteTokenUpdate( &self, ) -> SolCallBuilder<&P, completeQuoteTokenUpdateCall, N>

Creates a new call builder for the [completeQuoteTokenUpdate] function.

pub fn PAUSE_ROLE(&self) -> SolCallBuilder<&P, PAUSE_ROLECall, N>

Creates a new call builder for the [PAUSE_ROLE] function.

pub fn UNPAUSE_ROLE(&self) -> SolCallBuilder<&P, UNPAUSE_ROLECall, N>

Creates a new call builder for the [UNPAUSE_ROLE] function.

pub fn ISSUER_ROLE(&self) -> SolCallBuilder<&P, ISSUER_ROLECall, N>

Creates a new call builder for the [ISSUER_ROLE] function.

pub fn BURN_BLOCKED_ROLE(&self) -> SolCallBuilder<&P, BURN_BLOCKED_ROLECall, N>

Creates a new call builder for the [BURN_BLOCKED_ROLE] function.

pub fn startReward( &self, amount: U256, secs: u32, ) -> SolCallBuilder<&P, startRewardCall, N>

Creates a new call builder for the [startReward] function.

pub fn setRewardRecipient( &self, recipient: Address, ) -> SolCallBuilder<&P, setRewardRecipientCall, N>

Creates a new call builder for the [setRewardRecipient] function.

pub fn cancelReward(&self, id: u64) -> SolCallBuilder<&P, cancelRewardCall, N>

Creates a new call builder for the [cancelReward] function.

pub fn claimRewards(&self) -> SolCallBuilder<&P, claimRewardsCall, N>

Creates a new call builder for the [claimRewards] function.

pub fn finalizeStreams( &self, timestamp: u64, ) -> SolCallBuilder<&P, finalizeStreamsCall, N>

Creates a new call builder for the [finalizeStreams] function.

pub fn getStream(&self, id: u64) -> SolCallBuilder<&P, getStreamCall, N>

Creates a new call builder for the [getStream] function.

pub fn totalRewardPerSecond( &self, ) -> SolCallBuilder<&P, totalRewardPerSecondCall, N>

Creates a new call builder for the [totalRewardPerSecond] function.

pub fn optedInSupply(&self) -> SolCallBuilder<&P, optedInSupplyCall, N>

Creates a new call builder for the [optedInSupply] function.

pub fn nextStreamId(&self) -> SolCallBuilder<&P, nextStreamIdCall, N>

Creates a new call builder for the [nextStreamId] function.

pub fn userRewardInfo( &self, account: Address, ) -> SolCallBuilder<&P, userRewardInfoCall, N>

Creates a new call builder for the [userRewardInfo] function.

impl<P: Provider<N>, N: Network> ITIP20Instance<P, N>

Event filters.

pub fn event_filter<E: SolEvent>(&self) -> Event<&P, E, N>

Creates a new event filter using this contract instance’s provider and address.

Note that the type can be any event, not just those defined in this contract. Prefer using the other methods for building type-safe event filters.

pub fn Transfer_filter(&self) -> Event<&P, Transfer, N>

Creates a new event filter for the Transfer event.

pub fn Approval_filter(&self) -> Event<&P, Approval, N>

Creates a new event filter for the Approval event.

pub fn Mint_filter(&self) -> Event<&P, Mint, N>

Creates a new event filter for the Mint event.

pub fn Burn_filter(&self) -> Event<&P, Burn, N>

Creates a new event filter for the Burn event.

pub fn BurnBlocked_filter(&self) -> Event<&P, BurnBlocked, N>

Creates a new event filter for the BurnBlocked event.

pub fn TransferWithMemo_filter(&self) -> Event<&P, TransferWithMemo, N>

Creates a new event filter for the TransferWithMemo event.

pub fn TransferPolicyUpdate_filter(&self) -> Event<&P, TransferPolicyUpdate, N>

Creates a new event filter for the TransferPolicyUpdate event.

pub fn SupplyCapUpdate_filter(&self) -> Event<&P, SupplyCapUpdate, N>

Creates a new event filter for the SupplyCapUpdate event.

pub fn PauseStateUpdate_filter(&self) -> Event<&P, PauseStateUpdate, N>

Creates a new event filter for the PauseStateUpdate event.

pub fn NextQuoteTokenSet_filter(&self) -> Event<&P, NextQuoteTokenSet, N>

Creates a new event filter for the NextQuoteTokenSet event.

pub fn QuoteTokenUpdate_filter(&self) -> Event<&P, QuoteTokenUpdate, N>

Creates a new event filter for the QuoteTokenUpdate event.

pub fn RewardScheduled_filter(&self) -> Event<&P, RewardScheduled, N>

Creates a new event filter for the RewardScheduled event.

pub fn RewardCanceled_filter(&self) -> Event<&P, RewardCanceled, N>

Creates a new event filter for the RewardCanceled event.

pub fn RewardRecipientSet_filter(&self) -> Event<&P, RewardRecipientSet, N>

Creates a new event filter for the RewardRecipientSet event.

pub fn FeeRecipientUpdated_filter(&self) -> Event<&P, FeeRecipientUpdated, N>

Creates a new event filter for the FeeRecipientUpdated event.

Trait Implementations

impl<P: Clone, N: Clone> Clone for ITIP20Instance<P, N>

fn clone(&self) -> ITIP20Instance<P, N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P, N> Debug for ITIP20Instance<P, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.