Class AuthModule

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

Hierarchy

BaseModule
- AuthModule

Constructors

constructor

new AuthModule(): AuthModule
Returns AuthModule
Overrides BaseModule.constructor
- Defined in framework/src/modules/auth/module.ts:62

Properties

`Private` _moduleConfig

_moduleConfig: {
maxNumberOfSignatures: number;
}

Type declaration

maxNumberOfSignatures: number

`Private` `Readonly` _registerMultisignatureCommand

_registerMultisignatureCommand: RegisterMultisignatureCommand = ...

commands

commands: RegisterMultisignatureCommand[] = ...

configSchema

configSchema: {
    $id: string;
    properties: {
        maxNumberOfSignatures: {
            format: string;
            type: string;
        };
    };
    type: string;
} = configSchema

Type declaration

$id: string
properties: {
    maxNumberOfSignatures: {
        format: string;
        type: string;
    };
}
- maxNumberOfSignatures: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
type: string

endpoint

endpoint: AuthEndpoint = ...

events

events: NamedRegistry = ...

method

method: AuthMethod = ...

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

`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

`Optional` afterTransactionsExecute

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

`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

beforeCommandExecute

beforeCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Overrides BaseModule.beforeCommandExecute
- Defined in framework/src/modules/auth/module.ts:217

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

initGenesisState

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

`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/auth/module.ts:72

`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

verifyTransaction

verifyTransaction(context: TransactionVerifyContext): Promise<VerificationResult>
Parameters
- context: TransactionVerifyContext
Returns Promise<VerificationResult>
Overrides BaseModule.verifyTransaction
- Defined in framework/src/modules/auth/module.ts:196

Class AuthModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AuthModule

Properties

Private _moduleConfig

Type declaration

maxNumberOfSignatures: number

Private Readonly _registerMultisignatureCommand

commands

configSchema

Type declaration

$id: string

properties: { maxNumberOfSignatures: { format: string; type: string; }; }

maxNumberOfSignatures: { format: string; type: string; }

format: string

type: string

type: string

endpoint

events

method

offchainStores

stores

Accessors

name

Returns string

Methods

Optional afterCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

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

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>

Optional insertAssets

Parameters

context: InsertAssetContext

Returns Promise<void>

metadata

Returns ModuleMetadata

Optional verifyAssets

Parameters

context: BlockVerifyContext

Returns Promise<void>

verifyTransaction

Parameters

`Private` _moduleConfig

`Private` `Readonly` _registerMultisignatureCommand

properties: {
maxNumberOfSignatures: {
format: string;
type: string;
};
}

maxNumberOfSignatures: {
format: string;
type: string;
}

`Optional` afterCommandExecute

`Optional` afterTransactionsExecute

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

`Optional` finalizeGenesisState

`Optional` insertAssets

`Optional` verifyAssets