Struct RateLimitNFTInstance

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

A RateLimitNFT instance.

Contains type-safe methods for interacting with an on-chain instance of the RateLimitNFT 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> RateLimitNFTInstance<P, N>

Instantiation and getters/setters.

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

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

See the wrapper’s documentation for more details.

pub async fn deploy(provider: P) -> Result<RateLimitNFTInstance<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> RateLimitNFTInstance<&P, N>

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

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

impl<P: Provider<N>, N: Network> RateLimitNFTInstance<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 RLIHolderRateLimitWindowSeconds( &self, ) -> SolCallBuilder<&P, RLIHolderRateLimitWindowSecondsCall, N>

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

pub fn additionalRequestsPerKilosecondCost( &self, ) -> SolCallBuilder<&P, additionalRequestsPerKilosecondCostCall, N>

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

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

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

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

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

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

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

pub fn calculateCost( &self, requestsPerKilosecond: U256, expiresAt: U256, ) -> SolCallBuilder<&P, calculateCostCall, N>

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

pub fn calculateRequestsPerKilosecond( &self, payingAmount: U256, expiresAt: U256, ) -> SolCallBuilder<&P, calculateRequestsPerKilosecondCall, N>

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

pub fn capacity(&self, tokenId: U256) -> SolCallBuilder<&P, capacityCall, N>

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

pub fn checkBelowMaxRequestsPerKilosecond( &self, requestedRequestsPerKilosecond: U256, ) -> SolCallBuilder<&P, checkBelowMaxRequestsPerKilosecondCall, N>

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

pub fn currentSoldRequestsPerKilosecond( &self, ) -> SolCallBuilder<&P, currentSoldRequestsPerKilosecondCall, N>

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

pub fn defaultRateLimitWindowSeconds( &self, ) -> SolCallBuilder<&P, defaultRateLimitWindowSecondsCall, N>

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

pub fn diamondCut( &self, _diamondCut: Vec<<FacetCut as SolType>::RustType>, _init: Address, _calldata: Bytes, ) -> SolCallBuilder<&P, diamondCutCall, N>

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

pub fn facetAddress( &self, _functionSelector: FixedBytes<4>, ) -> SolCallBuilder<&P, facetAddressCall, N>

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

pub fn facetAddresses(&self) -> SolCallBuilder<&P, facetAddressesCall, N>

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

pub fn facetFunctionSelectors( &self, _facet: Address, ) -> SolCallBuilder<&P, facetFunctionSelectorsCall, N>

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

pub fn facets(&self) -> SolCallBuilder<&P, facetsCall, N>

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

pub fn freeMint( &self, expiresAt: U256, requestsPerKilosecond: U256, msgHash: FixedBytes<32>, v: u8, r: FixedBytes<32>, sVal: FixedBytes<32>, ) -> SolCallBuilder<&P, freeMintCall, N>

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

pub fn freeMintSigTest( &self, expiresAt: U256, requestsPerKilosecond: U256, msgHash: FixedBytes<32>, v: u8, r: FixedBytes<32>, sVal: FixedBytes<32>, ) -> SolCallBuilder<&P, freeMintSigTestCall, N>

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

pub fn freeMintSigner(&self) -> SolCallBuilder<&P, freeMintSignerCall, N>

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

pub fn freeRequestsPerRateLimitWindow( &self, ) -> SolCallBuilder<&P, freeRequestsPerRateLimitWindowCall, N>

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

pub fn getApproved( &self, tokenId: U256, ) -> SolCallBuilder<&P, getApprovedCall, N>

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

pub fn initialize(&self) -> SolCallBuilder<&P, initializeCall, N>

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

pub fn isApprovedForAll( &self, owner: Address, operator: Address, ) -> SolCallBuilder<&P, isApprovedForAllCall, N>

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

pub fn isExpired(&self, tokenId: U256) -> SolCallBuilder<&P, isExpiredCall, N>

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

pub fn maxExpirationSeconds( &self, ) -> SolCallBuilder<&P, maxExpirationSecondsCall, N>

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

pub fn maxRequestsPerKilosecond( &self, ) -> SolCallBuilder<&P, maxRequestsPerKilosecondCall, N>

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

pub fn mint(&self, expiresAt: U256) -> 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 owner(&self) -> SolCallBuilder<&P, ownerCall, N>

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

pub fn ownerOf(&self, tokenId: U256) -> SolCallBuilder<&P, ownerOfCall, N>

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

pub fn prefixed( &self, hash: FixedBytes<32>, ) -> SolCallBuilder<&P, prefixedCall, N>

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

pub fn pruneExpired( &self, owner: Address, ) -> SolCallBuilder<&P, pruneExpiredCall, N>

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

pub fn redeemedFreeMints( &self, msgHash: FixedBytes<32>, ) -> SolCallBuilder<&P, redeemedFreeMintsCall, N>

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

pub fn safeTransferFrom_0( &self, from: Address, to: Address, tokenId: U256, ) -> SolCallBuilder<&P, safeTransferFrom_0Call, N>

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

