Interface RegistrationV4Contract

Hierarchy

  • BaseContract
    • RegistrationV4Contract

Properties

interface off on once removeListener functions callStatic filters estimateGas populateTransaction address signer provider resolvedAddress deployTransaction _deployedPromise _runningEvents _wrappedEmits

Methods

connect attach deployed queryFilter listeners removeAllListeners getVersion imx isRegistered registerAndWithdrawAll registerAndWithdrawNft registerWithdrawAndMint withdrawAll _deployed fallback _checkRunningEvents _wrapEvent emit listenerCount

Properties

interface

interface: RegistrationV4Interface

off

off: OnEvent<Contracts.RegistrationV4Contract>

on

on: OnEvent<Contracts.RegistrationV4Contract>

once

once: OnEvent<Contracts.RegistrationV4Contract>

removeListener

removeListener: OnEvent<Contracts.RegistrationV4Contract>

functions

functions: {
    getVersion(overrides?) => Promise<[string]>;
    imx(overrides?) => Promise<[string]>;
    isRegistered(starkKey, overrides?) => Promise<[boolean]>;
    registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?) => Promise<ContractTransaction>;
    registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<ContractTransaction>;
    registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<ContractTransaction>;
    withdrawAll(ethKey, starkKey, assetType, overrides?) => Promise<ContractTransaction>;
}

Type declaration

  • getVersion:function
  • imx:function
  • isRegistered:function
  • registerAndWithdrawAll:function
    • registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?): Promise<ContractTransaction>

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • registerAndWithdrawNft:function
    • registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?): Promise<ContractTransaction>

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • tokenId: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • registerWithdrawAndMint:function
    • registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?): Promise<ContractTransaction>

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • mintingBlob: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • withdrawAll:function
    • withdrawAll(ethKey, starkKey, assetType, overrides?): Promise<ContractTransaction>

    • Parameters

      • ethKey: PromiseOrValue<BigNumberish>
      • starkKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

callStatic

callStatic: {
    getVersion(overrides?) => Promise<string>;
    imx(overrides?) => Promise<string>;
    isRegistered(starkKey, overrides?) => Promise<boolean>;
    registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?) => Promise<void>;
    registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<void>;
    registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<void>;
    withdrawAll(ethKey, starkKey, assetType, overrides?) => Promise<void>;
}

Type declaration

  • getVersion:function
  • imx:function
  • isRegistered:function
  • registerAndWithdrawAll:function
    • registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?): Promise<void>

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerAndWithdrawNft:function
    • registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?): Promise<void>

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • tokenId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerWithdrawAndMint:function
    • registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?): Promise<void>

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • mintingBlob: PromiseOrValue<BytesLike>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdrawAll:function

filters

filters: {}

