Interface RegistrationContract

interface RegistrationContract {
    interface: RegistrationInterface;
    imx: TypedContractMethod<[], [string], "view">;
    isRegistered: TypedContractMethod<[starkKey: BigNumberish], [boolean], "view">;
    registerAndDepositNft: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, vaultId: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">;
    registerAndWithdraw: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish], [void], "nonpayable">;
    registerAndWithdrawNft: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">;
    registerAndWithdrawNftTo: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish, recipient: AddressLike], [void], "nonpayable">;
    registerAndWithdrawTo: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, recipient: AddressLike], [void], "nonpayable">;
    regsiterAndWithdrawAndMint: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, mintingBlob: BytesLike], [void], "nonpayable">;
    filters: {};
    target: string | Addressable;
    runner: null | ContractRunner;
    fallback: null | WrappedFallback;
    [internal]: any;
    connect(runner?: null | ContractRunner): RegistrationContract;
    waitForDeployment(): Promise<RegistrationContract>;
    queryFilter<TCEvent>(event: TCEvent, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEventLog<TCEvent>[]>;
    queryFilter<TCEvent>(filter: TypedDeferredTopicFilter<TCEvent>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEventLog<TCEvent>[]>;
    on<TCEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<RegistrationContract>;
    on<TCEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<RegistrationContract>;
    once<TCEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<RegistrationContract>;
    once<TCEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<RegistrationContract>;
    listeners<TCEvent>(event: TCEvent): Promise<TypedListener<TCEvent>[]>;
    listeners(eventName?: string): Promise<Listener[]>;
    removeAllListeners<TCEvent>(event?: TCEvent): Promise<RegistrationContract>;
    getFunction<T>(key: string | FunctionFragment): T;
    getFunction(nameOrSignature: "imx"): TypedContractMethod<[], [string], "view">;
    getFunction(nameOrSignature: "isRegistered"): TypedContractMethod<[starkKey: BigNumberish], [boolean], "view">;
    getFunction(nameOrSignature: "registerAndDepositNft"): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, vaultId: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">;
    getFunction(nameOrSignature: "registerAndWithdraw"): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish], [void], "nonpayable">;
    getFunction(nameOrSignature: "registerAndWithdrawNft"): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">;
    getFunction(nameOrSignature: "registerAndWithdrawNftTo"): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish, recipient: AddressLike], [void], "nonpayable">;
    getFunction(nameOrSignature: "registerAndWithdrawTo"): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, recipient: AddressLike], [void], "nonpayable">;
    getFunction(nameOrSignature: "regsiterAndWithdrawAndMint"): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, mintingBlob: BytesLike], [void], "nonpayable">;
    attach(target: string | Addressable): BaseContract;
    getAddress(): Promise<string>;
    getDeployedCode(): Promise<null | string>;
    deploymentTransaction(): null | ContractTransactionResponse;
    getEvent(key: string | EventFragment): ContractEvent<any[]>;
    queryTransaction(hash: string): Promise<EventLog[]>;
    emit(event: ContractEventName, ...args: any[]): Promise<boolean>;
    listenerCount(event?: ContractEventName): Promise<number>;
    off(event: ContractEventName, listener?: Listener): Promise<RegistrationContract>;
    addListener(event: ContractEventName, listener: Listener): Promise<RegistrationContract>;
    removeListener(event: ContractEventName, listener: Listener): Promise<RegistrationContract>;
}

Hierarchy

  • BaseContract
    • RegistrationContract

Properties

interface imx isRegistered registerAndDepositNft registerAndWithdraw registerAndWithdrawNft registerAndWithdrawNftTo registerAndWithdrawTo regsiterAndWithdrawAndMint filters target runner fallback [internal]

Methods

connect waitForDeployment queryFilter on once listeners removeAllListeners getFunction attach getAddress getDeployedCode deploymentTransaction getEvent queryTransaction emit listenerCount off addListener removeListener

