Module SDK
Build
Modules

Modules

The Module SDK come prebuilt with a set of modules that can be installed on an account. These modules are designed to extend the functionality of an account and can be used to add custom logic to the account. Currently, the Module SDK supports the following modules:

Usage

All modules will export a set of functions and (usually) constants. Every module has a function called get... where ... is the name of the module. This function will return the module object that can be used to interact with the module, using the account functions.

For example, the Ownable Validator module has a function called getOwnableValidator that returns the module object.

import { getOwnableValidator, installModule } from "@rhinestone/module-sdk";
 
const ownableValidator = getOwnableValidator({
  ownerAddress,
});
 
const installModuleExecutions = await installModule({
  client,
  account,
  module: ownableValidator,
});

Modules will also have a set of constants that can be used for more advanced usage. For example, the Ownable Validator module has a constant called OWNABLE_VALIDATOR_ADDRESS that represents the module address.

import { OWNABLE_VALIDATOR_ADDRESS } from "@rhinestone/module-sdk";