Type declaration

    estimateGas

    estimateGas: {
        getVersion(overrides?) => Promise<BigNumber>;
        imx(overrides?) => Promise<BigNumber>;
        isRegistered(starkKey, overrides?) => Promise<BigNumber>;
        registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?) => Promise<BigNumber>;
        registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<BigNumber>;
        registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<BigNumber>;
        withdrawAll(ethKey, starkKey, assetType, overrides?) => Promise<BigNumber>;
    }

    Type declaration

    • getVersion:function
    • imx:function
    • isRegistered:function
    • registerAndWithdrawAll:function
      • registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?): Promise<BigNumber>

      • Parameters

        • ethKey: PromiseOrValue<string>
        • starkKey: PromiseOrValue<BigNumberish>
        • signature: PromiseOrValue<BytesLike>
        • assetType: PromiseOrValue<BigNumberish>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<BigNumber>

    • registerAndWithdrawNft:function
      • registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?): Promise<BigNumber>

      • Parameters

        • ethKey: PromiseOrValue<string>
        • starkKey: PromiseOrValue<BigNumberish>
        • signature: PromiseOrValue<BytesLike>
        • assetType: PromiseOrValue<BigNumberish>
        • tokenId: PromiseOrValue<BigNumberish>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<BigNumber>

    • registerWithdrawAndMint:function
      • registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?): Promise<BigNumber>

      • Parameters

        • ethKey: PromiseOrValue<string>
        • starkKey: PromiseOrValue<BigNumberish>
        • signature: PromiseOrValue<BytesLike>
        • assetType: PromiseOrValue<BigNumberish>
        • mintingBlob: PromiseOrValue<BytesLike>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<BigNumber>

    • withdrawAll:function
      • withdrawAll(ethKey, starkKey, assetType, overrides?): Promise<BigNumber>

      • Parameters

        • ethKey: PromiseOrValue<BigNumberish>
        • starkKey: PromiseOrValue<BigNumberish>
        • assetType: PromiseOrValue<BigNumberish>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<BigNumber>

    populateTransaction

    populateTransaction: {
        getVersion(overrides?) => Promise<PopulatedTransaction>;
        imx(overrides?) => Promise<PopulatedTransaction>;
        isRegistered(starkKey, overrides?) => Promise<PopulatedTransaction>;
        registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?) => Promise<PopulatedTransaction>;
        registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<PopulatedTransaction>;
        registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<PopulatedTransaction>;
        withdrawAll(ethKey, starkKey, assetType, overrides?) => Promise<PopulatedTransaction>;
    }

    Type declaration

    • getVersion:function
    • imx:function
    • isRegistered:function
    • registerAndWithdrawAll:function
      • registerAndWithdrawAll(ethKey, starkKey, signature, assetType, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • ethKey: PromiseOrValue<string>
        • starkKey: PromiseOrValue<BigNumberish>
        • signature: PromiseOrValue<BytesLike>
        • assetType: PromiseOrValue<BigNumberish>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<PopulatedTransaction>

    • registerAndWithdrawNft:function
      • registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • ethKey: PromiseOrValue<string>
        • starkKey: PromiseOrValue<BigNumberish>
        • signature: PromiseOrValue<BytesLike>
        • assetType: PromiseOrValue<BigNumberish>
        • tokenId: PromiseOrValue<BigNumberish>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<PopulatedTransaction>

    • registerWithdrawAndMint:function
      • registerWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • ethKey: PromiseOrValue<string>
        • starkKey: PromiseOrValue<BigNumberish>
        • signature: PromiseOrValue<BytesLike>
        • assetType: PromiseOrValue<BigNumberish>
        • mintingBlob: PromiseOrValue<BytesLike>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<PopulatedTransaction>

    • withdrawAll:function
      • withdrawAll(ethKey, starkKey, assetType, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • ethKey: PromiseOrValue<BigNumberish>
        • starkKey: PromiseOrValue<BigNumberish>
        • assetType: PromiseOrValue<BigNumberish>
        • Optional overrides: Overrides & {
              from?: PromiseOrValue<string>;
          }

        Returns Promise<PopulatedTransaction>

    Readonly address

    address: string

    Readonly signer

    signer: EthSigner

    Readonly provider

    provider: Provider

    Readonly resolvedAddress

    resolvedAddress: Promise<string>

    Readonly deployTransaction

    deployTransaction: TransactionResponse

    _deployedPromise

    _deployedPromise: Promise<Contract>

    _runningEvents

    _runningEvents: {
        [eventTag: string]: RunningEvent;
    }

    Type declaration

    • [eventTag: string]: RunningEvent

    _wrappedEmits

    _wrappedEmits: {
        [eventTag: string]: ((...args) => void);
    }

    Type declaration

    • [eventTag: string]: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Methods

    connect

    attach

    deployed

    queryFilter

    • Type Parameters

      • TEvent extends TypedEvent<any, any, TEvent>

      Parameters

      • event: TypedEventFilter<TEvent>
      • Optional fromBlockOrBlockhash: string | number
      • Optional toBlock: string | number

      Returns Promise<TEvent[]>

    listeners

    removeAllListeners

    getVersion

    imx

    isRegistered

    registerAndWithdrawAll

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

    registerAndWithdrawNft

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • tokenId: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

    registerWithdrawAndMint

    • Parameters

      • ethKey: PromiseOrValue<string>
      • starkKey: PromiseOrValue<BigNumberish>
      • signature: PromiseOrValue<BytesLike>
      • assetType: PromiseOrValue<BigNumberish>
      • mintingBlob: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

    withdrawAll

    • Parameters

      • ethKey: PromiseOrValue<BigNumberish>
      • starkKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

    _deployed

    • _deployed(blockTag?): Promise<Contract>

    • Parameters

      • Optional blockTag: BlockTag

      Returns Promise<Contract>

    fallback

    • Parameters

      • Optional overrides: TransactionRequest

      Returns Promise<TransactionResponse>

    _checkRunningEvents

    • _checkRunningEvents(runningEvent): void

    • Parameters

      • runningEvent: RunningEvent

      Returns void

    _wrapEvent

    • _wrapEvent(runningEvent, log, listener): Event

    • Parameters

      • runningEvent: RunningEvent
      • log: Log
      • listener: Listener

      Returns Event

    emit

    • Parameters

      • eventName: string | EventFilter
      • Rest ...args: any[]

      Returns boolean

    listenerCount

    • Parameters

      • Optional eventName: string | EventFilter

      Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc