Interface RegistrationContract

Hierarchy

BaseContract
- RegistrationContract

Properties

interface

interface: RegistrationInterface

functions

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
- imx(overrides?): Promise<[string]>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:177
isRegistered:function
- isRegistered(starkKey, overrides?): Promise<[boolean]>
- Parameters
  - starkKey: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<[boolean]>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:179
registerAndDepositNft:function
- registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?): Promise<ContractTransaction>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:184
registerAndWithdraw:function
- registerAndWithdraw(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:194
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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:202
registerAndWithdrawNftTo:function
- registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?): 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:211
registerAndWithdrawTo:function
- registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?): 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:221
regsiterAndWithdrawAndMint:function
- regsiterAndWithdrawAndMint(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:230

callStatic

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
- imx(overrides?): Promise<string>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:303
isRegistered:function
- isRegistered(starkKey, overrides?): Promise<boolean>
- Parameters
  - starkKey: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:305
registerAndDepositNft:function
- registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?): Promise<void>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:310
registerAndWithdraw:function
- registerAndWithdraw(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:320
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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:328
registerAndWithdrawNftTo:function
- registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?): Promise<void>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:337
registerAndWithdrawTo:function
- registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?): Promise<void>
- Parameters
  - ethKey: PromiseOrValue<string>
  - starkKey: PromiseOrValue<BigNumberish>
  - signature: PromiseOrValue<BytesLike>
  - assetType: PromiseOrValue<BigNumberish>
  - recipient: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<void>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:347
regsiterAndWithdrawAndMint:function
- regsiterAndWithdrawAndMint(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:356

filters

filters: {}

Type declaration

estimateGas

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
- imx(overrides?): Promise<BigNumber>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:369
isRegistered:function
- isRegistered(starkKey, overrides?): Promise<BigNumber>
- Parameters
  - starkKey: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:371
registerAndDepositNft:function
- registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?): Promise<BigNumber>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:376
registerAndWithdraw:function
- registerAndWithdraw(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:386
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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:394
registerAndWithdrawNftTo:function
- registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?): Promise<BigNumber>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:403
registerAndWithdrawTo:function
- registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?): Promise<BigNumber>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:413
regsiterAndWithdrawAndMint:function
- regsiterAndWithdrawAndMint(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:422

populateTransaction

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
- imx(overrides?): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:433
isRegistered:function
- isRegistered(starkKey, overrides?): Promise<PopulatedTransaction>
- Parameters
  - starkKey: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:435
registerAndDepositNft:function
- registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?): Promise<PopulatedTransaction>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:440
registerAndWithdraw:function
- registerAndWithdraw(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:450
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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:458
registerAndWithdrawNftTo:function
- registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?): Promise<PopulatedTransaction>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:467
registerAndWithdrawTo:function
- registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?): Promise<PopulatedTransaction>
- 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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:477
regsiterAndWithdrawAndMint:function
- regsiterAndWithdrawAndMint(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>
  - Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:486

`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

connect(signerOrProvider): Contracts.RegistrationContract
Parameters
- signerOrProvider: string | EthSigner | Provider
Returns Contracts.RegistrationContract
Overrides BaseContract.connect
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:151

attach

attach(addressOrName): Contracts.RegistrationContract
Parameters
- addressOrName: string
Returns Contracts.RegistrationContract
Overrides BaseContract.attach
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:152

deployed

deployed(): Promise<Contracts.RegistrationContract>
Returns Promise<Contracts.RegistrationContract>
Overrides BaseContract.deployed
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:153

queryFilter

queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>
Type Parameters
- TEvent extends TypedEvent<any, any, TEvent>
Parameters
- event: TypedEventFilter<TEvent>
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TEvent[]>
Overrides BaseContract.queryFilter
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:157

listeners

listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]
Type Parameters
- TEvent extends TypedEvent<any, any, TEvent>
Parameters
- Optional eventFilter: TypedEventFilter<TEvent>
Returns TypedListener<TEvent>[]
Overrides BaseContract.listeners
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:163
listeners(eventName?): Listener[]
Parameters
- Optional eventName: string
Returns Listener[]
Overrides BaseContract.listeners
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:166

removeAllListeners

removeAllListeners<TEvent>(eventFilter): Contracts.RegistrationContract
Type Parameters
- TEvent extends TypedEvent<any, any, TEvent>
Parameters
- eventFilter: TypedEventFilter<TEvent>
Returns Contracts.RegistrationContract
Overrides BaseContract.removeAllListeners
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:167
removeAllListeners(eventName?): Contracts.RegistrationContract
Parameters
- Optional eventName: string
Returns Contracts.RegistrationContract
Overrides BaseContract.removeAllListeners
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:170

imx

imx(overrides?): Promise<string>
Parameters
- Optional overrides: CallOverrides
Returns Promise<string>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:240

isRegistered

isRegistered(starkKey, overrides?): Promise<boolean>
Parameters
- starkKey: PromiseOrValue<BigNumberish>
- Optional overrides: CallOverrides
Returns Promise<boolean>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:242

registerAndDepositNft

registerAndDepositNft(ethKey, starkKey, signature, assetType, vaultId, tokenId, overrides?): Promise<ContractTransaction>
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>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:247

registerAndWithdraw

registerAndWithdraw(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>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:257

registerAndWithdrawNft

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>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:265

registerAndWithdrawNftTo

registerAndWithdrawNftTo(ethKey, starkKey, signature, assetType, tokenId, recipient, overrides?): 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>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:274

registerAndWithdrawTo

registerAndWithdrawTo(ethKey, starkKey, signature, assetType, recipient, overrides?): 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>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:284

regsiterAndWithdrawAndMint

regsiterAndWithdrawAndMint(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>
- Defined in packages/x-client/src/contracts/contracts/v3/Registration.ts:293

_deployed

_deployed(blockTag?): Promise<Contract>
Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>
Inherited from BaseContract._deployed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:114

fallback

fallback(overrides?): Promise<TransactionResponse>
Parameters
- Optional overrides: TransactionRequest
Returns Promise<TransactionResponse>
Inherited from BaseContract.fallback
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:115

_checkRunningEvents

_checkRunningEvents(runningEvent): void
Parameters
- runningEvent: RunningEvent
Returns void
Inherited from BaseContract._checkRunningEvents
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:121

_wrapEvent

_wrapEvent(runningEvent, log, listener): Event
Parameters
- runningEvent: RunningEvent
- log: Log
- listener: Listener
Returns Event
Inherited from BaseContract._wrapEvent
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:122

emit

emit(eventName, ...args): boolean
Parameters
- eventName: string | EventFilter
- Rest ...args: any[]
Returns boolean
Inherited from BaseContract.emit
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:127

listenerCount

listenerCount(eventName?): number
Parameters
- Optional eventName: string | EventFilter
Returns number
Inherited from BaseContract.listenerCount
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:128

Interface RegistrationContract

Hierarchy

Index

Properties

Methods

Properties

interface

off

on

once

removeListener

functions

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

Type declaration

imx:function

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: Overrides & {
from?: PromiseOrValue<string>;
}

`Optional` overrides: Overrides & {
from?: PromiseOrValue<string>;
}

`Optional` overrides: Overrides & {
from?: PromiseOrValue<string>;
}

`Optional` overrides: Overrides & {
from?: PromiseOrValue<string>;
}

`Optional` overrides: Overrides & {
from?: PromiseOrValue<string>;
}

`Optional` overrides: Overrides & {
from?: PromiseOrValue<string>;
}

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides

`Optional` overrides: CallOverrides