Class BoostRegistry

Constructs a new Boost Registry. A registry for base implementations and cloned instances. This contract is used to register base implementations and deploy new instances of those implementations for use within the Boost protocol.

See

BoostRegistryConfig

Export

BoostRegistry

Hierarchy (view full)

Deployable<never[], typeof boostRegistryAbi>
- BoostRegistry

Constructors

constructor

new BoostRegistry(param0): BoostRegistry
Creates an instance of BoostRegistry.
Parameters
- param0: BoostRegistryConfig
Returns BoostRegistry
See
BoostRegistryConfig
Overrides Deployable.constructor
- Defined in packages/sdk/src/BoostRegistry.ts:223

Properties

`Static` `Readonly`addresses

addresses: Record<number, `0x${string}`> = BOOST_REGISTRY_ADDRESSES

A static property representing a map of stringified chain ID's to the address of the deployed implementation on chain

Static

`Readonly`abi

abi: readonly [{
    type: "error";
    inputs: readonly [{
        name: "registryType";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
    }, {
        name: "identifier";
        internalType: "bytes32";
        type: "bytes32";
    }];
    name: "AlreadyRegistered";
}, {
    type: "error";
    inputs: readonly [{
        name: "implementation";
        internalType: "address";
        type: "address";
    }];
    name: "NotACloneable";
}, {
    type: "error";
    inputs: readonly [{
        name: "identifier";
        internalType: "bytes32";
        type: "bytes32";
    }];
    name: "NotRegistered";
}, {
    type: "error";
    inputs: readonly [];
    name: "Reentrancy";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "registryType";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
        indexed: true;
    }, {
        name: "identifier";
        internalType: "bytes32";
        type: "bytes32";
        indexed: true;
    }, {
        name: "baseImplementation";
        internalType: "address";
        type: "address";
        indexed: false;
    }, {
        name: "deployedInstance";
        internalType: "contract ACloneable";
        type: "address";
        indexed: false;
    }];
    name: "Deployed";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "registryType";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
        indexed: true;
    }, {
        name: "identifier";
        internalType: "bytes32";
        type: "bytes32";
        indexed: true;
    }, {
        name: "implementation";
        internalType: "address";
        type: "address";
        indexed: false;
    }];
    name: "Registered";
}, {
    type: "function";
    inputs: readonly [{
        name: "type_";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
    }, {
        name: "base_";
        internalType: "address";
        type: "address";
    }, {
        name: "name_";
        internalType: "string";
        type: "string";
    }, {
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "deployClone";
    outputs: readonly [{
        name: "instance";
        internalType: "contract ACloneable";
        type: "address";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "identifier_";
        internalType: "bytes32";
        type: "bytes32";
    }];
    name: "getBaseImplementation";
    outputs: readonly [{
        name: "implementation";
        internalType: "contract ACloneable";
        type: "address";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "identifier_";
        internalType: "bytes32";
        type: "bytes32";
    }];
    name: "getClone";
    outputs: readonly [{
        name: "clone";
        internalType: "struct ABoostRegistry.Clone";
        type: "tuple";
        components: readonly [{
            name: "baseType";
            internalType: "enum ABoostRegistry.RegistryType";
            type: "uint8";
        }, {
            name: "instance";
            internalType: "contract ACloneable";
            type: "address";
        }, {
            name: "deployer";
            internalType: "address";
            type: "address";
        }, {
            name: "name";
            internalType: "string";
            type: "string";
        }];
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "type_";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
    }, {
        name: "base_";
        internalType: "address";
        type: "address";
    }, {
        name: "deployer_";
        internalType: "address";
        type: "address";
    }, {
        name: "name_";
        internalType: "string";
        type: "string";
    }];
    name: "getCloneIdentifier";
    outputs: readonly [{
        name: "identifier";
        internalType: "bytes32";
        type: "bytes32";
    }];
    stateMutability: "pure";
}, {
    type: "function";
    inputs: readonly [{
        name: "deployer_";
        internalType: "address";
        type: "address";
    }];
    name: "getClones";
    outputs: readonly [{
        name: "";
        internalType: "bytes32[]";
        type: "bytes32[]";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "type_";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
    }, {
        name: "name_";
        internalType: "string";
        type: "string";
    }];
    name: "getIdentifier";
    outputs: readonly [{
        name: "identifier";
        internalType: "bytes32";
        type: "bytes32";
    }];
    stateMutability: "pure";
}, {
    type: "function";
    inputs: readonly [{
        name: "type_";
        internalType: "enum ABoostRegistry.RegistryType";
        type: "uint8";
    }, {
        name: "name_";
        internalType: "string";
        type: "string";
    }, {
        name: "implementation_";
        internalType: "address";
        type: "address";
    }];
    name: "register";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "interfaceId";
        internalType: "bytes4";
        type: "bytes4";
    }];
    name: "supportsInterface";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}]

