Struct HoprTokenInstance

pub struct HoprTokenInstance<P, N = Ethereum> { /* private fields */ }

A HoprToken instance.

Contains type-safe methods for interacting with an on-chain instance of the HoprToken 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.

Implementations

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

Instantiation and getters/setters.

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

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

See the wrapper’s documentation for more details.

pub async fn deploy(provider: P) -> Result<HoprTokenInstance<P, N>>

Deploys this contract using the given provider and constructor arguments, if any.

Returns a new instance of the contract, if the deployment was successful.

For more fine-grained control over the deployment process, use deploy_builder instead.

pub fn deploy_builder(provider: P) -> RawCallBuilder<P, N>

Creates a RawCallBuilder for deploying this contract using the given provider and constructor arguments, if any.

This is a simple wrapper around creating a RawCallBuilder with the data set to the bytecode concatenated with the constructor’s ABI-encoded arguments.

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> HoprTokenInstance<&P, N>

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

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

impl<P: Provider<N>, N: Network> HoprTokenInstance<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 DEFAULT_ADMIN_ROLE( &self, ) -> SolCallBuilder<&P, DEFAULT_ADMIN_ROLECall, N>

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

pub fn MINTER_ROLE(&self) -> SolCallBuilder<&P, MINTER_ROLECall, N>

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

pub fn accountSnapshots( &self, _0: Address, _1: U256, ) -> SolCallBuilder<&P, accountSnapshotsCall, N>

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

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

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

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

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

pub fn authorizeOperator( &self, operator: Address, ) -> SolCallBuilder<&P, authorizeOperatorCall, N>

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

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

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

pub fn balanceOfAt( &self, _owner: Address, _blockNumber: u128, ) -> SolCallBuilder<&P, balanceOfAtCall, N>

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

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

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

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

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

pub fn defaultOperators(&self) -> SolCallBuilder<&P, defaultOperatorsCall, N>

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

pub fn getRoleAdmin( &self, role: FixedBytes<32>, ) -> SolCallBuilder<&P, getRoleAdminCall, N>

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

pub fn getRoleMember( &self, role: FixedBytes<32>, index: U256, ) -> SolCallBuilder<&P, getRoleMemberCall, N>

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

pub fn getRoleMemberCount( &self, role: FixedBytes<32>, ) -> SolCallBuilder<&P, getRoleMemberCountCall, N>

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

pub fn grantRole( &self, role: FixedBytes<32>, account: Address, ) -> SolCallBuilder<&P, grantRoleCall, N>

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

pub fn granularity(&self) -> SolCallBuilder<&P, granularityCall, N>

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

pub fn hasRole( &self, role: FixedBytes<32>, account: Address, ) -> SolCallBuilder<&P, hasRoleCall, N>

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

pub fn isOperatorFor( &self, operator: Address, tokenHolder: Address, ) -> SolCallBuilder<&P, isOperatorForCall, N>

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

pub fn mint( &self, account: Address, amount: U256, userData: Bytes, operatorData: Bytes, ) -> SolCallBuilder<&P, mintCall, N>

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

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

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

pub fn operatorBurn( &self, account: Address, amount: U256, data: Bytes, operatorData: Bytes, ) -> SolCallBuilder<&P, operatorBurnCall, N>

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

pub fn operatorSend( &self, sender: Address, recipient: Address, amount: U256, data: Bytes, operatorData: Bytes, ) -> SolCallBuilder<&P, operatorSendCall, N>

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

pub fn renounceRole( &self, role: FixedBytes<32>, account: Address, ) -> SolCallBuilder<&P, renounceRoleCall, N>

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

pub fn revokeOperator( &self, operator: Address, ) -> SolCallBuilder<&P, revokeOperatorCall, N>

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

pub fn revokeRole( &self, role: FixedBytes<32>, account: Address, ) -> SolCallBuilder<&P, revokeRoleCall, N>

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

pub fn send( &self, recipient: Address, amount: U256, data: Bytes, ) -> SolCallBuilder<&P, sendCall, N>

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

pub fn supportsInterface( &self, interfaceId: FixedBytes<4>, ) -> SolCallBuilder<&P, supportsInterfaceCall, N>

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

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

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

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

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

pub fn totalSupplyAt( &self, _blockNumber: u128, ) -> SolCallBuilder<&P, totalSupplyAtCall, N>

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

pub fn totalSupplySnapshots( &self, _0: U256, ) -> SolCallBuilder<&P, totalSupplySnapshotsCall, N>

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

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

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

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

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

impl<P: Provider<N>, N: Network> HoprTokenInstance<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 Approval_filter(&self) -> Event<&P, Approval, N>

Creates a new event filter for the Approval event.

pub fn AuthorizedOperator_filter(&self) -> Event<&P, AuthorizedOperator, N>

Creates a new event filter for the AuthorizedOperator event.

pub fn Burned_filter(&self) -> Event<&P, Burned, N>

Creates a new event filter for the Burned event.

pub fn Minted_filter(&self) -> Event<&P, Minted, N>

Creates a new event filter for the Minted event.

pub fn RevokedOperator_filter(&self) -> Event<&P, RevokedOperator, N>

Creates a new event filter for the RevokedOperator event.

pub fn RoleAdminChanged_filter(&self) -> Event<&P, RoleAdminChanged, N>

Creates a new event filter for the RoleAdminChanged event.

pub fn RoleGranted_filter(&self) -> Event<&P, RoleGranted, N>

Creates a new event filter for the RoleGranted event.

pub fn RoleRevoked_filter(&self) -> Event<&P, RoleRevoked, N>

Creates a new event filter for the RoleRevoked event.

pub fn Sent_filter(&self) -> Event<&P, Sent, N>

Creates a new event filter for the Sent event.

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

Creates a new event filter for the Transfer event.

Trait Implementations

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

fn clone(&self) -> HoprTokenInstance<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 HoprTokenInstance<P, N>

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

Formats the value using the given formatter.