Class BaseModule`Abstract`

Hierarchy

BaseModule

Index

Constructors

Properties

commands endpoint events method offchainStores stores

Accessors

Methods

afterCommandExecute? afterTransactionsExecute? baseMetadata beforeCommandExecute? beforeTransactionsExecute? finalizeGenesisState? init? initGenesisState? insertAssets? metadata verifyAssets? verifyTransaction?

Constructors

constructor

new BaseModule(): BaseModule
Returns BaseModule

Properties

commands

commands: BaseCommand<unknown>[] = []

`Abstract` endpoint

endpoint: BaseEndpoint

events

events: NamedRegistry = ...

`Abstract` method

method: BaseMethod

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

Accessors

name

get name(): string
Returns string
- Defined in framework/src/modules/base_module.ts:70

Methods

`Optional` afterCommandExecute

afterCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:83

`Optional` afterTransactionsExecute

afterTransactionsExecute(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:87

`Protected` baseMetadata

baseMetadata(): {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
Returns {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
- assets: never[]
- commands: {
  name: string;
  params: Schema;
  }[]
- endpoints: never[]
- events: {
  data: Schema;
  name: string;
  }[]
- stores: {
  data: Schema;
  key: string;
  }[]
- Defined in framework/src/modules/base_module.ts:91

`Optional` beforeCommandExecute

beforeCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:82

`Optional` beforeTransactionsExecute

beforeTransactionsExecute(context: BlockExecuteContext): Promise<void>
Parameters
- context: BlockExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:86

`Optional` finalizeGenesisState

finalizeGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:85

`Optional` init

init(args: ModuleInitArgs): Promise<void>
Parameters
- args: ModuleInitArgs
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:78

`Optional` initGenesisState

initGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:84

`Optional` insertAssets

insertAssets(context: InsertAssetContext): Promise<void>
Parameters
- context: InsertAssetContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:79

`Abstract` metadata

metadata(): ModuleMetadata
Returns ModuleMetadata
- Defined in framework/src/modules/base_module.ts:89

`Optional` verifyAssets

verifyAssets(context: BlockVerifyContext): Promise<void>
Parameters
- context: BlockVerifyContext
Returns Promise<void>
- Defined in framework/src/modules/base_module.ts:80

`Optional` verifyTransaction

verifyTransaction(context: TransactionVerifyContext): Promise<VerificationResult>
Parameters
- context: TransactionVerifyContext
Returns Promise<VerificationResult>
- Defined in framework/src/modules/base_module.ts:81

Generated using TypeDoc