`Protected`_payload

_payload: undefined | never[]

The deployable payload used either for contract construction or initialization

`Protected`_config

_config: Config

See

Wagmi Configuration

`Protected`_address

_address: undefined | `0x${string}`

The internally managed address for this contract

`Protected` `Optional`_account

_account?: Account

If it exists, Viem Local Account, if in a Node environment

Accessors

addresses

get addresses(): Record<number, `0x${string}`>
A getter that will return Boost registry's static addresses by numerical chain ID

Returns Record<number, `0x${string}`>
- Defined in packages/sdk/src/BoostRegistry.ts:209

payload

get payload(): undefined | Payload
Returns the attached deployable payload, if it exists

Returns undefined | Payload
Inherited from Deployable.payload
- Defined in packages/sdk/src/Deployable/Deployable.ts:125

address

get address(): undefined | `0x${string}`
A getter returning this contract's deployed address, if it exists.

Returns undefined | `0x${string}`
Inherited from Deployable.address
- Defined in packages/sdk/src/Deployable/Contract.ts:66

Methods

register

register(registryType, name, implementation, params?): Promise<void>
Register a new base implementation of a given type
Parameters
- registryType: RegistryType
  The base type for the implementation
- name: string
  A name for the implementation (must be unique within the given type)
- implementation: `0x${string}`
  The address of the implementation contract
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
  Optional params to provide the underlying Viem contract call
Returns Promise<void>
Async
Example
```
await registry.register(ContractAction.registryType, 'ContractAction', ContractAction.base)
```
- Defined in packages/sdk/src/BoostRegistry.ts:252

registerRaw

registerRaw(registryType, name, implementation, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Parameters
- registryType: RegistryType
- name: string
- implementation: `0x${string}`
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<{
hash: `0x${string}`;
result: void;
}>
See
register

Async
- Defined in packages/sdk/src/BoostRegistry.ts:273

initialize

initialize<Target>(displayName, target, params?): Promise<Target>
Initialize a new instance of a registered base implementation, returning the provided target with a new address set on it. This method is the same as clone, but serves to make its function more obvious as to why you'd need to use it.
Type Parameters
- Target extends DeployableTarget<any, any>
Parameters
- displayName: string
  The display name for the clone
- target: Target
  An instance of a target contract to clone and initialize
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<Target>
- The provided instance, but with a new address attached. biome-ignore lint/suspicious/noExplicitAny: any deployable target will suffice
Async
- Defined in packages/sdk/src/BoostRegistry.ts:310

initializeRaw

initializeRaw<Target>(displayName, target, params?): Promise<HashAndSimulatedResult<`0x${string}`> & {
target: Target;
}>
Initialize a new instance of a registered base implementation, returning a transaction hash, resulting address from simulated transaction, and the given target bound to the resulting address. This method is the same as deployCloneRaw, but serves to make its function more obvious as to why you'd need to use it.
Type Parameters
- Target extends DeployableTarget<unknown, Abi>
Parameters
- displayName: string
  The display name for the clone
- target: Target
  An instance of a target contract to clone and initialize
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<HashAndSimulatedResult<`0x${string}`> & {
target: Target;
}>
- The transaction hash, simulated return address, and given target bound to simulated return address
Async
- Defined in packages/sdk/src/BoostRegistry.ts:330

clone

clone<Target>(displayName, target, params?): Promise<Target>
Deploy a new instance of a registered base implementation, returning the provided target with a new address set on it.
Type Parameters
- Target extends DeployableTarget<any, any>
Parameters
- displayName: string
  The display name for the clone
- target: Target
  An instance of a target contract to clone and initialize
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<Target>
- The provided instance, but with a new address attached. biome-ignore lint/suspicious/noExplicitAny: any deployable target will suffice
Async
- Defined in packages/sdk/src/BoostRegistry.ts:355

deployClone

deployClone<Target>(displayName, target, params?): Promise<`0x${string}`>
Type Parameters
- Target extends DeployableTarget<any, any>
Parameters
- displayName: string
- target: Target
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
biome-ignore lint/suspicious/noExplicitAny: any deployable target will suffice

See
clone

Async
- Defined in packages/sdk/src/BoostRegistry.ts:376

deployCloneRaw

deployCloneRaw<Target>(displayName, target, params?): Promise<HashAndSimulatedResult<`0x${string}`>>
Type Parameters
- Target extends DeployableTarget<any, any>
Parameters
- displayName: string
- target: Target
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<HashAndSimulatedResult<`0x${string}`>>
- The transaction hash biome-ignore lint/suspicious/noExplicitAny: any deployable target will suffice
See
clone

Async
- Defined in packages/sdk/src/BoostRegistry.ts:396

getBaseImplementation

getBaseImplementation(identifier, params?): Promise<`0x${string}`>
Get the address of a registered base implementation. This function will revert if the implementation is not registered
Parameters
- identifier: `0x${string}`
  The unique identifier for the implementation (see {getIdentifier})
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
- The address of the implementation
Async
- Defined in packages/sdk/src/BoostRegistry.ts:438

getClone

getClone(identifier, params?): Promise<Clone>
Get the address of a deployed clone by its identifier
Parameters
- identifier: `0x${string}`
  The unique identifier for the deployed clone (see {getCloneIdentifier})
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<Clone>
- The on-chain representation of the clone
Async
- Defined in packages/sdk/src/BoostRegistry.ts:461

getClones

getClones(deployer, params?): Promise<readonly `0x${string}`[]>
Get the list of identifiers of deployed clones for a given deployer
Parameters
- deployer: `0x${string}`
  The address of the deployer
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<readonly `0x${string}`[]>
- The list of deployed clones for the given deployer
Async
- Defined in packages/sdk/src/BoostRegistry.ts:484

getCloneIdentifier

getCloneIdentifier(registryType, base, deployer, displayName, params?): Promise<`0x${string}`>
Build the identifier for a clone of a base implementation
Parameters
- registryType: RegistryType
  The base type for the implementation
- base: `0x${string}`
  The address of the base implementation
- deployer: `0x${string}`
  The address of the deployer
- displayName: string
  The display name of the clone
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
- The unique identifier for the clone
Async
- Defined in packages/sdk/src/BoostRegistry.ts:510

getIdentifier

getIdentifier(registryType, displayName, params?): Promise<`0x${string}`>
Build the identifier for a base implementation
Parameters
- registryType: RegistryType
  The base type for the implementation
- displayName: string
  The name of the implementation
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
- The unique identifier for the implementation
Async
- Defined in packages/sdk/src/BoostRegistry.ts:540

buildParameters

buildParameters(_payload?, _options?): GenericDeployableParams
Base parameter constructor, should return a partial viem.deployContract parameters shape including abi, bytecode, and arguments, if any. Expected to be overridden by protocol contracts.
Parameters
- Optional_payload: never[]
- Optional_options: DeployableOptions
Returns GenericDeployableParams
Overrides Deployable.buildParameters
- Defined in packages/sdk/src/BoostRegistry.ts:566

withPayload

withPayload(payload): BoostRegistry
Attaches a new payload for use with this deployable's initialization
Parameters
- payload: never[]
Returns BoostRegistry
Inherited from Deployable.withPayload
- Defined in packages/sdk/src/Deployable/Deployable.ts:136

deploy

deploy(_payload?, _options?, waitParams?): Promise<BoostRegistry>
High level deployment function to deploy and await the contract address. This is mainly a convenience method to easily deploy a contract, but will not initialize a Cloneable, which makes it useless for Boost components. Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
Parameters
- Optional_payload: never[]
- Optional_options: DeployableOptions
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
  See viem.WaitForTransactionReceipt
Returns Promise<BoostRegistry>
Async
Inherited from Deployable.deploy
- Defined in packages/sdk/src/Deployable/Deployable.ts:154

deployRaw

deployRaw(_payload?, _options?): Promise<`0x${string}`>
The lower level contract deployment function that does not await for the transaction receipt. This is mainly a convenience method to easily deploy a contract, but will not initialize a Cloneable, which makes it useless for Boost components. Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
Parameters
- Optional_payload: never[]
- Optional_options: DeployableOptions
Returns Promise<`0x${string}`>
Async
Throws
DeployableAlreadyDeployedError

Throws
DeployableWagmiConfigurationRequiredError

Throws
DeployableMissingPayloadError
Inherited from Deployable.deployRaw
- Defined in packages/sdk/src/Deployable/Deployable.ts:184

at

at(address): BoostRegistry
Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.
Parameters
- address: `0x${string}`
Returns BoostRegistry
Inherited from Deployable.at
- Defined in packages/sdk/src/Deployable/Contract.ts:77

withConfig

withConfig(config): BoostRegistry
Will set this contract's internal Wagmi Configuration and return the instance for chaining.
Parameters
- config: Config
Returns BoostRegistry
Inherited from Deployable.withConfig
- Defined in packages/sdk/src/Deployable/Contract.ts:89

assertValidAddress

assertValidAddress(): `0x${string}`
Utility function to validate the existence of an address on this Contract.

Returns `0x${string}`
Throws
ContractAddressRequiredError if no address exists on this Contract instance
Inherited from Deployable.assertValidAddress
- Defined in packages/sdk/src/Deployable/Contract.ts:101

getLogs

getLogs<event, const abiEvent>(params?): Promise<GetLogsReturnType<abiEvent, abiEvent[]>>
A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs]. Accepts eventName and eventNames as optional parameters to narrow the returned log types.
Type Parameters
- event extends "Deployed" | "Registered"
- const abiEvent extends {
      name: event;
  } & {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "baseImplementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }, {
          name: "deployedInstance";
          internalType: "contract ACloneable";
          type: "address";
          indexed: false;
      }];
      name: "Deployed";
  } | {
      name: event;
  } & {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "implementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }];
      name: "Registered";
  } = Extract<{
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "baseImplementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }, {
          name: "deployedInstance";
          internalType: "contract ACloneable";
          type: "address";
          indexed: false;
      }];
      name: "Deployed";
  }, {
      name: event;
  }> | Extract<{
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "implementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }];
      name: "Registered";
  }, {
      name: event;
  }>
Parameters
- Optionalparams: Omit<GetLogsParams<readonly [{
      type: "error";
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
      }];
      name: "AlreadyRegistered";
  }, {
      type: "error";
      inputs: readonly [{
          name: "implementation";
          internalType: "address";
          type: "address";
      }];
      name: "NotACloneable";
  }, {
      type: "error";
      inputs: readonly [{
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
      }];
      name: "NotRegistered";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Reentrancy";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "baseImplementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }, {
          name: "deployedInstance";
          internalType: "contract ACloneable";
          type: "address";
          indexed: false;
      }];
      name: "Deployed";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "implementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }];
      name: "Registered";
  }, {
      type: "function";
      inputs: readonly [{
          name: "type_";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
      }, {
          name: "base_";
          internalType: "address";
          type: "address";
      }, {
          name: "name_";
          internalType: "string";
          type: "string";
      }, {
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "deployClone";
      outputs: readonly [{
          name: "instance";
          internalType: "contract ACloneable";
          type: "address";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "identifier_";
          internalType: "bytes32";
          type: "bytes32";
      }];
      name: "getBaseImplementation";
      outputs: readonly [{
          name: "implementation";
          internalType: "contract ACloneable";
          type: "address";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "identifier_";
          internalType: "bytes32";
          type: "bytes32";
      }];
      name: "getClone";
      outputs: readonly [{
          name: "clone";
          internalType: "struct ABoostRegistry.Clone";
          type: "tuple";
          components: readonly [{
              name: "baseType";
              internalType: "enum ABoostRegistry.RegistryType";
              type: "uint8";
          }, {
              name: "instance";
              internalType: "contract ACloneable";
              type: "address";
          }, {
              name: "deployer";
              internalType: "address";
              type: "address";
          }, {
              name: "name";
              internalType: "string";
              type: "string";
          }];
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "type_";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
      }, {
          name: "base_";
          internalType: "address";
          type: "address";
      }, {
          name: "deployer_";
          internalType: "address";
          type: "address";
      }, {
          name: "name_";
          internalType: "string";
          type: "string";
      }];
      name: "getCloneIdentifier";
      outputs: readonly [{
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: "deployer_";
          internalType: "address";
          type: "address";
      }];
      name: "getClones";
      outputs: readonly [{
          name: "";
          internalType: "bytes32[]";
          type: "bytes32[]";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "type_";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
      }, {
          name: "name_";
          internalType: "string";
          type: "string";
      }];
      name: "getIdentifier";
      outputs: readonly [{
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: "type_";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
      }, {
          name: "name_";
          internalType: "string";
          type: "string";
      }, {
          name: "implementation_";
          internalType: "address";
          type: "address";
      }];
      name: "register";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "interfaceId";
          internalType: "bytes4";
          type: "bytes4";
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }], event, abiEvent, abiEvent[]>, "event" | "events"> & {
      eventName?: event;
      eventNames?: event[];
  }
Returns Promise<GetLogsReturnType<abiEvent, abiEvent[]>>
Example
```
const logs = contract.getLogs({ eventName: 'EventName' })
const logs = contract.getLogs({ eventNames: ['EventName'] })

@public
@async
@template {ContractEvent} event
@template {ExtractAbiEvent<
      ContractAbi,
      event
    >} [abiEvent=ExtractAbiEvent<ContractAbi, event>]
@param {?Omit<
      GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,
      'event' | 'events'
    > & {
      eventName?: event;
      eventNames?: event[];
    }} [params]
@returns {Promise<GetLogsReturnType<abiEvent, abiEvent
```
Inherited from Deployable.getLogs
- Defined in packages/sdk/src/Deployable/Contract.ts:131

subscribe<event>(cb, params?): (() => void)
A typed wrapper for wagmi.watchContractEvent
Type Parameters
- event extends "Deployed" | "Registered"
Parameters
- cb: ((log: Log<bigint, number, false, Extract<{
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "baseImplementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }, {
          name: "deployedInstance";
          internalType: "contract ACloneable";
          type: "address";
          indexed: false;
      }];
      name: "Deployed";
  }, {
      name: event;
  }> | Extract<{
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "registryType";
          internalType: "enum ABoostRegistry.RegistryType";
          type: "uint8";
          indexed: true;
      }, {
          name: "identifier";
          internalType: "bytes32";
          type: "bytes32";
          indexed: true;
      }, {
          name: "implementation";
          internalType: "address";
          type: "address";
          indexed: false;
      }];
      name: "Registered";
  }, {
      name: event;
  }>, true>) => unknown)
  - - (log): unknown
    - Parameters
      log: Log<bigint, number, false, Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "registryType";
              internalType: "enum ABoostRegistry.RegistryType";
              type: "uint8";
              indexed: true;
          }, {
              name: "identifier";
              internalType: "bytes32";
              type: "bytes32";
              indexed: true;
          }, {
              name: "baseImplementation";
              internalType: "address";
              type: "address";
              indexed: false;
          }, {
              name: "deployedInstance";
              internalType: "contract ACloneable";
              type: "address";
              indexed: false;
          }];
          name: "Deployed";
      }, {
          name: event;
      }> | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "registryType";
              internalType: "enum ABoostRegistry.RegistryType";
              type: "uint8";
              indexed: true;
          }, {
              name: "identifier";
              internalType: "bytes32";
              type: "bytes32";
              indexed: true;
          }, {
              name: "implementation";
              internalType: "address";
              type: "address";
              indexed: false;
          }];
          name: "Registered";
      }, {
          name: event;
      }>, true>
      Returns unknown
- Optionalparams: Partial<Omit<UnionCompute<WatchContractEventParameters<readonly [{
      type: "error";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "AlreadyRegistered";
  }, {
      type: "error";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "NotACloneable";
  }, {
      type: "error";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "NotRegistered";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Reentrancy";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Deployed";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Registered";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "deployClone";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "getBaseImplementation";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "getClone";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          components: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "getCloneIdentifier";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "getClones";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "getIdentifier";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "register";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }], event, undefined, WebSocketTransport> & ChainIdParameter<Config, number> & SyncConnectedChainParameter>, "address" | "abi">> & {
      eventName?: event;
  }
Returns (() => void)
- - (): void
  - Returns void
Inherited from Deployable.subscribe
- Defined in packages/sdk/src/Deployable/Contract.ts:186

`Protected`optionallyAttachAccount

optionallyAttachAccount(account?): {
account: Account;
} | {
account: undefined;
}
Protected
Internal function to attach the connected account to write methods to avoid manually passing in an account each call.
Parameters
- Optionalaccount: Account
Returns {
account: Account;
} | {
account: undefined;
}
Inherited from Deployable.optionallyAttachAccount
- Defined in packages/sdk/src/Deployable/Deployable.ts:206

`Protected`validateDeploymentConfig

validateDeploymentConfig<P>(_payload?, _options?): [P, DeployableOptions]
Protected
Internal method used to ensure that a Wagmi configuration and payload are always present when deploying.
Type Parameters
- P = never[]
Parameters
- Optional_payload: P
- Optional_options: DeployableOptions
Returns [P, DeployableOptions]
Throws
DeployableWagmiConfigurationRequiredError

Throws
DeployableMissingPayloadError
Inherited from Deployable.validateDeploymentConfig
- Defined in packages/sdk/src/Deployable/Deployable.ts:238

`Protected`awaitResult

awaitResult<Result>(hashPromise, waitParams?): Promise<Result>
Protected
Type Parameters
- Result = unknown
Parameters
- hashPromise: Promise<HashAndSimulatedResult<Result>>
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
Returns Promise<Result>
See
awaitResult

Async
Inherited from Deployable.awaitResult
- Defined in packages/sdk/src/Deployable/Contract.ts:222

Class BoostRegistry

See

Export

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BoostRegistry

See

Properties

Static Readonlyaddresses

Static

Readonlyabi

Protected_payload

Protected_config

See

Protected_address

Protected Optional_account

Accessors

addresses

Returns Record<number, `0x${string}`>

payload

Returns undefined | Payload

address

Returns undefined | `0x${string}`

Methods

register

Parameters

Returns Promise<void>

Async

Example

registerRaw

Parameters

Returns Promise<{ hash: `0x${string}`; result: void; }>

See

Async

initialize

Type Parameters

Parameters

Returns Promise<Target>

Async

initializeRaw

Type Parameters

Parameters

Returns Promise<HashAndSimulatedResult<`0x${string}`> & { target: Target; }>

Async

clone

Type Parameters

Parameters

Returns Promise<Target>

Async

deployClone

Type Parameters

Parameters

Returns Promise<`0x${string}`>

See

Async

deployCloneRaw

Type Parameters

Parameters

Returns Promise<HashAndSimulatedResult<`0x${string}`>>

See

Async

getBaseImplementation

Parameters

Returns Promise<`0x${string}`>

Async

getClone

Parameters

Returns Promise<Clone>

Async

getClones

Parameters

Returns Promise<readonly `0x${string}`[]>

Async

`Static` `Readonly`addresses

`Readonly`abi

`Protected`_payload

`Protected`_config

`Protected`_address

`Protected` `Optional`_account

Returns Promise<{
hash: `0x${string}`;
result: void;
}>

Returns Promise<HashAndSimulatedResult<`0x${string}`> & {
target: Target;
}>

`Protected`optionallyAttachAccount

Returns {
account: Account;
} | {
account: undefined;
}

`Protected`validateDeploymentConfig

`Protected`awaitResult