pub fn safeTransferFrom_1( &self, from: Address, to: Address, tokenId: U256, data: Bytes, ) -> SolCallBuilder<&P, safeTransferFrom_1Call, N>

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

pub fn setAdditionalRequestsPerKilosecondCost( &self, newAdditionalRequestsPerKilosecondCost: U256, ) -> SolCallBuilder<&P, setAdditionalRequestsPerKilosecondCostCall, N>

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

pub fn setApprovalForAll( &self, operator: Address, approved: bool, ) -> SolCallBuilder<&P, setApprovalForAllCall, N>

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

pub fn setFreeMintSigner( &self, newFreeMintSigner: Address, ) -> SolCallBuilder<&P, setFreeMintSignerCall, N>

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

pub fn setFreeRequestsPerRateLimitWindow( &self, newFreeRequestsPerRateLimitWindow: U256, ) -> SolCallBuilder<&P, setFreeRequestsPerRateLimitWindowCall, N>

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

pub fn setMaxExpirationSeconds( &self, newMaxExpirationSeconds: U256, ) -> SolCallBuilder<&P, setMaxExpirationSecondsCall, N>

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

pub fn setMaxRequestsPerKilosecond( &self, newMaxRequestsPerKilosecond: U256, ) -> SolCallBuilder<&P, setMaxRequestsPerKilosecondCall, N>

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

pub fn setRLIHolderRateLimitWindowSeconds( &self, newRLIHolderRateLimitWindowSeconds: U256, ) -> SolCallBuilder<&P, setRLIHolderRateLimitWindowSecondsCall, N>

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

pub fn setRateLimitWindowSeconds( &self, newRateLimitWindowSeconds: U256, ) -> SolCallBuilder<&P, setRateLimitWindowSecondsCall, N>

Creates a new call builder for the [setRateLimitWindowSeconds] 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 tokenByIndex( &self, index: U256, ) -> SolCallBuilder<&P, tokenByIndexCall, N>

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

pub fn tokenIdCounter(&self) -> SolCallBuilder<&P, tokenIdCounterCall, N>

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

pub fn tokenOfOwnerByIndex( &self, owner: Address, index: U256, ) -> SolCallBuilder<&P, tokenOfOwnerByIndexCall, N>

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

pub fn tokenSVG(&self, tokenId: U256) -> SolCallBuilder<&P, tokenSVGCall, N>

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

pub fn tokenURI(&self, tokenId: U256) -> SolCallBuilder<&P, tokenURICall, N>

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

pub fn totalSoldRequestsPerKilosecondByExpirationTime( &self, expiresAt: U256, ) -> SolCallBuilder<&P, totalSoldRequestsPerKilosecondByExpirationTimeCall, N>

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

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

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

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

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

pub fn transferOwnership( &self, _newOwner: Address, ) -> SolCallBuilder<&P, transferOwnershipCall, N>

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

pub fn withdraw(&self) -> SolCallBuilder<&P, withdrawCall, N>

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

impl<P: Provider<N>, N: Network> RateLimitNFTInstance<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 AdditionalRequestsPerKilosecondCostSet_filter( &self, ) -> Event<&P, AdditionalRequestsPerKilosecondCostSet, N>

Creates a new event filter for the AdditionalRequestsPerKilosecondCostSet event.

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

Creates a new event filter for the Approval event.

pub fn ApprovalForAll_filter(&self) -> Event<&P, ApprovalForAll, N>

Creates a new event filter for the ApprovalForAll event.

pub fn DiamondCut_filter(&self) -> Event<&P, DiamondCut, N>

Creates a new event filter for the DiamondCut event.

pub fn FreeMintSignerSet_filter(&self) -> Event<&P, FreeMintSignerSet, N>

Creates a new event filter for the FreeMintSignerSet event.

pub fn FreeRequestsPerRateLimitWindowSet_filter( &self, ) -> Event<&P, FreeRequestsPerRateLimitWindowSet, N>

Creates a new event filter for the FreeRequestsPerRateLimitWindowSet event.

pub fn Initialized_filter(&self) -> Event<&P, Initialized, N>

Creates a new event filter for the Initialized event.

pub fn OwnershipTransferred_filter(&self) -> Event<&P, OwnershipTransferred, N>

Creates a new event filter for the OwnershipTransferred event.

pub fn RLIHolderRateLimitWindowSecondsSet_filter( &self, ) -> Event<&P, RLIHolderRateLimitWindowSecondsSet, N>

Creates a new event filter for the RLIHolderRateLimitWindowSecondsSet event.

pub fn RateLimitWindowSecondsSet_filter( &self, ) -> Event<&P, RateLimitWindowSecondsSet, N>

Creates a new event filter for the RateLimitWindowSecondsSet event.

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

Creates a new event filter for the Transfer event.

pub fn Withdrew_filter(&self) -> Event<&P, Withdrew, N>

Creates a new event filter for the Withdrew event.

Trait Implementations

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

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

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

Formats the value using the given formatter.