Properties

interface

interface: RegistrationInterface

The contract Interface.

imx

imx: TypedContractMethod<[], [string], "view">

isRegistered

isRegistered: TypedContractMethod<[starkKey: BigNumberish], [boolean], "view">

registerAndDepositNft

registerAndDepositNft: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, vaultId: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">

registerAndWithdraw

registerAndWithdraw: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish], [void], "nonpayable">

registerAndWithdrawNft

registerAndWithdrawNft: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">

registerAndWithdrawNftTo

registerAndWithdrawNftTo: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish, recipient: AddressLike], [void], "nonpayable">

registerAndWithdrawTo

registerAndWithdrawTo: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, recipient: AddressLike], [void], "nonpayable">

regsiterAndWithdrawAndMint

regsiterAndWithdrawAndMint: TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, mintingBlob: BytesLike], [void], "nonpayable">

filters

filters: {}

All the Events available on this contract.

Readonlytarget

target: string | Addressable

The target to connect to.

This can be an address, ENS name or any [[Addressable]], such as another contract. To get the resovled address, use the getAddress method.

Readonlyrunner

runner: null | ContractRunner

The connected runner. This is generally a [[Provider]] or a [[Signer]], which dictates what operations are supported.

For example, a Contract connected to a [[Provider]] may only execute read-only operations.

Readonlyfallback

fallback: null | WrappedFallback

The fallback or receive function if any.

Readonly[internal]

[internal]: any

@_ignore:

Methods

connect

  • connect(runner?): RegistrationContract

  • Return a new Contract instance with the same target and ABI, but a different %%runner%%.

    Parameters

    • Optionalrunner: null | ContractRunner

    Returns RegistrationContract

waitForDeployment

  • waitForDeployment(): Promise<RegistrationContract>

  • Resolve to this Contract once the bytecode has been deployed, or resolve immediately if already deployed.

    Returns Promise<RegistrationContract>

queryFilter

  • queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>

  • Provide historic access to event data for %%event%% in the range %%fromBlock%% (default: 0) to %%toBlock%% (default: "latest") inclusive.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • event: TCEvent
    • OptionalfromBlockOrBlockhash: string | number
    • OptionaltoBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

  • queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>

  • Provide historic access to event data for %%event%% in the range %%fromBlock%% (default: 0) to %%toBlock%% (default: "latest") inclusive.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • OptionalfromBlockOrBlockhash: string | number
    • OptionaltoBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

on

  • on<TCEvent>(event, listener): Promise<RegistrationContract>

  • Add an event %%listener%% for the %%event%%.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    Returns Promise<RegistrationContract>

  • on<TCEvent>(filter, listener): Promise<RegistrationContract>

  • Add an event %%listener%% for the %%event%%.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • listener: TypedListener<TCEvent>

    Returns Promise<RegistrationContract>

once

  • once<TCEvent>(event, listener): Promise<RegistrationContract>

  • Add an event %%listener%% for the %%event%%, but remove the listener after it is fired once.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    Returns Promise<RegistrationContract>

  • once<TCEvent>(filter, listener): Promise<RegistrationContract>

  • Add an event %%listener%% for the %%event%%, but remove the listener after it is fired once.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • listener: TypedListener<TCEvent>

    Returns Promise<RegistrationContract>

listeners

  • listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>

  • Resolves to the listeners subscribed to %%event%% or all listeners if unspecified.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    Returns Promise<TypedListener<TCEvent>[]>

  • listeners(eventName?): Promise<Listener[]>

  • Resolves to the listeners subscribed to %%event%% or all listeners if unspecified.

    Parameters

    • OptionaleventName: string

    Returns Promise<Listener[]>

removeAllListeners

  • removeAllListeners<TCEvent>(event?): Promise<RegistrationContract>

  • Remove all the listeners for %%event%% or remove all listeners if unspecified.

    Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    Returns Promise<RegistrationContract>

