Interface Describer

interface Describer {
    [internal]: any;
    cci_versions: TypedContractMethod<[arg0: BigNumberish], [string], "view">;
    factory_versions: TypedContractMethod<[arg0: BigNumberish], [string], "view">;
    fallback: null | WrappedFallback;
    filters: {
        ModifyTemplate: TypedContractEvent<ModifyTemplateEvent.InputTuple, ModifyTemplateEvent.OutputTuple, ModifyTemplateEvent.OutputObject>;
        ModifyTemplate(address,string): TypedContractEvent<ModifyTemplateEvent.InputTuple, ModifyTemplateEvent.OutputTuple, ModifyTemplateEvent.OutputObject>;
        ModifyWhitelistedCCI: TypedContractEvent<ModifyWhitelistedCCIEvent.InputTuple, ModifyWhitelistedCCIEvent.OutputTuple, ModifyWhitelistedCCIEvent.OutputObject>;
        ModifyWhitelistedCCI(address,string): TypedContractEvent<ModifyWhitelistedCCIEvent.InputTuple, ModifyWhitelistedCCIEvent.OutputTuple, ModifyWhitelistedCCIEvent.OutputObject>;
        ModifyWhitelistedFactory: TypedContractEvent<ModifyWhitelistedFactoryEvent.InputTuple, ModifyWhitelistedFactoryEvent.OutputTuple, ModifyWhitelistedFactoryEvent.OutputObject>;
        ModifyWhitelistedFactory(address,string): TypedContractEvent<ModifyWhitelistedFactoryEvent.InputTuple, ModifyWhitelistedFactoryEvent.OutputTuple, ModifyWhitelistedFactoryEvent.OutputObject>;
    };
    getNumVaultFactories: TypedContractMethod<[], [bigint], "view">;
    getNumWhitelistedCcis: TypedContractMethod<[], [bigint], "view">;
    getNumWhitelistedTemplates: TypedContractMethod<[], [bigint], "view">;
    getWhitelistedCCI: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    getWhitelistedFactories: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    getWhitelistedTemplates: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    get_factory_of_vault: TypedContractMethod<[vault: AddressLike], [string], "view">;
    get_num_vault_factories: TypedContractMethod<[], [bigint], "view">;
    get_num_whitelisted_ccis: TypedContractMethod<[], [bigint], "view">;
    get_num_whitelisted_templates: TypedContractMethod<[], [bigint], "view">;
    get_vault_factories: TypedContractMethod<[], [string[]], "view">;
    get_vault_mathematical_lib: TypedContractMethod<[vault: AddressLike], [string], "view">;
    get_vault_prices: TypedContractMethod<[vault: AddressLike], [bigint[]], "view">;
    get_vault_tokens: TypedContractMethod<[vault: AddressLike], [string[]], "view">;
    get_whitelisted_CCI: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    get_whitelisted_templates: TypedContractMethod<[], [string[]], "view">;
    initBlock: TypedContractMethod<[], [bigint], "view">;
    interface: DescriberInterface;
    latestRouter: TypedContractMethod<[], [string], "view">;
    modifyWhitelistedCCI: TypedContractMethod<[cci_address: AddressLike, version: string], [void], "nonpayable">;
    modifyWhitelistedFactory: TypedContractMethod<[factory_address: AddressLike, version: string], [void], "nonpayable">;
    modifyWhitelistedTemplate: TypedContractMethod<[template_address: AddressLike, version: string], [void], "nonpayable">;
    owner: TypedContractMethod<[], [string], "view">;
    removeWhitelistedCCI: TypedContractMethod<[cci_to_remove: AddressLike, version: string], [void], "nonpayable">;
    removeWhitelistedFactory: TypedContractMethod<[factory_to_remove: AddressLike, version: string], [void], "nonpayable">;
    removeWhitelistedTemplate: TypedContractMethod<[template_to_remove: AddressLike, version: string], [void], "nonpayable">;
    renounceOwnership: TypedContractMethod<[], [void], "nonpayable">;
    runner: null | ContractRunner;
    set_latest_router: TypedContractMethod<[newRouter: AddressLike], [void], "nonpayable">;
    target: string | Addressable;
    template_versions: TypedContractMethod<[arg0: BigNumberish], [string], "view">;
    transferOwnership: TypedContractMethod<[newOwner: AddressLike], [void], "nonpayable">;
    version_to_cci: TypedContractMethod<[arg0: string], [string], "view">;
    version_to_factory: TypedContractMethod<[arg0: string], [string], "view">;
    version_to_template: TypedContractMethod<[arg0: string], [string], "view">;
    addListener(event, listener): Promise<Describer>;
    attach(target): BaseContract;
    connect(runner?): Describer;
    deploymentTransaction(): null | ContractTransactionResponse;
    emit(event, ...args): Promise<boolean>;
    getAddress(): Promise<string>;
    getDeployedCode(): Promise<null | string>;
    getEvent(key): TypedContractEvent<ModifyTemplateEvent.InputTuple, ModifyTemplateEvent.OutputTuple, ModifyTemplateEvent.OutputObject>;
    getEvent(key): TypedContractEvent<ModifyWhitelistedCCIEvent.InputTuple, ModifyWhitelistedCCIEvent.OutputTuple, ModifyWhitelistedCCIEvent.OutputObject>;
    getEvent(key): TypedContractEvent<ModifyWhitelistedFactoryEvent.InputTuple, ModifyWhitelistedFactoryEvent.OutputTuple, ModifyWhitelistedFactoryEvent.OutputObject>;
    getFunction<T>(key): T;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: BigNumberish], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: BigNumberish], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[vault: AddressLike], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [string[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[vault: AddressLike], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[vault: AddressLike], [bigint[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[vault: AddressLike], [string[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [string[]], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[cci_address: AddressLike, version: string], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[factory_address: AddressLike, version: string], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[template_address: AddressLike, version: string], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[cci_to_remove: AddressLike, version: string], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[factory_to_remove: AddressLike, version: string], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[template_to_remove: AddressLike, version: string], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[newRouter: AddressLike], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: BigNumberish], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[newOwner: AddressLike], [void], "nonpayable">;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: string], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: string], [string], "view">;
    getFunction(nameOrSignature): TypedContractMethod<[arg0: string], [string], "view">;
    listenerCount(event?): Promise<number>;
    listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>;
    listeners(eventName?): Promise<Listener[]>;
    off(event, listener?): Promise<Describer>;
    on<TCEvent>(event, listener): Promise<Describer>;
    on<TCEvent>(filter, listener): Promise<Describer>;
    once<TCEvent>(event, listener): Promise<Describer>;
    once<TCEvent>(filter, listener): Promise<Describer>;
    queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>;
    queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>;
    queryTransaction(hash): Promise<EventLog[]>;
    removeAllListeners<TCEvent>(event?): Promise<Describer>;
    removeListener(event, listener): Promise<Describer>;
    waitForDeployment(): Promise<Describer>;
}

Hierarchy

  • BaseContract
    • Describer

Properties

[internal] cci_versions factory_versions fallback filters getNumVaultFactories getNumWhitelistedCcis getNumWhitelistedTemplates getWhitelistedCCI getWhitelistedFactories getWhitelistedTemplates get_factory_of_vault get_num_vault_factories get_num_whitelisted_ccis get_num_whitelisted_templates get_vault_factories get_vault_mathematical_lib get_vault_prices get_vault_tokens get_whitelisted_CCI get_whitelisted_templates initBlock interface latestRouter modifyWhitelistedCCI modifyWhitelistedFactory modifyWhitelistedTemplate owner removeWhitelistedCCI removeWhitelistedFactory removeWhitelistedTemplate renounceOwnership runner set_latest_router target template_versions transferOwnership version_to_cci version_to_factory version_to_template

Methods

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

Properties

Readonly [internal]

[internal]: any

@_ignore:

cci_versions

cci_versions: TypedContractMethod<[arg0: BigNumberish], [string], "view">

factory_versions

factory_versions: TypedContractMethod<[arg0: BigNumberish], [string], "view">

Readonly fallback

fallback: null | WrappedFallback

The fallback or receive function if any.

filters

filters: {
    ModifyTemplate: TypedContractEvent<ModifyTemplateEvent.InputTuple, ModifyTemplateEvent.OutputTuple, ModifyTemplateEvent.OutputObject>;
    ModifyTemplate(address,string): TypedContractEvent<ModifyTemplateEvent.InputTuple, ModifyTemplateEvent.OutputTuple, ModifyTemplateEvent.OutputObject>;
    ModifyWhitelistedCCI: TypedContractEvent<ModifyWhitelistedCCIEvent.InputTuple, ModifyWhitelistedCCIEvent.OutputTuple, ModifyWhitelistedCCIEvent.OutputObject>;
    ModifyWhitelistedCCI(address,string): TypedContractEvent<ModifyWhitelistedCCIEvent.InputTuple, ModifyWhitelistedCCIEvent.OutputTuple, ModifyWhitelistedCCIEvent.OutputObject>;
    ModifyWhitelistedFactory: TypedContractEvent<ModifyWhitelistedFactoryEvent.InputTuple, ModifyWhitelistedFactoryEvent.OutputTuple, ModifyWhitelistedFactoryEvent.OutputObject>;
    ModifyWhitelistedFactory(address,string): TypedContractEvent<ModifyWhitelistedFactoryEvent.InputTuple, ModifyWhitelistedFactoryEvent.OutputTuple, ModifyWhitelistedFactoryEvent.OutputObject>;
}

Type declaration

getNumVaultFactories

getNumVaultFactories: TypedContractMethod<[], [bigint], "view">

getNumWhitelistedCcis

getNumWhitelistedCcis: TypedContractMethod<[], [bigint], "view">

getNumWhitelistedTemplates

getNumWhitelistedTemplates: TypedContractMethod<[], [bigint], "view">

getWhitelistedCCI

getWhitelistedCCI: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">

getWhitelistedFactories

getWhitelistedFactories: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">

getWhitelistedTemplates

getWhitelistedTemplates: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">

get_factory_of_vault

get_factory_of_vault: TypedContractMethod<[vault: AddressLike], [string], "view">

get_num_vault_factories

get_num_vault_factories: TypedContractMethod<[], [bigint], "view">

get_num_whitelisted_ccis

get_num_whitelisted_ccis: TypedContractMethod<[], [bigint], "view">

get_num_whitelisted_templates

get_num_whitelisted_templates: TypedContractMethod<[], [bigint], "view">

get_vault_factories

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

get_vault_mathematical_lib

get_vault_mathematical_lib: TypedContractMethod<[vault: AddressLike], [string], "view">

get_vault_prices

get_vault_prices: TypedContractMethod<[vault: AddressLike], [bigint[]], "view">

get_vault_tokens

get_vault_tokens: TypedContractMethod<[vault: AddressLike], [string[]], "view">

get_whitelisted_CCI

get_whitelisted_CCI: TypedContractMethod<[], [CatalystDescriber.AddressAndVersionStructOutput[]], "view">

get_whitelisted_templates

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

initBlock

initBlock: TypedContractMethod<[], [bigint], "view">

interface

interface: DescriberInterface

latestRouter

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

modifyWhitelistedCCI

modifyWhitelistedCCI: TypedContractMethod<[cci_address: AddressLike, version: string], [void], "nonpayable">

modifyWhitelistedFactory

modifyWhitelistedFactory: TypedContractMethod<[factory_address: AddressLike, version: string], [void], "nonpayable">

modifyWhitelistedTemplate

modifyWhitelistedTemplate: TypedContractMethod<[template_address: AddressLike, version: string], [void], "nonpayable">

owner

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

removeWhitelistedCCI

removeWhitelistedCCI: TypedContractMethod<[cci_to_remove: AddressLike, version: string], [void], "nonpayable">

removeWhitelistedFactory

removeWhitelistedFactory: TypedContractMethod<[factory_to_remove: AddressLike, version: string], [void], "nonpayable">

removeWhitelistedTemplate

removeWhitelistedTemplate: TypedContractMethod<[template_to_remove: AddressLike, version: string], [void], "nonpayable">

renounceOwnership

renounceOwnership: TypedContractMethod<[], [void], "nonpayable">

Readonly runner

runner: null | ContractRunner

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

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

set_latest_router

set_latest_router: TypedContractMethod<[newRouter: AddressLike], [void], "nonpayable">

Readonly target

target: string | Addressable

The target to connect to.

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

template_versions

template_versions: TypedContractMethod<[arg0: BigNumberish], [string], "view">

transferOwnership

transferOwnership: TypedContractMethod<[newOwner: AddressLike], [void], "nonpayable">

version_to_cci

version_to_cci: TypedContractMethod<[arg0: string], [string], "view">

version_to_factory

version_to_factory: TypedContractMethod<[arg0: string], [string], "view">

version_to_template

version_to_template: TypedContractMethod<[arg0: string], [string], "view">

Methods

addListener

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

  • Alias for [on].

    Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<Describer>

attach

  • attach(target): BaseContract

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

    Parameters

    • target: string | Addressable

    Returns BaseContract

connect

deploymentTransaction

  • deploymentTransaction(): null | ContractTransactionResponse

  • Return the transaction used to deploy this contract.

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

    Returns null | ContractTransactionResponse

emit

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

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

    Resolves to true if any listeners were called.

    Parameters

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

    Returns Promise<boolean>

getAddress

  • getAddress(): Promise<string>

  • Return the resolved address of this Contract.

    Returns Promise<string>

getDeployedCode

  • getDeployedCode(): Promise<null | string>

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

    Returns Promise<null | string>

getEvent

getFunction

listenerCount

  • listenerCount(event?): Promise<number>

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

    Parameters

    • Optional event: ContractEventName

    Returns Promise<number>

listeners

off

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

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

    Parameters

    • event: ContractEventName
    • Optional listener: Listener

    Returns Promise<Describer>

on

once

queryFilter

queryTransaction

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

  • @_ignore:

    Parameters

    • hash: string

    Returns Promise<EventLog[]>

removeAllListeners

removeListener

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

  • Alias for [off].

    Parameters

    • event: ContractEventName
    • listener: Listener

    Returns Promise<Describer>

waitForDeployment

Settings

Member Visibility

Theme

On This Page

[internal]cci_versionsfactory_versionsfallbackfiltersgetNumVaultFactoriesgetNumWhitelistedCcisgetNumWhitelistedTemplatesgetWhitelistedCCIgetWhitelistedFactoriesgetWhitelistedTemplatesget_factory_of_vaultget_num_vault_factoriesget_num_whitelisted_ccisget_num_whitelisted_templatesget_vault_factoriesget_vault_mathematical_libget_vault_pricesget_vault_tokensget_whitelisted_CCIget_whitelisted_templatesinitBlockinterfacelatestRoutermodifyWhitelistedCCImodifyWhitelistedFactorymodifyWhitelistedTemplateownerremoveWhitelistedCCIremoveWhitelistedFactoryremoveWhitelistedTemplaterenounceOwnershiprunnerset_latest_routertargettemplate_versionstransferOwnershipversion_to_cciversion_to_factoryversion_to_templateaddListenerattachconnectdeploymentTransactionemitgetAddressgetDeployedCodegetEventgetFunctionlistenerCountlistenersoffononcequeryFilterqueryTransactionremoveAllListenersremoveListenerwaitForDeployment