Interface CoreContract

Hierarchy

  • BaseContract
    • CoreContract

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 announceAvailabilityVerifierRemovalIntent announceVerifierRemovalIntent deposit(uint256,uint256,uint256) deposit(uint256,uint256,uint256,uint256) depositCancel depositERC20 depositEth depositNft depositNftReclaim depositReclaim escape freezeRequest fullWithdrawalRequest getAssetInfo getCancellationRequest getDepositBalance getEthKey getFullWithdrawalRequest getLastBatchId getOrderRoot getOrderTreeHeight getQuantizedDepositBalance getQuantum getRegisteredAvailabilityVerifiers getRegisteredVerifiers getSequenceNumber getVaultRoot getVaultTreeHeight getWithdrawalBalance isAvailabilityVerifier isFrozen isOperator isTokenAdmin isUserAdmin isVerifier mainAcceptGovernance mainCancelNomination mainIsGovernor mainNominateNewGovernor mainRemoveGovernor onERC721Received registerAndDepositERC20 registerAndDepositEth registerAvailabilityVerifier registerOperator registerToken registerTokenAdmin registerUser registerUserAdmin registerVerifier removeAvailabilityVerifier removeVerifier unFreeze unregisterOperator unregisterTokenAdmin unregisterUserAdmin updateState withdraw withdrawAndMint withdrawNft withdrawNftTo withdrawTo _deployed fallback _checkRunningEvents _wrapEvent emit listenerCount

Properties

interface

interface: CoreInterface

off

off: OnEvent<Contracts.CoreContract>

on

on: OnEvent<Contracts.CoreContract>

once

once: OnEvent<Contracts.CoreContract>

removeListener

removeListener: OnEvent<Contracts.CoreContract>

functions

functions: {
    announceAvailabilityVerifierRemovalIntent(arg0, overrides?) => Promise<ContractTransaction>;
    announceVerifierRemovalIntent(arg0, overrides?) => Promise<ContractTransaction>;
    deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?) => Promise<ContractTransaction>;
    deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<ContractTransaction>;
    depositCancel(starkKey, assetId, vaultId, overrides?) => Promise<ContractTransaction>;
    depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<ContractTransaction>;
    depositEth(starkKey, assetType, vaultId, overrides?) => Promise<ContractTransaction>;
    depositNft(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<ContractTransaction>;
    depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<ContractTransaction>;
    depositReclaim(starkKey, assetId, vaultId, overrides?) => Promise<ContractTransaction>;
    escape(starkKey, vaultId, assetId, quantizedAmount, overrides?) => Promise<ContractTransaction>;
    freezeRequest(starkKey, vaultId, overrides?) => Promise<ContractTransaction>;
    fullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<ContractTransaction>;
    getAssetInfo(assetType, overrides?) => Promise<[string] & {
        assetInfo: string;
    }>;
    getCancellationRequest(starkKey, assetId, vaultId, overrides?) => Promise<[BigNumber] & {
        request: BigNumber;
    }>;
    getDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<[BigNumber] & {
        balance: BigNumber;
    }>;
    getEthKey(starkKey, overrides?) => Promise<[string] & {
        ethKey: string;
    }>;
    getFullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<[BigNumber] & {
        res: BigNumber;
    }>;
    getLastBatchId(overrides?) => Promise<[BigNumber] & {
        batchId: BigNumber;
    }>;
    getOrderRoot(overrides?) => Promise<[BigNumber] & {
        root: BigNumber;
    }>;
    getOrderTreeHeight(overrides?) => Promise<[BigNumber] & {
        height: BigNumber;
    }>;
    getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<[BigNumber] & {
        balance: BigNumber;
    }>;
    getQuantum(presumedAssetType, overrides?) => Promise<[BigNumber] & {
        quantum: BigNumber;
    }>;
    getRegisteredAvailabilityVerifiers(overrides?) => Promise<ContractTransaction>;
    getRegisteredVerifiers(overrides?) => Promise<ContractTransaction>;
    getSequenceNumber(overrides?) => Promise<[BigNumber] & {
        seq: BigNumber;
    }>;
    getVaultRoot(overrides?) => Promise<[BigNumber] & {
        root: BigNumber;
    }>;
    getVaultTreeHeight(overrides?) => Promise<[BigNumber] & {
        height: BigNumber;
    }>;
    getWithdrawalBalance(ownerKey, assetId, overrides?) => Promise<[BigNumber] & {
        balance: BigNumber;
    }>;
    isAvailabilityVerifier(arg0, overrides?) => Promise<ContractTransaction>;
    isFrozen(overrides?) => Promise<ContractTransaction>;
    isOperator(arg0, overrides?) => Promise<ContractTransaction>;
    isTokenAdmin(arg0, overrides?) => Promise<ContractTransaction>;
    isUserAdmin(arg0, overrides?) => Promise<ContractTransaction>;
    isVerifier(arg0, overrides?) => Promise<ContractTransaction>;
    mainAcceptGovernance(overrides?) => Promise<ContractTransaction>;
    mainCancelNomination(overrides?) => Promise<ContractTransaction>;
    mainIsGovernor(arg0, overrides?) => Promise<ContractTransaction>;
    mainNominateNewGovernor(arg0, overrides?) => Promise<ContractTransaction>;
    mainRemoveGovernor(arg0, overrides?) => Promise<ContractTransaction>;
    onERC721Received(arg0, arg1, arg2, arg3, overrides?) => Promise<ContractTransaction>;
    registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?) => Promise<ContractTransaction>;
    registerAndDepositEth(ethKey, starkKey, signature, assetType, vaultId, overrides?) => Promise<ContractTransaction>;
    registerAvailabilityVerifier(arg0, arg1, overrides?) => Promise<ContractTransaction>;
    registerOperator(arg0, overrides?) => Promise<ContractTransaction>;
    registerToken(arg0, arg1, overrides?) => Promise<ContractTransaction>;
    registerTokenAdmin(arg0, overrides?) => Promise<ContractTransaction>;
    registerUser(arg0, arg1, arg2, overrides?) => Promise<ContractTransaction>;
    registerUserAdmin(arg0, overrides?) => Promise<ContractTransaction>;
    registerVerifier(arg0, arg1, overrides?) => Promise<ContractTransaction>;
    removeAvailabilityVerifier(arg0, overrides?) => Promise<ContractTransaction>;
    removeVerifier(arg0, overrides?) => Promise<ContractTransaction>;
    unFreeze(overrides?) => Promise<ContractTransaction>;
    unregisterOperator(arg0, overrides?) => Promise<ContractTransaction>;
    unregisterTokenAdmin(arg0, overrides?) => Promise<ContractTransaction>;
    unregisterUserAdmin(arg0, overrides?) => Promise<ContractTransaction>;
    updateState(publicInput, applicationData, overrides?) => Promise<ContractTransaction>;
    withdraw(ownerKey, assetType, overrides?) => Promise<ContractTransaction>;
    withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?) => Promise<ContractTransaction>;
    withdrawNft(ownerKey, assetType, tokenId, overrides?) => Promise<ContractTransaction>;
    withdrawNftTo(arg0, arg1, arg2, arg3, overrides?) => Promise<ContractTransaction>;
    withdrawTo(arg0, arg1, arg2, overrides?) => Promise<ContractTransaction>;
}

