Class RewardModule

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

Hierarchy

BaseModule
- RewardModule

Constructors

constructor

new RewardModule(): RewardModule
Returns RewardModule
Overrides BaseModule.constructor
- Defined in framework/src/modules/reward/module.ts:51

Properties

`Private` _moduleConfig

_moduleConfig: ModuleConfig

`Private` _randomMethod

_randomMethod: RandomMethod

`Private` _tokenMethod

_tokenMethod: TokenMethod

commands

commands: BaseCommand<unknown>[] = []

configSchema

configSchema: {
    $id: string;
    properties: {
        brackets: {
            items: {
                format: string;
                type: string;
            };
            type: string;
        };
        distance: {
            minimum: number;
            type: string;
        };
        offset: {
            minimum: number;
            type: string;
        };
        tokenID: {
            format: string;
            maxLength: number;
            minLength: number;
            type: string;
        };
    };
    required: string[];
    type: string;
} = configSchema

Type declaration

$id: string
properties: {
    brackets: {
        items: {
            format: string;
            type: string;
        };
        type: string;
    };
    distance: {
        minimum: number;
        type: string;
    };
    offset: {
        minimum: number;
        type: string;
    };
    tokenID: {
        format: string;
        maxLength: number;
        minLength: number;
        type: string;
    };
}
- brackets: {
      items: {
          format: string;
          type: string;
      };
      type: string;
  }
  - items: {
    format: string;
    type: string;
    }
    - format: string
    - type: string
  - type: string
- distance: {
  minimum: number;
  type: string;
  }
  - minimum: number
  - type: string
- offset: {
  minimum: number;
  type: string;
  }
  - minimum: number
  - type: string
- tokenID: {
      format: string;
      maxLength: number;
      minLength: number;
      type: string;
  }
  - format: string
  - maxLength: number
  - minLength: number
  - type: string
required: string[]
type: string

endpoint

endpoint: RewardEndpoint = ...

events

events: NamedRegistry = ...

method

method: RewardMethod = ...

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

addDependencies

addDependencies(tokenMethod: TokenMethod, randomMethod: RandomMethod): void
Parameters
- tokenMethod: TokenMethod
- randomMethod: RandomMethod
Returns void
- Defined in framework/src/modules/reward/module.ts:56

`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/reward/module.ts:115

`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

beforeTransactionsExecute

beforeTransactionsExecute(context: BlockExecuteContext): Promise<void>
Parameters
- context: BlockExecuteContext
Returns Promise<void>
Overrides BaseModule.beforeTransactionsExecute
- Defined in framework/src/modules/reward/module.ts:105

`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/reward/module.ts:85

`Optional` initGenesisState

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

`Optional` insertAssets

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

metadata

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

`Optional` verifyAssets

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

`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 RewardModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RewardModule

Properties

Private _moduleConfig

Private _randomMethod

Private _tokenMethod

commands

configSchema

Type declaration

$id: string

properties: { brackets: { items: { format: string; type: string; }; type: string; }; distance: { minimum: number; type: string; }; offset: { minimum: number; type: string; }; tokenID: { format: string; maxLength: number; minLength: number; type: string; }; }

brackets: { items: { format: string; type: string; }; type: string; }

items: { format: string; type: string; }

format: string

type: string

type: string

distance: { minimum: number; type: string; }

minimum: number

type: string

offset: { minimum: number; type: string; }

minimum: number

type: string

tokenID: { format: string; maxLength: number; minLength: number; type: string; }

format: string

maxLength: number

minLength: number

type: string

required: string[]

type: string

endpoint

events

method

offchainStores

stores

Accessors

name

Returns string

Methods

addDependencies

Parameters

tokenMethod: TokenMethod

randomMethod: RandomMethod

Returns void

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>

beforeTransactionsExecute

Parameters

context: BlockExecuteContext

Returns Promise<void>

Optional finalizeGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

init

Parameters

`Private` _moduleConfig

`Private` _randomMethod

`Private` _tokenMethod

properties: {
brackets: {
items: {
format: string;
type: string;
};
type: string;
};
distance: {
minimum: number;
type: string;
};
offset: {
minimum: number;
type: string;
};
tokenID: {
format: string;
maxLength: number;
minLength: number;
type: string;
};
}

brackets: {
items: {
format: string;
type: string;
};
type: string;
}

items: {
format: string;
type: string;
}

distance: {
minimum: number;
type: string;
}

offset: {
minimum: number;
type: string;
}

tokenID: {
format: string;
maxLength: number;
minLength: number;
type: string;
}

`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` finalizeGenesisState

`Optional` initGenesisState

`Optional` insertAssets

`Optional` verifyAssets

`Optional` verifyTransaction