Class RandomModule

The BaseModule represents Lisk modules by providing a generic interface, from which each module extends from.

Hierarchy

BaseModule
- RandomModule

Index

Constructors

constructor

new RandomModule(): RandomModule
Returns RandomModule
Overrides BaseModule.constructor
- Defined in framework/src/modules/random/module.ts:53

Properties

`Private` _maxLengthReveals

_maxLengthReveals: number

commands

commands: BaseCommand<unknown>[] = []

endpoint

endpoint: RandomEndpoint = ...

events

events: NamedRegistry = ...

method

method: RandomMethod = ...

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

Accessors

name

get name(): string
Returns string
Inherited from BaseModule.name
- Defined in framework/src/modules/base_module.ts:73

Methods

`Private` _getHashOnion

_getHashOnion(context: InsertAssetContext, address: Buffer): Promise<undefined | HashOnion>
Parameters
- context: InsertAssetContext
- address: Buffer
Returns Promise<undefined | HashOnion>
- Defined in framework/src/modules/random/module.ts:268

`Private` _getNextHashOnion

_getNextHashOnion(usedHashOnions: UsedHashOnion[], address: Buffer, height: number, logger: Logger, context: InsertAssetContext): Promise<{
count: number;
hash: Buffer;
}>
Parameters
- usedHashOnions: UsedHashOnion[]
- address: Buffer
- height: number
- logger: Logger
- context: InsertAssetContext
Returns Promise<{
count: number;
hash: Buffer;
}>
- Defined in framework/src/modules/random/module.ts:198

`Optional` afterCommandExecute

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

afterTransactionsExecute

afterTransactionsExecute(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
Overrides BaseModule.afterTransactionsExecute
- Defined in framework/src/modules/random/module.ts:168

`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;
  }[]
Inherited from BaseModule.baseMetadata
- Defined in framework/src/modules/base_module.ts:94

`Optional` beforeCommandExecute

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

`Optional` beforeTransactionsExecute

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

`Optional` finalizeGenesisState

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

init

init(args: ModuleInitArgs): Promise<void>
Parameters
- args: ModuleInitArgs
Returns Promise<void>
Overrides BaseModule.init
- Defined in framework/src/modules/random/module.ts:98

initGenesisState

initGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
Overrides BaseModule.initGenesisState
- Defined in framework/src/modules/random/module.ts:163

insertAssets

insertAssets(context: InsertAssetContext): Promise<void>
Parameters
- context: InsertAssetContext
Returns Promise<void>
Overrides BaseModule.insertAssets
- Defined in framework/src/modules/random/module.ts:106

metadata

metadata(): ModuleMetadata
Returns ModuleMetadata
Overrides BaseModule.metadata
- Defined in framework/src/modules/random/module.ts:60

verifyAssets

verifyAssets(context: BlockVerifyContext): Promise<void>
Parameters
- context: BlockVerifyContext
Returns Promise<void>
Overrides BaseModule.verifyAssets
- Defined in framework/src/modules/random/module.ts:151

`Optional` verifyTransaction

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

Class RandomModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RandomModule

Properties

Private _maxLengthReveals

commands

endpoint

events

method

offchainStores

stores

Accessors

name

Returns string

Methods

Private _getHashOnion

Parameters

context: InsertAssetContext

address: Buffer

Returns Promise<undefined | HashOnion>

Private _getNextHashOnion

Parameters

usedHashOnions: UsedHashOnion[]

address: Buffer

height: number

logger: Logger

context: InsertAssetContext

Returns Promise<{ count: number; hash: Buffer; }>

Optional afterCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

afterTransactionsExecute

Parameters

context: BlockAfterExecuteContext

Returns Promise<void>

Protected baseMetadata

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; }[]

Optional beforeCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

Optional beforeTransactionsExecute

Parameters

context: BlockExecuteContext

Returns Promise<void>

Optional finalizeGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

init

Parameters

args: ModuleInitArgs

Returns Promise<void>

initGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

insertAssets

Parameters

context: InsertAssetContext

Returns Promise<void>

metadata

Returns ModuleMetadata

verifyAssets

Parameters

context: BlockVerifyContext

Returns Promise<void>

`Private` _maxLengthReveals

`Private` _getHashOnion

`Private` _getNextHashOnion

Returns Promise<{
count: number;
hash: Buffer;
}>

`Optional` afterCommandExecute

`Protected` baseMetadata

Returns {
assets: never[];
commands: {
name: string;
params: Schema;
}[];
endpoints: never[];
events: {
data: Schema;
name: string;
}[];
stores: {
data: Schema;
key: string;
}[];
}

commands: {
name: string;
params: Schema;
}[]

events: {
data: Schema;
name: string;
}[]

stores: {
data: Schema;
key: string;
}[]

`Optional` beforeCommandExecute

`Optional` beforeTransactionsExecute

`Optional` finalizeGenesisState

`Optional` verifyTransaction