getFunction

  • getFunction<T>(key): T

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Type Parameters

    • T extends ContractMethod<any[], any, any> = ContractMethod<any[], any, any>

    Parameters

    • key: string | FunctionFragment

    Returns T

  • getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "imx"

    Returns TypedContractMethod<[], [string], "view">

  • getFunction(nameOrSignature): TypedContractMethod<[starkKey: BigNumberish], [boolean], "view">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "isRegistered"

    Returns TypedContractMethod<[starkKey: BigNumberish], [boolean], "view">

  • getFunction(nameOrSignature): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, vaultId: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "registerAndDepositNft"

    Returns TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, vaultId: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">

  • getFunction(nameOrSignature): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish], [void], "nonpayable">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "registerAndWithdraw"

    Returns TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish], [void], "nonpayable">

  • getFunction(nameOrSignature): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "registerAndWithdrawNft"

    Returns TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish], [void], "nonpayable">

  • getFunction(nameOrSignature): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish, recipient: AddressLike], [void], "nonpayable">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "registerAndWithdrawNftTo"

    Returns TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, tokenId: BigNumberish, recipient: AddressLike], [void], "nonpayable">

  • getFunction(nameOrSignature): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, recipient: AddressLike], [void], "nonpayable">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "registerAndWithdrawTo"

    Returns TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, recipient: AddressLike], [void], "nonpayable">

  • getFunction(nameOrSignature): TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, mintingBlob: BytesLike], [void], "nonpayable">

  • Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • nameOrSignature: "regsiterAndWithdrawAndMint"

    Returns TypedContractMethod<[ethKey: AddressLike, starkKey: BigNumberish, signature: BytesLike, assetType: BigNumberish, mintingBlob: BytesLike], [void], "nonpayable">

attach

  • attach(target): BaseContract

  • Return a new Contract instance with the same ABI and runner, but a different %%target%%.

    Parameters

    • target: string | Addressable

    Returns BaseContract

getAddress

  • getAddress(): Promise<string>

  • Return the resolved address of this Contract.

    Returns Promise<string>

getDeployedCode

  • getDeployedCode(): Promise<null | string>

  • Return the deployed bytecode or null if no bytecode is found.

    Returns Promise<null | string>

deploymentTransaction

  • deploymentTransaction(): null | ContractTransactionResponse

  • Return the transaction used to deploy this contract.

    This is only available if this instance was returned from a [[ContractFactory]].

    Returns null | ContractTransactionResponse

getEvent

  • getEvent(key): ContractEvent<any[]>

  • Return the event for a given name. This is useful when a contract event name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

    Parameters

    • key: string | EventFragment

    Returns ContractEvent<any[]>

queryTransaction

  • queryTransaction(hash): Promise<EventLog[]>

  • @_ignore:

    Parameters

    • hash: string

    Returns Promise<EventLog[]>

emit

  • emit(event, ...args): Promise<boolean>

  • Emit an %%event%% calling all listeners with %%args%%.

    Resolves to true if any listeners were called.

    Parameters

    • event: ContractEventName
    • Rest...args: any[]

    Returns Promise<boolean>

listenerCount

  • listenerCount(event?): Promise<number>

  • Resolves to the number of listeners of %%event%% or the total number of listeners if unspecified.

    Parameters

    • Optionalevent: ContractEventName

    Returns Promise<number>

off

  • off(event, listener?): Promise<RegistrationContract>

  • Remove the %%listener%% from the listeners for %%event%% or remove all listeners if unspecified.

    Parameters

    • event: ContractEventName
    • Optionallistener: Listener

    Returns Promise<RegistrationContract>

addListener

  • addListener(event, listener): Promise<RegistrationContract>

  • Alias for [on].

    Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<RegistrationContract>

removeListener

  • removeListener(event, listener): Promise<RegistrationContract>

  • Alias for [off].

    Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<RegistrationContract>

Settings

Member Visibility

On This Page

Properties
Methods