Hierarchy

  • BaseContract
    • RegistrationContract

Properties

interface: RegistrationInterface
removeListener: OnEvent<x.Contracts.RegistrationContract>
functions: {
    imx(overrides?) => Promise<[string]>;
    isRegistered(starkKey, overrides?) => Promise<[boolean]>;
    registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?) => Promise<ContractTransaction>;
    registerAndWithdraw(ethKey, starkKey, signature, assetType, overrides?) => Promise<ContractTransaction>;
    registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<ContractTransaction>;
    registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?) => Promise<ContractTransaction>;
    registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?) => Promise<ContractTransaction>;
    regsiterAndWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<ContractTransaction>;
}

Type declaration

  • imx:function
    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • isRegistered:function
    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • registerAndDepositNft:function
    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerAndWithdraw:function
    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerAndWithdrawNft:function
    • 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>

  • registerAndWithdrawNftTo:function
    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerAndWithdrawTo:function
    • Parameters

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

      Returns Promise<ContractTransaction>

  • regsiterAndWithdrawAndMint:function
    • 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>

callStatic: {
    imx(overrides?) => Promise<string>;
    isRegistered(starkKey, overrides?) => Promise<boolean>;
    registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?) => Promise<void>;
    registerAndWithdraw(ethKey, starkKey, signature, assetType, overrides?) => Promise<void>;
    registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<void>;
    registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?) => Promise<void>;
    registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?) => Promise<void>;
    regsiterAndWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<void>;
}

Type declaration

  • imx:function
    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • isRegistered:function
    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • registerAndDepositNft:function
    • Parameters

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

      Returns Promise<void>

  • registerAndWithdraw:function
    • Parameters

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

      Returns Promise<void>

  • registerAndWithdrawNft:function
    • Parameters

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

      Returns Promise<void>

  • registerAndWithdrawNftTo:function
    • Parameters

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

      Returns Promise<void>

  • registerAndWithdrawTo:function
    • Parameters

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

      Returns Promise<void>

  • regsiterAndWithdrawAndMint:function
    • Parameters

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

      Returns Promise<void>

filters: {}

Type declaration

    estimateGas: {
        imx(overrides?) => Promise<BigNumber>;
        isRegistered(starkKey, overrides?) => Promise<BigNumber>;
        registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?) => Promise<BigNumber>;
        registerAndWithdraw(ethKey, starkKey, signature, assetType, overrides?) => Promise<BigNumber>;
        registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<BigNumber>;
        registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?) => Promise<BigNumber>;
        registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?) => Promise<BigNumber>;
        regsiterAndWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<BigNumber>;
    }

    Type declaration

    • imx:function
      • Parameters

        • Optional overrides: CallOverrides

        Returns Promise<BigNumber>

    • isRegistered:function
      • Parameters

        • starkKey: PromiseOrValue<BigNumberish>
        • Optional overrides: CallOverrides

        Returns Promise<BigNumber>

    • registerAndDepositNft:function
      • Parameters

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

        Returns Promise<BigNumber>

    • registerAndWithdraw:function
      • Parameters

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

        Returns Promise<BigNumber>

    • registerAndWithdrawNft:function
      • 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>

    • registerAndWithdrawNftTo:function
      • Parameters

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

        Returns Promise<BigNumber>

    • registerAndWithdrawTo:function
      • Parameters

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

        Returns Promise<BigNumber>

    • regsiterAndWithdrawAndMint:function
      • 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>

    populateTransaction: {
        imx(overrides?) => Promise<PopulatedTransaction>;
        isRegistered(starkKey, overrides?) => Promise<PopulatedTransaction>;
        registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?) => Promise<PopulatedTransaction>;
        registerAndWithdraw(ethKey, starkKey, signature, assetType, overrides?) => Promise<PopulatedTransaction>;
        registerAndWithdrawNft(ethKey, starkKey, signature, assetType, tokenId, overrides?) => Promise<PopulatedTransaction>;
        registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?) => Promise<PopulatedTransaction>;
        registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?) => Promise<PopulatedTransaction>;
        regsiterAndWithdrawAndMint(ethKey, starkKey, signature, assetType, mintingBlob, overrides?) => Promise<PopulatedTransaction>;
    }

    Type declaration

    • imx:function
      • Parameters

        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • isRegistered:function
      • Parameters

        • starkKey: PromiseOrValue<BigNumberish>
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • registerAndDepositNft:function
      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • registerAndWithdraw:function
      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • registerAndWithdrawNft:function
      • 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>

    • registerAndWithdrawNftTo:function
      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • registerAndWithdrawTo:function
      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • regsiterAndWithdrawAndMint:function
      • 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>

    address: string
    signer: x.EthSigner
    provider: Provider
    resolvedAddress: Promise<string>
    deployTransaction: x.TransactionResponse
    _deployedPromise: Promise<Contract>
    _runningEvents: {
        [eventTag: string]: RunningEvent;
    }

    Type declaration

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

    Type declaration

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

          • Rest ...args: any[]

          Returns void

    Methods

    • Type Parameters

      • TEvent extends TypedEvent<any, any, TEvent>

      Parameters

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

      Returns Promise<TEvent[]>

    • Type Parameters

      • TEvent extends TypedEvent<any, any, TEvent>

      Parameters

      • Optional eventFilter: TypedEventFilter<TEvent>

      Returns TypedListener<TEvent>[]

    • Parameters

      • Optional eventName: string

      Returns Listener[]

    • Type Parameters

      • TEvent extends TypedEvent<any, any, TEvent>

      Parameters

      • eventFilter: TypedEventFilter<TEvent>

      Returns x.Contracts.RegistrationContract

    • Parameters

      • Optional eventName: string

      Returns x.Contracts.RegistrationContract

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

    • Parameters

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

      Returns Promise<ContractTransaction>

    • Parameters

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

      Returns 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>

    • Parameters

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

      Returns Promise<ContractTransaction>

    • Parameters

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

      Returns 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>

    • Parameters

      • Optional blockTag: BlockTag

      Returns Promise<Contract>

    • Parameters

      • Optional overrides: TransactionRequest

      Returns Promise<x.TransactionResponse>

    • Parameters

      • runningEvent: RunningEvent

      Returns void

    • Parameters

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

      Returns Event

    • Parameters

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

      Returns boolean

    • Parameters

      • Optional eventName: string | EventFilter

      Returns number

    Generated using TypeDoc