Type declaration

  • announceAvailabilityVerifierRemovalIntent:function
    • announceAvailabilityVerifierRemovalIntent(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • announceVerifierRemovalIntent:function
    • announceVerifierRemovalIntent(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • deposit(uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • deposit(uint256,uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • depositCancel:function
    • depositCancel(starkKey, assetId, vaultId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • depositERC20:function
    • depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • depositEth:function
    • depositEth(starkKey, assetType, vaultId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • depositNft:function
    • depositNft(starkKey, assetType, vaultId, tokenId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • depositNftReclaim:function
    • depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • depositReclaim:function
    • depositReclaim(starkKey, assetId, vaultId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • escape:function
    • escape(starkKey, vaultId, assetId, quantizedAmount, overrides?): Promise<ContractTransaction>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • quantizedAmount: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • freezeRequest:function
    • freezeRequest(starkKey, vaultId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • fullWithdrawalRequest:function
    • fullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • getAssetInfo:function
    • getAssetInfo(assetType, overrides?): Promise<[string] & {
          assetInfo: string;
      }>

    • Parameters

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

      Returns Promise<[string] & {
          assetInfo: string;
      }>

  • getCancellationRequest:function
    • getCancellationRequest(starkKey, assetId, vaultId, overrides?): Promise<[BigNumber] & {
          request: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          request: BigNumber;
      }>

  • getDepositBalance:function
    • getDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<[BigNumber] & {
          balance: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          balance: BigNumber;
      }>

  • getEthKey:function
    • getEthKey(starkKey, overrides?): Promise<[string] & {
          ethKey: string;
      }>

    • Parameters

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

      Returns Promise<[string] & {
          ethKey: string;
      }>

  • getFullWithdrawalRequest:function
    • getFullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<[BigNumber] & {
          res: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          res: BigNumber;
      }>

  • getLastBatchId:function
  • getOrderRoot:function
  • getOrderTreeHeight:function
  • getQuantizedDepositBalance:function
    • getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<[BigNumber] & {
          balance: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          balance: BigNumber;
      }>

  • getQuantum:function
    • getQuantum(presumedAssetType, overrides?): Promise<[BigNumber] & {
          quantum: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          quantum: BigNumber;
      }>

  • getRegisteredAvailabilityVerifiers:function
  • getRegisteredVerifiers:function
  • getSequenceNumber:function
  • getVaultRoot:function
  • getVaultTreeHeight:function
  • getWithdrawalBalance:function
    • getWithdrawalBalance(ownerKey, assetId, overrides?): Promise<[BigNumber] & {
          balance: BigNumber;
      }>

    • Parameters

      • ownerKey: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & {
          balance: BigNumber;
      }>

  • isAvailabilityVerifier:function
    • isAvailabilityVerifier(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • isFrozen:function
  • isOperator:function
  • isTokenAdmin:function
  • isUserAdmin:function
  • isVerifier:function
  • mainAcceptGovernance:function
  • mainCancelNomination:function
  • mainIsGovernor:function
  • mainNominateNewGovernor:function
    • mainNominateNewGovernor(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • mainRemoveGovernor:function
    • mainRemoveGovernor(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • onERC721Received:function
    • onERC721Received(arg0, arg1, arg2, arg3, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • registerAndDepositERC20:function
    • registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerAvailabilityVerifier:function
    • registerAvailabilityVerifier(arg0, arg1, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • registerOperator:function
    • registerOperator(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerToken:function
    • registerToken(arg0, arg1, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • registerTokenAdmin:function
    • registerTokenAdmin(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerUser:function
    • registerUser(arg0, arg1, arg2, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • registerUserAdmin:function
    • registerUserAdmin(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerVerifier:function
    • registerVerifier(arg0, arg1, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • removeAvailabilityVerifier:function
    • removeAvailabilityVerifier(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • removeVerifier:function
  • unFreeze:function
  • unregisterOperator:function
    • unregisterOperator(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • unregisterTokenAdmin:function
    • unregisterTokenAdmin(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • unregisterUserAdmin:function
    • unregisterUserAdmin(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateState:function
    • updateState(publicInput, applicationData, overrides?): Promise<ContractTransaction>

    • Parameters

      • publicInput: PromiseOrValue<BigNumberish>[]
      • applicationData: PromiseOrValue<BigNumberish>[]
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • withdraw:function
    • withdraw(ownerKey, assetType, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • withdrawAndMint:function
    • withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • withdrawNft:function
    • withdrawNft(ownerKey, assetType, tokenId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • withdrawNftTo:function
    • withdrawNftTo(arg0, arg1, arg2, arg3, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

  • withdrawTo:function
    • withdrawTo(arg0, arg1, arg2, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<ContractTransaction>

callStatic

callStatic: {
    announceAvailabilityVerifierRemovalIntent(arg0, overrides?) => Promise<void>;
    announceVerifierRemovalIntent(arg0, overrides?) => Promise<void>;
    deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?) => Promise<void>;
    deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<void>;
    depositCancel(starkKey, assetId, vaultId, overrides?) => Promise<void>;
    depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<void>;
    depositEth(starkKey, assetType, vaultId, overrides?) => Promise<void>;
    depositNft(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<void>;
    depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<void>;
    depositReclaim(starkKey, assetId, vaultId, overrides?) => Promise<void>;
    escape(starkKey, vaultId, assetId, quantizedAmount, overrides?) => Promise<void>;
    freezeRequest(starkKey, vaultId, overrides?) => Promise<void>;
    fullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<void>;
    getAssetInfo(assetType, overrides?) => Promise<string>;
    getCancellationRequest(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    getDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    getEthKey(starkKey, overrides?) => Promise<string>;
    getFullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<BigNumber>;
    getLastBatchId(overrides?) => Promise<BigNumber>;
    getOrderRoot(overrides?) => Promise<BigNumber>;
    getOrderTreeHeight(overrides?) => Promise<BigNumber>;
    getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    getQuantum(presumedAssetType, overrides?) => Promise<BigNumber>;
    getRegisteredAvailabilityVerifiers(overrides?) => Promise<void>;
    getRegisteredVerifiers(overrides?) => Promise<void>;
    getSequenceNumber(overrides?) => Promise<BigNumber>;
    getVaultRoot(overrides?) => Promise<BigNumber>;
    getVaultTreeHeight(overrides?) => Promise<BigNumber>;
    getWithdrawalBalance(ownerKey, assetId, overrides?) => Promise<BigNumber>;
    isAvailabilityVerifier(arg0, overrides?) => Promise<void>;
    isFrozen(overrides?) => Promise<void>;
    isOperator(arg0, overrides?) => Promise<void>;
    isTokenAdmin(arg0, overrides?) => Promise<void>;
    isUserAdmin(arg0, overrides?) => Promise<void>;
    isVerifier(arg0, overrides?) => Promise<void>;
    mainAcceptGovernance(overrides?) => Promise<void>;
    mainCancelNomination(overrides?) => Promise<void>;
    mainIsGovernor(arg0, overrides?) => Promise<void>;
    mainNominateNewGovernor(arg0, overrides?) => Promise<void>;
    mainRemoveGovernor(arg0, overrides?) => Promise<void>;
    onERC721Received(arg0, arg1, arg2, arg3, overrides?) => Promise<void>;
    registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?) => Promise<void>;
    registerAndDepositEth(ethKey, starkKey, signature, assetType, vaultId, overrides?) => Promise<void>;
    registerAvailabilityVerifier(arg0, arg1, overrides?) => Promise<void>;
    registerOperator(arg0, overrides?) => Promise<void>;
    registerToken(arg0, arg1, overrides?) => Promise<void>;
    registerTokenAdmin(arg0, overrides?) => Promise<void>;
    registerUser(arg0, arg1, arg2, overrides?) => Promise<void>;
    registerUserAdmin(arg0, overrides?) => Promise<void>;
    registerVerifier(arg0, arg1, overrides?) => Promise<void>;
    removeAvailabilityVerifier(arg0, overrides?) => Promise<void>;
    removeVerifier(arg0, overrides?) => Promise<void>;
    unFreeze(overrides?) => Promise<void>;
    unregisterOperator(arg0, overrides?) => Promise<void>;
    unregisterTokenAdmin(arg0, overrides?) => Promise<void>;
    unregisterUserAdmin(arg0, overrides?) => Promise<void>;
    updateState(publicInput, applicationData, overrides?) => Promise<void>;
    withdraw(ownerKey, assetType, overrides?) => Promise<void>;
    withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?) => Promise<void>;
    withdrawNft(ownerKey, assetType, tokenId, overrides?) => Promise<void>;
    withdrawNftTo(arg0, arg1, arg2, arg3, overrides?) => Promise<void>;
    withdrawTo(arg0, arg1, arg2, overrides?) => Promise<void>;
}

Type declaration

  • announceAvailabilityVerifierRemovalIntent:function
  • announceVerifierRemovalIntent:function
  • deposit(uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

  • deposit(uint256,uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<void>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • quantizedAmount: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • depositCancel:function
    • depositCancel(starkKey, assetId, vaultId, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

  • depositERC20:function
    • depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<void>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • quantizedAmount: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • depositEth:function
    • depositEth(starkKey, assetType, vaultId, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

  • depositNft:function
    • depositNft(starkKey, assetType, vaultId, tokenId, overrides?): Promise<void>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • tokenId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • depositNftReclaim:function
    • depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?): Promise<void>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • tokenId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • depositReclaim:function
    • depositReclaim(starkKey, assetId, vaultId, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

  • escape:function
    • escape(starkKey, vaultId, assetId, quantizedAmount, overrides?): Promise<void>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • quantizedAmount: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • freezeRequest:function
  • fullWithdrawalRequest:function
  • getAssetInfo:function
  • getCancellationRequest:function
    • getCancellationRequest(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getDepositBalance:function
    • getDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getEthKey:function
  • getFullWithdrawalRequest:function
    • getFullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getLastBatchId:function
  • getOrderRoot:function
  • getOrderTreeHeight:function
  • getQuantizedDepositBalance:function
    • getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getQuantum:function
  • getRegisteredAvailabilityVerifiers:function
  • getRegisteredVerifiers:function
  • getSequenceNumber:function
  • getVaultRoot:function
  • getVaultTreeHeight:function
  • getWithdrawalBalance:function
    • getWithdrawalBalance(ownerKey, assetId, overrides?): Promise<BigNumber>

    • Parameters

      • ownerKey: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isAvailabilityVerifier:function
  • isFrozen:function
  • isOperator:function
  • isTokenAdmin:function
  • isUserAdmin:function
  • isVerifier:function
  • mainAcceptGovernance:function
  • mainCancelNomination:function
  • mainIsGovernor:function
  • mainNominateNewGovernor:function
  • mainRemoveGovernor:function
  • onERC721Received:function
    • onERC721Received(arg0, arg1, arg2, arg3, overrides?): Promise<void>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<BytesLike>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerAndDepositERC20:function
    • registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

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

    • Parameters

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

      Returns Promise<void>

  • registerAvailabilityVerifier:function
  • registerOperator:function
  • registerToken:function
  • registerTokenAdmin:function
  • registerUser:function
    • registerUser(arg0, arg1, arg2, overrides?): Promise<void>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BytesLike>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerUserAdmin:function
  • registerVerifier:function
  • removeAvailabilityVerifier:function
  • removeVerifier:function
  • unFreeze:function
  • unregisterOperator:function
  • unregisterTokenAdmin:function
  • unregisterUserAdmin:function
  • updateState:function
    • updateState(publicInput, applicationData, overrides?): Promise<void>

    • Parameters

      • publicInput: PromiseOrValue<BigNumberish>[]
      • applicationData: PromiseOrValue<BigNumberish>[]
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdraw:function
  • withdrawAndMint:function
    • withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?): Promise<void>

    • Parameters

      • ownerKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • mintingBlob: PromiseOrValue<BytesLike>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdrawNft:function
    • withdrawNft(ownerKey, assetType, tokenId, overrides?): Promise<void>

    • Parameters

      • ownerKey: PromiseOrValue<BigNumberish>
      • assetType: PromiseOrValue<BigNumberish>
      • tokenId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdrawNftTo:function
    • withdrawNftTo(arg0, arg1, arg2, arg3, overrides?): Promise<void>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<string>
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • withdrawTo:function
    • withdrawTo(arg0, arg1, arg2, overrides?): Promise<void>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<string>
      • Optional overrides: CallOverrides

      Returns Promise<void>

filters

filters: {
    LogDeposit(address,uint256,uint256,uint256,uint256,uint256)(depositorEthKey?, starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?) => LogDepositEventFilter;
    LogDeposit(depositorEthKey?, starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?) => LogDepositEventFilter;
    LogDepositCancel(uint256,uint256,uint256)(starkKey?, vaultId?, assetId?) => LogDepositCancelEventFilter;
    LogDepositCancel(starkKey?, vaultId?, assetId?) => LogDepositCancelEventFilter;
    LogDepositCancelReclaimed(uint256,uint256,uint256,uint256,uint256)(starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?) => LogDepositCancelReclaimedEventFilter;
    LogDepositCancelReclaimed(starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?) => LogDepositCancelReclaimedEventFilter;
    LogDepositNftCancelReclaimed(uint256,uint256,uint256,uint256,uint256)(starkKey?, vaultId?, assetType?, tokenId?, assetId?) => LogDepositNftCancelReclaimedEventFilter;
    LogDepositNftCancelReclaimed(starkKey?, vaultId?, assetType?, tokenId?, assetId?) => LogDepositNftCancelReclaimedEventFilter;
    LogFullWithdrawalRequest(uint256,uint256)(starkKey?, vaultId?) => LogFullWithdrawalRequestEventFilter;
    LogFullWithdrawalRequest(starkKey?, vaultId?) => LogFullWithdrawalRequestEventFilter;
    LogMintWithdrawalPerformed(uint256,uint256,uint256,uint256,uint256)(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, assetId?) => LogMintWithdrawalPerformedEventFilter;
    LogMintWithdrawalPerformed(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, assetId?) => LogMintWithdrawalPerformedEventFilter;
    LogMintableWithdrawalAllowed(uint256,uint256,uint256)(ownerKey?, assetId?, quantizedAmount?) => LogMintableWithdrawalAllowedEventFilter;
    LogMintableWithdrawalAllowed(ownerKey?, assetId?, quantizedAmount?) => LogMintableWithdrawalAllowedEventFilter;
    LogNftDeposit(address,uint256,uint256,uint256,uint256,uint256)(depositorEthKey?, starkKey?, vaultId?, assetType?, tokenId?, assetId?) => LogNftDepositEventFilter;
    LogNftDeposit(depositorEthKey?, starkKey?, vaultId?, assetType?, tokenId?, assetId?) => LogNftDepositEventFilter;
    LogNftWithdrawalAllowed(uint256,uint256)(ownerKey?, assetId?) => LogNftWithdrawalAllowedEventFilter;
    LogNftWithdrawalAllowed(ownerKey?, assetId?) => LogNftWithdrawalAllowedEventFilter;
    LogNftWithdrawalPerformed(uint256,uint256,uint256,uint256,address)(ownerKey?, assetType?, tokenId?, assetId?, recipient?) => LogNftWithdrawalPerformedEventFilter;
    LogNftWithdrawalPerformed(ownerKey?, assetType?, tokenId?, assetId?, recipient?) => LogNftWithdrawalPerformedEventFilter;
    LogRootUpdate(uint256,uint256,uint256,uint256)(sequenceNumber?, batchId?, vaultRoot?, orderRoot?) => LogRootUpdateEventFilter;
    LogRootUpdate(sequenceNumber?, batchId?, vaultRoot?, orderRoot?) => LogRootUpdateEventFilter;
    LogStateTransitionFact(bytes32)(stateTransitionFact?) => LogStateTransitionFactEventFilter;
    LogStateTransitionFact(stateTransitionFact?) => LogStateTransitionFactEventFilter;
    LogVaultBalanceChangeApplied(address,uint256,uint256,int256)(ethKey?, assetId?, vaultId?, quantizedAmountChange?) => LogVaultBalanceChangeAppliedEventFilter;
    LogVaultBalanceChangeApplied(ethKey?, assetId?, vaultId?, quantizedAmountChange?) => LogVaultBalanceChangeAppliedEventFilter;
    LogWithdrawalAllowed(uint256,uint256,uint256,uint256)(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?) => LogWithdrawalAllowedEventFilter;
    LogWithdrawalAllowed(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?) => LogWithdrawalAllowedEventFilter;
    LogWithdrawalPerformed(uint256,uint256,uint256,uint256,address)(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, recipient?) => LogWithdrawalPerformedEventFilter;
    LogWithdrawalPerformed(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, recipient?) => LogWithdrawalPerformedEventFilter;
}

Type declaration

  • LogDeposit(address,uint256,uint256,uint256,uint256,uint256):function
    • LogDeposit(address,uint256,uint256,uint256,uint256,uint256)(depositorEthKey?, starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?): LogDepositEventFilter

    • Parameters

      • Optional depositorEthKey: null
      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null

      Returns LogDepositEventFilter

  • LogDeposit:function
    • LogDeposit(depositorEthKey?, starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?): LogDepositEventFilter

    • Parameters

      • Optional depositorEthKey: null
      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null

      Returns LogDepositEventFilter

  • LogDepositCancel(uint256,uint256,uint256):function
    • LogDepositCancel(uint256,uint256,uint256)(starkKey?, vaultId?, assetId?): LogDepositCancelEventFilter

    • Parameters

      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetId: null

      Returns LogDepositCancelEventFilter

  • LogDepositCancel:function
  • LogDepositCancelReclaimed(uint256,uint256,uint256,uint256,uint256):function
    • LogDepositCancelReclaimed(uint256,uint256,uint256,uint256,uint256)(starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?): LogDepositCancelReclaimedEventFilter

    • Parameters

      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null

      Returns LogDepositCancelReclaimedEventFilter

  • LogDepositCancelReclaimed:function
    • LogDepositCancelReclaimed(starkKey?, vaultId?, assetType?, nonQuantizedAmount?, quantizedAmount?): LogDepositCancelReclaimedEventFilter

    • Parameters

      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null

      Returns LogDepositCancelReclaimedEventFilter

  • LogDepositNftCancelReclaimed(uint256,uint256,uint256,uint256,uint256):function
    • LogDepositNftCancelReclaimed(uint256,uint256,uint256,uint256,uint256)(starkKey?, vaultId?, assetType?, tokenId?, assetId?): LogDepositNftCancelReclaimedEventFilter

    • Parameters

      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional tokenId: null
      • Optional assetId: null

      Returns LogDepositNftCancelReclaimedEventFilter

  • LogDepositNftCancelReclaimed:function
    • LogDepositNftCancelReclaimed(starkKey?, vaultId?, assetType?, tokenId?, assetId?): LogDepositNftCancelReclaimedEventFilter

    • Parameters

      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional tokenId: null
      • Optional assetId: null

      Returns LogDepositNftCancelReclaimedEventFilter

  • LogFullWithdrawalRequest(uint256,uint256):function
  • LogFullWithdrawalRequest:function
  • LogMintWithdrawalPerformed(uint256,uint256,uint256,uint256,uint256):function
    • LogMintWithdrawalPerformed(uint256,uint256,uint256,uint256,uint256)(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, assetId?): LogMintWithdrawalPerformedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null
      • Optional assetId: null

      Returns LogMintWithdrawalPerformedEventFilter

  • LogMintWithdrawalPerformed:function
    • LogMintWithdrawalPerformed(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, assetId?): LogMintWithdrawalPerformedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null
      • Optional assetId: null

      Returns LogMintWithdrawalPerformedEventFilter

  • LogMintableWithdrawalAllowed(uint256,uint256,uint256):function
    • LogMintableWithdrawalAllowed(uint256,uint256,uint256)(ownerKey?, assetId?, quantizedAmount?): LogMintableWithdrawalAllowedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetId: null
      • Optional quantizedAmount: null

      Returns LogMintableWithdrawalAllowedEventFilter

  • LogMintableWithdrawalAllowed:function
    • LogMintableWithdrawalAllowed(ownerKey?, assetId?, quantizedAmount?): LogMintableWithdrawalAllowedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetId: null
      • Optional quantizedAmount: null

      Returns LogMintableWithdrawalAllowedEventFilter

  • LogNftDeposit(address,uint256,uint256,uint256,uint256,uint256):function
    • LogNftDeposit(address,uint256,uint256,uint256,uint256,uint256)(depositorEthKey?, starkKey?, vaultId?, assetType?, tokenId?, assetId?): LogNftDepositEventFilter

    • Parameters

      • Optional depositorEthKey: null
      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional tokenId: null
      • Optional assetId: null

      Returns LogNftDepositEventFilter

  • LogNftDeposit:function
    • LogNftDeposit(depositorEthKey?, starkKey?, vaultId?, assetType?, tokenId?, assetId?): LogNftDepositEventFilter

    • Parameters

      • Optional depositorEthKey: null
      • Optional starkKey: null
      • Optional vaultId: null
      • Optional assetType: null
      • Optional tokenId: null
      • Optional assetId: null

      Returns LogNftDepositEventFilter

  • LogNftWithdrawalAllowed(uint256,uint256):function
  • LogNftWithdrawalAllowed:function
  • LogNftWithdrawalPerformed(uint256,uint256,uint256,uint256,address):function
    • LogNftWithdrawalPerformed(uint256,uint256,uint256,uint256,address)(ownerKey?, assetType?, tokenId?, assetId?, recipient?): LogNftWithdrawalPerformedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional tokenId: null
      • Optional assetId: null
      • Optional recipient: null

      Returns LogNftWithdrawalPerformedEventFilter

  • LogNftWithdrawalPerformed:function
    • LogNftWithdrawalPerformed(ownerKey?, assetType?, tokenId?, assetId?, recipient?): LogNftWithdrawalPerformedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional tokenId: null
      • Optional assetId: null
      • Optional recipient: null

      Returns LogNftWithdrawalPerformedEventFilter

  • LogRootUpdate(uint256,uint256,uint256,uint256):function
    • LogRootUpdate(uint256,uint256,uint256,uint256)(sequenceNumber?, batchId?, vaultRoot?, orderRoot?): LogRootUpdateEventFilter

    • Parameters

      • Optional sequenceNumber: null
      • Optional batchId: null
      • Optional vaultRoot: null
      • Optional orderRoot: null

      Returns LogRootUpdateEventFilter

  • LogRootUpdate:function
    • LogRootUpdate(sequenceNumber?, batchId?, vaultRoot?, orderRoot?): LogRootUpdateEventFilter

    • Parameters

      • Optional sequenceNumber: null
      • Optional batchId: null
      • Optional vaultRoot: null
      • Optional orderRoot: null

      Returns LogRootUpdateEventFilter

  • LogStateTransitionFact(bytes32):function
  • LogStateTransitionFact:function
  • LogVaultBalanceChangeApplied(address,uint256,uint256,int256):function
    • LogVaultBalanceChangeApplied(address,uint256,uint256,int256)(ethKey?, assetId?, vaultId?, quantizedAmountChange?): LogVaultBalanceChangeAppliedEventFilter

    • Parameters

      • Optional ethKey: null
      • Optional assetId: null
      • Optional vaultId: null
      • Optional quantizedAmountChange: null

      Returns LogVaultBalanceChangeAppliedEventFilter

  • LogVaultBalanceChangeApplied:function
    • LogVaultBalanceChangeApplied(ethKey?, assetId?, vaultId?, quantizedAmountChange?): LogVaultBalanceChangeAppliedEventFilter

    • Parameters

      • Optional ethKey: null
      • Optional assetId: null
      • Optional vaultId: null
      • Optional quantizedAmountChange: null

      Returns LogVaultBalanceChangeAppliedEventFilter

  • LogWithdrawalAllowed(uint256,uint256,uint256,uint256):function
    • LogWithdrawalAllowed(uint256,uint256,uint256,uint256)(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?): LogWithdrawalAllowedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null

      Returns LogWithdrawalAllowedEventFilter

  • LogWithdrawalAllowed:function
    • LogWithdrawalAllowed(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?): LogWithdrawalAllowedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null

      Returns LogWithdrawalAllowedEventFilter

  • LogWithdrawalPerformed(uint256,uint256,uint256,uint256,address):function
    • LogWithdrawalPerformed(uint256,uint256,uint256,uint256,address)(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, recipient?): LogWithdrawalPerformedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null
      • Optional recipient: null

      Returns LogWithdrawalPerformedEventFilter

  • LogWithdrawalPerformed:function
    • LogWithdrawalPerformed(ownerKey?, assetType?, nonQuantizedAmount?, quantizedAmount?, recipient?): LogWithdrawalPerformedEventFilter

    • Parameters

      • Optional ownerKey: null
      • Optional assetType: null
      • Optional nonQuantizedAmount: null
      • Optional quantizedAmount: null
      • Optional recipient: null

      Returns LogWithdrawalPerformedEventFilter

estimateGas

estimateGas: {
    announceAvailabilityVerifierRemovalIntent(arg0, overrides?) => Promise<BigNumber>;
    announceVerifierRemovalIntent(arg0, overrides?) => Promise<BigNumber>;
    deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?) => Promise<BigNumber>;
    deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<BigNumber>;
    depositCancel(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<BigNumber>;
    depositEth(starkKey, assetType, vaultId, overrides?) => Promise<BigNumber>;
    depositNft(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<BigNumber>;
    depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<BigNumber>;
    depositReclaim(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    escape(starkKey, vaultId, assetId, quantizedAmount, overrides?) => Promise<BigNumber>;
    freezeRequest(starkKey, vaultId, overrides?) => Promise<BigNumber>;
    fullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<BigNumber>;
    getAssetInfo(assetType, overrides?) => Promise<BigNumber>;
    getCancellationRequest(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    getDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    getEthKey(starkKey, overrides?) => Promise<BigNumber>;
    getFullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<BigNumber>;
    getLastBatchId(overrides?) => Promise<BigNumber>;
    getOrderRoot(overrides?) => Promise<BigNumber>;
    getOrderTreeHeight(overrides?) => Promise<BigNumber>;
    getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<BigNumber>;
    getQuantum(presumedAssetType, overrides?) => Promise<BigNumber>;
    getRegisteredAvailabilityVerifiers(overrides?) => Promise<BigNumber>;
    getRegisteredVerifiers(overrides?) => Promise<BigNumber>;
    getSequenceNumber(overrides?) => Promise<BigNumber>;
    getVaultRoot(overrides?) => Promise<BigNumber>;
    getVaultTreeHeight(overrides?) => Promise<BigNumber>;
    getWithdrawalBalance(ownerKey, assetId, overrides?) => Promise<BigNumber>;
    isAvailabilityVerifier(arg0, overrides?) => Promise<BigNumber>;
    isFrozen(overrides?) => Promise<BigNumber>;
    isOperator(arg0, overrides?) => Promise<BigNumber>;
    isTokenAdmin(arg0, overrides?) => Promise<BigNumber>;
    isUserAdmin(arg0, overrides?) => Promise<BigNumber>;
    isVerifier(arg0, overrides?) => Promise<BigNumber>;
    mainAcceptGovernance(overrides?) => Promise<BigNumber>;
    mainCancelNomination(overrides?) => Promise<BigNumber>;
    mainIsGovernor(arg0, overrides?) => Promise<BigNumber>;
    mainNominateNewGovernor(arg0, overrides?) => Promise<BigNumber>;
    mainRemoveGovernor(arg0, overrides?) => Promise<BigNumber>;
    onERC721Received(arg0, arg1, arg2, arg3, overrides?) => Promise<BigNumber>;
    registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?) => Promise<BigNumber>;
    registerAndDepositEth(ethKey, starkKey, signature, assetType, vaultId, overrides?) => Promise<BigNumber>;
    registerAvailabilityVerifier(arg0, arg1, overrides?) => Promise<BigNumber>;
    registerOperator(arg0, overrides?) => Promise<BigNumber>;
    registerToken(arg0, arg1, overrides?) => Promise<BigNumber>;
    registerTokenAdmin(arg0, overrides?) => Promise<BigNumber>;
    registerUser(arg0, arg1, arg2, overrides?) => Promise<BigNumber>;
    registerUserAdmin(arg0, overrides?) => Promise<BigNumber>;
    registerVerifier(arg0, arg1, overrides?) => Promise<BigNumber>;
    removeAvailabilityVerifier(arg0, overrides?) => Promise<BigNumber>;
    removeVerifier(arg0, overrides?) => Promise<BigNumber>;
    unFreeze(overrides?) => Promise<BigNumber>;
    unregisterOperator(arg0, overrides?) => Promise<BigNumber>;
    unregisterTokenAdmin(arg0, overrides?) => Promise<BigNumber>;
    unregisterUserAdmin(arg0, overrides?) => Promise<BigNumber>;
    updateState(publicInput, applicationData, overrides?) => Promise<BigNumber>;
    withdraw(ownerKey, assetType, overrides?) => Promise<BigNumber>;
    withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?) => Promise<BigNumber>;
    withdrawNft(ownerKey, assetType, tokenId, overrides?) => Promise<BigNumber>;
    withdrawNftTo(arg0, arg1, arg2, arg3, overrides?) => Promise<BigNumber>;
    withdrawTo(arg0, arg1, arg2, overrides?) => Promise<BigNumber>;
}

Type declaration

  • announceAvailabilityVerifierRemovalIntent:function
    • announceAvailabilityVerifierRemovalIntent(arg0, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • announceVerifierRemovalIntent:function
  • deposit(uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • deposit(uint256,uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • depositCancel:function
    • depositCancel(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • depositERC20:function
    • depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • depositEth:function
    • depositEth(starkKey, assetType, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • depositNft:function
    • depositNft(starkKey, assetType, vaultId, tokenId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • depositNftReclaim:function
    • depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • depositReclaim:function
    • depositReclaim(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • escape:function
    • escape(starkKey, vaultId, assetId, quantizedAmount, overrides?): Promise<BigNumber>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • quantizedAmount: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • freezeRequest:function
    • freezeRequest(starkKey, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • fullWithdrawalRequest:function
    • fullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getAssetInfo:function
  • getCancellationRequest:function
    • getCancellationRequest(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getDepositBalance:function
    • getDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getEthKey:function
  • getFullWithdrawalRequest:function
    • getFullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getLastBatchId:function
  • getOrderRoot:function
  • getOrderTreeHeight:function
  • getQuantizedDepositBalance:function
    • getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getQuantum:function
  • getRegisteredAvailabilityVerifiers:function
  • getRegisteredVerifiers:function
  • getSequenceNumber:function
  • getVaultRoot:function
  • getVaultTreeHeight:function
  • getWithdrawalBalance:function
    • getWithdrawalBalance(ownerKey, assetId, overrides?): Promise<BigNumber>

    • Parameters

      • ownerKey: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isAvailabilityVerifier:function
  • isFrozen:function
  • isOperator:function
  • isTokenAdmin:function
  • isUserAdmin:function
  • isVerifier:function
  • mainAcceptGovernance:function
  • mainCancelNomination:function
  • mainIsGovernor:function
  • mainNominateNewGovernor:function
  • mainRemoveGovernor:function
  • onERC721Received:function
    • onERC721Received(arg0, arg1, arg2, arg3, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • registerAndDepositERC20:function
    • registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • registerAvailabilityVerifier:function
    • registerAvailabilityVerifier(arg0, arg1, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • registerOperator:function
  • registerToken:function
    • registerToken(arg0, arg1, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • registerTokenAdmin:function
  • registerUser:function
    • registerUser(arg0, arg1, arg2, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • registerUserAdmin:function
  • registerVerifier:function
    • registerVerifier(arg0, arg1, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • removeAvailabilityVerifier:function
  • removeVerifier:function
  • unFreeze:function
  • unregisterOperator:function
  • unregisterTokenAdmin:function
  • unregisterUserAdmin:function
  • updateState:function
    • updateState(publicInput, applicationData, overrides?): Promise<BigNumber>

    • Parameters

      • publicInput: PromiseOrValue<BigNumberish>[]
      • applicationData: PromiseOrValue<BigNumberish>[]
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • withdraw:function
    • withdraw(ownerKey, assetType, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • withdrawAndMint:function
    • withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • withdrawNft:function
    • withdrawNft(ownerKey, assetType, tokenId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • withdrawNftTo:function
    • withdrawNftTo(arg0, arg1, arg2, arg3, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

  • withdrawTo:function
    • withdrawTo(arg0, arg1, arg2, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<BigNumber>

populateTransaction

populateTransaction: {
    announceAvailabilityVerifierRemovalIntent(arg0, overrides?) => Promise<PopulatedTransaction>;
    announceVerifierRemovalIntent(arg0, overrides?) => Promise<PopulatedTransaction>;
    deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?) => Promise<PopulatedTransaction>;
    deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<PopulatedTransaction>;
    depositCancel(starkKey, assetId, vaultId, overrides?) => Promise<PopulatedTransaction>;
    depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?) => Promise<PopulatedTransaction>;
    depositEth(starkKey, assetType, vaultId, overrides?) => Promise<PopulatedTransaction>;
    depositNft(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<PopulatedTransaction>;
    depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?) => Promise<PopulatedTransaction>;
    depositReclaim(starkKey, assetId, vaultId, overrides?) => Promise<PopulatedTransaction>;
    escape(starkKey, vaultId, assetId, quantizedAmount, overrides?) => Promise<PopulatedTransaction>;
    freezeRequest(starkKey, vaultId, overrides?) => Promise<PopulatedTransaction>;
    fullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<PopulatedTransaction>;
    getAssetInfo(assetType, overrides?) => Promise<PopulatedTransaction>;
    getCancellationRequest(starkKey, assetId, vaultId, overrides?) => Promise<PopulatedTransaction>;
    getDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<PopulatedTransaction>;
    getEthKey(starkKey, overrides?) => Promise<PopulatedTransaction>;
    getFullWithdrawalRequest(starkKey, vaultId, overrides?) => Promise<PopulatedTransaction>;
    getLastBatchId(overrides?) => Promise<PopulatedTransaction>;
    getOrderRoot(overrides?) => Promise<PopulatedTransaction>;
    getOrderTreeHeight(overrides?) => Promise<PopulatedTransaction>;
    getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?) => Promise<PopulatedTransaction>;
    getQuantum(presumedAssetType, overrides?) => Promise<PopulatedTransaction>;
    getRegisteredAvailabilityVerifiers(overrides?) => Promise<PopulatedTransaction>;
    getRegisteredVerifiers(overrides?) => Promise<PopulatedTransaction>;
    getSequenceNumber(overrides?) => Promise<PopulatedTransaction>;
    getVaultRoot(overrides?) => Promise<PopulatedTransaction>;
    getVaultTreeHeight(overrides?) => Promise<PopulatedTransaction>;
    getWithdrawalBalance(ownerKey, assetId, overrides?) => Promise<PopulatedTransaction>;
    isAvailabilityVerifier(arg0, overrides?) => Promise<PopulatedTransaction>;
    isFrozen(overrides?) => Promise<PopulatedTransaction>;
    isOperator(arg0, overrides?) => Promise<PopulatedTransaction>;
    isTokenAdmin(arg0, overrides?) => Promise<PopulatedTransaction>;
    isUserAdmin(arg0, overrides?) => Promise<PopulatedTransaction>;
    isVerifier(arg0, overrides?) => Promise<PopulatedTransaction>;
    mainAcceptGovernance(overrides?) => Promise<PopulatedTransaction>;
    mainCancelNomination(overrides?) => Promise<PopulatedTransaction>;
    mainIsGovernor(arg0, overrides?) => Promise<PopulatedTransaction>;
    mainNominateNewGovernor(arg0, overrides?) => Promise<PopulatedTransaction>;
    mainRemoveGovernor(arg0, overrides?) => Promise<PopulatedTransaction>;
    onERC721Received(arg0, arg1, arg2, arg3, overrides?) => Promise<PopulatedTransaction>;
    registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?) => Promise<PopulatedTransaction>;
    registerAndDepositEth(ethKey, starkKey, signature, assetType, vaultId, overrides?) => Promise<PopulatedTransaction>;
    registerAvailabilityVerifier(arg0, arg1, overrides?) => Promise<PopulatedTransaction>;
    registerOperator(arg0, overrides?) => Promise<PopulatedTransaction>;
    registerToken(arg0, arg1, overrides?) => Promise<PopulatedTransaction>;
    registerTokenAdmin(arg0, overrides?) => Promise<PopulatedTransaction>;
    registerUser(arg0, arg1, arg2, overrides?) => Promise<PopulatedTransaction>;
    registerUserAdmin(arg0, overrides?) => Promise<PopulatedTransaction>;
    registerVerifier(arg0, arg1, overrides?) => Promise<PopulatedTransaction>;
    removeAvailabilityVerifier(arg0, overrides?) => Promise<PopulatedTransaction>;
    removeVerifier(arg0, overrides?) => Promise<PopulatedTransaction>;
    unFreeze(overrides?) => Promise<PopulatedTransaction>;
    unregisterOperator(arg0, overrides?) => Promise<PopulatedTransaction>;
    unregisterTokenAdmin(arg0, overrides?) => Promise<PopulatedTransaction>;
    unregisterUserAdmin(arg0, overrides?) => Promise<PopulatedTransaction>;
    updateState(publicInput, applicationData, overrides?) => Promise<PopulatedTransaction>;
    withdraw(ownerKey, assetType, overrides?) => Promise<PopulatedTransaction>;
    withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?) => Promise<PopulatedTransaction>;
    withdrawNft(ownerKey, assetType, tokenId, overrides?) => Promise<PopulatedTransaction>;
    withdrawNftTo(arg0, arg1, arg2, arg3, overrides?) => Promise<PopulatedTransaction>;
    withdrawTo(arg0, arg1, arg2, overrides?) => Promise<PopulatedTransaction>;
}

Type declaration

  • announceAvailabilityVerifierRemovalIntent:function
    • announceAvailabilityVerifierRemovalIntent(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • announceVerifierRemovalIntent:function
    • announceVerifierRemovalIntent(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • deposit(uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • deposit(uint256,uint256,uint256,uint256):function
    • deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • depositCancel:function
    • depositCancel(starkKey, assetId, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • depositERC20:function
    • depositERC20(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • depositEth:function
    • depositEth(starkKey, assetType, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • depositNft:function
    • depositNft(starkKey, assetType, vaultId, tokenId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • depositNftReclaim:function
    • depositNftReclaim(starkKey, assetType, vaultId, tokenId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • depositReclaim:function
    • depositReclaim(starkKey, assetId, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • escape:function
    • escape(starkKey, vaultId, assetId, quantizedAmount, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • starkKey: PromiseOrValue<BigNumberish>
      • vaultId: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • quantizedAmount: PromiseOrValue<BigNumberish>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • freezeRequest:function
    • freezeRequest(starkKey, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • fullWithdrawalRequest:function
    • fullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getAssetInfo:function
  • getCancellationRequest:function
    • getCancellationRequest(starkKey, assetId, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getDepositBalance:function
    • getDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getEthKey:function
  • getFullWithdrawalRequest:function
    • getFullWithdrawalRequest(starkKey, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getLastBatchId:function
  • getOrderRoot:function
  • getOrderTreeHeight:function
  • getQuantizedDepositBalance:function
    • getQuantizedDepositBalance(starkKey, assetId, vaultId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getQuantum:function
  • getRegisteredAvailabilityVerifiers:function
  • getRegisteredVerifiers:function
  • getSequenceNumber:function
  • getVaultRoot:function
  • getVaultTreeHeight:function
  • getWithdrawalBalance:function
    • getWithdrawalBalance(ownerKey, assetId, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ownerKey: PromiseOrValue<BigNumberish>
      • assetId: PromiseOrValue<BigNumberish>
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isAvailabilityVerifier:function
    • isAvailabilityVerifier(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • isFrozen:function
  • isOperator:function
  • isTokenAdmin:function
  • isUserAdmin:function
  • isVerifier:function
  • mainAcceptGovernance:function
  • mainCancelNomination:function
  • mainIsGovernor:function
    • mainIsGovernor(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • mainNominateNewGovernor:function
    • mainNominateNewGovernor(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • mainRemoveGovernor:function
    • mainRemoveGovernor(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • onERC721Received:function
    • onERC721Received(arg0, arg1, arg2, arg3, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • registerAndDepositERC20:function
    • registerAndDepositERC20(ethKey, starkKey, signature, assetType, vaultId, quantizedAmount, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerAvailabilityVerifier:function
    • registerAvailabilityVerifier(arg0, arg1, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • registerOperator:function
    • registerOperator(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerToken:function
    • registerToken(arg0, arg1, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • registerTokenAdmin:function
    • registerTokenAdmin(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerUser:function
    • registerUser(arg0, arg1, arg2, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BytesLike>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • registerUserAdmin:function
    • registerUserAdmin(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerVerifier:function
    • registerVerifier(arg0, arg1, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<string>
      • arg1: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • removeAvailabilityVerifier:function
    • removeAvailabilityVerifier(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • removeVerifier:function
    • removeVerifier(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • unFreeze:function
  • unregisterOperator:function
    • unregisterOperator(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • unregisterTokenAdmin:function
    • unregisterTokenAdmin(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • unregisterUserAdmin:function
    • unregisterUserAdmin(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updateState:function
    • updateState(publicInput, applicationData, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • publicInput: PromiseOrValue<BigNumberish>[]
      • applicationData: PromiseOrValue<BigNumberish>[]
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • withdraw:function
    • withdraw(ownerKey, assetType, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • withdrawAndMint:function
    • withdrawAndMint(ownerKey, assetType, mintingBlob, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • withdrawNft:function
    • withdrawNft(ownerKey, assetType, tokenId, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • withdrawNftTo:function
    • withdrawNftTo(arg0, arg1, arg2, arg3, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<BigNumberish>
      • arg3: PromiseOrValue<string>
      • Optional overrides: Overrides & {
            from?: PromiseOrValue<string>;
        }

      Returns Promise<PopulatedTransaction>

  • withdrawTo:function
    • withdrawTo(arg0, arg1, arg2, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: PromiseOrValue<BigNumberish>
      • arg1: PromiseOrValue<BigNumberish>
      • arg2: PromiseOrValue<string>
      • 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

announceAvailabilityVerifierRemovalIntent

  • Parameters

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

    Returns Promise<ContractTransaction>

announceVerifierRemovalIntent

  • Parameters

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

    Returns Promise<ContractTransaction>

deposit(uint256,uint256,uint256)

  • deposit(uint256,uint256,uint256)(starkKey, assetType, vaultId, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

deposit(uint256,uint256,uint256,uint256)

  • deposit(uint256,uint256,uint256,uint256)(starkKey, assetType, vaultId, quantizedAmount, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

depositCancel

  • Parameters

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

    Returns Promise<ContractTransaction>

depositERC20

  • Parameters

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

    Returns Promise<ContractTransaction>

depositEth

  • Parameters

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

    Returns Promise<ContractTransaction>

depositNft

  • Parameters

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

    Returns Promise<ContractTransaction>

depositNftReclaim

  • Parameters

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

    Returns Promise<ContractTransaction>

depositReclaim

  • Parameters

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

    Returns Promise<ContractTransaction>

escape

  • Parameters

    • starkKey: PromiseOrValue<BigNumberish>
    • vaultId: PromiseOrValue<BigNumberish>
    • assetId: PromiseOrValue<BigNumberish>
    • quantizedAmount: PromiseOrValue<BigNumberish>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

freezeRequest

  • Parameters

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

    Returns Promise<ContractTransaction>

fullWithdrawalRequest

  • Parameters

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

    Returns Promise<ContractTransaction>

getAssetInfo

getCancellationRequest

  • Parameters

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

    Returns Promise<BigNumber>

getDepositBalance

  • Parameters

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

    Returns Promise<BigNumber>

getEthKey

getFullWithdrawalRequest

  • Parameters

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

    Returns Promise<BigNumber>

getLastBatchId

getOrderRoot

getOrderTreeHeight

getQuantizedDepositBalance

  • Parameters

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

    Returns Promise<BigNumber>

getQuantum

getRegisteredAvailabilityVerifiers

getRegisteredVerifiers

getSequenceNumber

getVaultRoot

getVaultTreeHeight

getWithdrawalBalance

  • Parameters

    • ownerKey: PromiseOrValue<BigNumberish>
    • assetId: PromiseOrValue<BigNumberish>
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

isAvailabilityVerifier

  • Parameters

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

    Returns Promise<ContractTransaction>

isFrozen

isOperator

isTokenAdmin

isUserAdmin

isVerifier

mainAcceptGovernance

mainCancelNomination

mainIsGovernor

mainNominateNewGovernor

  • Parameters

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

    Returns Promise<ContractTransaction>

mainRemoveGovernor

  • Parameters

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

    Returns Promise<ContractTransaction>

onERC721Received

  • Parameters

    • arg0: PromiseOrValue<string>
    • arg1: PromiseOrValue<string>
    • arg2: PromiseOrValue<BigNumberish>
    • arg3: PromiseOrValue<BytesLike>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

registerAndDepositERC20

  • Parameters

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

    Returns Promise<ContractTransaction>

registerAndDepositEth

  • Parameters

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

    Returns Promise<ContractTransaction>

registerAvailabilityVerifier

  • Parameters

    • arg0: PromiseOrValue<string>
    • arg1: PromiseOrValue<string>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

registerOperator

  • Parameters

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

    Returns Promise<ContractTransaction>

registerToken

  • Parameters

    • arg0: PromiseOrValue<BigNumberish>
    • arg1: PromiseOrValue<BytesLike>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

registerTokenAdmin

  • Parameters

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

    Returns Promise<ContractTransaction>

registerUser

  • Parameters

    • arg0: PromiseOrValue<string>
    • arg1: PromiseOrValue<BigNumberish>
    • arg2: PromiseOrValue<BytesLike>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

registerUserAdmin

  • Parameters

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

    Returns Promise<ContractTransaction>

registerVerifier

  • Parameters

    • arg0: PromiseOrValue<string>
    • arg1: PromiseOrValue<string>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

removeAvailabilityVerifier

  • Parameters

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

    Returns Promise<ContractTransaction>

removeVerifier

unFreeze

unregisterOperator

  • Parameters

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

    Returns Promise<ContractTransaction>

unregisterTokenAdmin

  • Parameters

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

    Returns Promise<ContractTransaction>

unregisterUserAdmin

  • Parameters

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

    Returns Promise<ContractTransaction>

updateState

  • Parameters

    • publicInput: PromiseOrValue<BigNumberish>[]
    • applicationData: PromiseOrValue<BigNumberish>[]
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

withdraw

  • Parameters

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

    Returns Promise<ContractTransaction>

withdrawAndMint

  • Parameters

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

    Returns Promise<ContractTransaction>

withdrawNft

  • Parameters

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

    Returns Promise<ContractTransaction>

withdrawNftTo

  • Parameters

    • arg0: PromiseOrValue<BigNumberish>
    • arg1: PromiseOrValue<BigNumberish>
    • arg2: PromiseOrValue<BigNumberish>
    • arg3: PromiseOrValue<string>
    • Optional overrides: Overrides & {
          from?: PromiseOrValue<string>;
      }

    Returns Promise<ContractTransaction>

withdrawTo

  • Parameters

    • arg0: PromiseOrValue<BigNumberish>
    • arg1: PromiseOrValue<BigNumberish>
    • arg2: PromiseOrValue<string>
    • 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