Class ConfigController

Hierarchy

AccessControlEnumerable
- ConfigController

Constructors

constructor

new ConfigController(params: IInitParams): ConfigController
Parameters
- params: IInitParams
  
  The core contract params for client interaction Wrapper of the ConfigController Solidity Contract
Returns ConfigController
Overrides AccessControlEnumerable.constructor
- Defined in ../../packages/config-controller/src/contract.ts:39

Properties

DEFAULT_ADMIN_ROLE

DEFAULT_ADMIN_ROLE: string

DEPLOYER_ADMIN_ROLE

DEPLOYER_ADMIN_ROLE: string = ...

DEPLOYER_ROLE

DEPLOYER_ROLE: string = ...

MTM_ADMIN_ROLE

MTM_ADMIN_ROLE: string = ...

contract

contract: Contract

`Protected` hasSigner

hasSigner: boolean

`Protected` signer

signer: Wallet

Methods

addToWhitelist

addToWhitelist(params: IWhitelist): Promise<ContractReceipt>
Parameters
- params: IWhitelist
  
  IWhitelist contains the address to whitelist and the checkParams flag
  
  Wrapper for Solidity Function addToWhitelist. Utilizes grantRole under the hood Must have DEPLOYER_ADMIN_ROLE to successfully call Optional: Can optionally call runChecks to run contract requirements on the client
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:56

checkSigner

checkSigner(): void
Returns void
Inherited from AccessControlEnumerable.checkSigner
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:22

disableFreeContractDeployment

disableFreeContractDeployment(params?: IDefault): Promise<ContractReceipt>
Wrapper for Solidity Function enableFreeContractDeployment

Function
disableFreeContractDeployment

Returns
Transaction Information
Parameters
- Optional params: IDefault
  
  Optional Params. If Params are set with runChecks it will run client checks to confirm proper roles are owned by the user and that fcd is currently enabled
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:221

disableMTM

disableMTM(params?: IDefault): Promise<ContractReceipt>
Wrapper for Solidity Function disableMTM

Function
disableMTM

Returns
Transaction Information
Parameters
- Optional params: IDefault
  
  Optional Params. If Params are set with runChecks it will run client checks to confirm proper roles are owned by the user and that mtm is currently enabled
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:173

enableFreeContractDeployment

enableFreeContractDeployment(params?: IDefault): Promise<ContractReceipt>
Wrapper for Solidity Function enableFreeContractDeployment

Function
enableFreeContractDeployment

Returns
Transaction Information
Parameters
- Optional params: IDefault
  
  Optional Params. If Params are set with runChecks it will run client checks to confirm proper roles are owned by the user and that fcd is currently disabled
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:197

enableMTM

enableMTM(params?: IDefault): Promise<ContractReceipt>
Wrapper for Solidity Function enableMTM

Function
enableMTM

Returns
Transaction Information
Parameters
- Optional params: IDefault
  
  Optional Params. If Params are set with runChecks it will run client checks to confirm proper roles are owned by the user and that mtm is currently disabled
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:150

`Private` fcdChecks

fcdChecks(isEnable: {
isEnable: boolean;
}): Promise<void>
Private
Internal Function Utilized to Run Pre FCD Flip Checks

Function
fcdChecks

Returns
This function does not return anything
Parameters
- isEnable: {
  isEnable: boolean;
  }
  
  Whether Callers Plans to Enable (True) or Disable(False) Free Contract Deployment
  - isEnable: boolean
Returns Promise<void>
- Defined in ../../packages/config-controller/src/contract.ts:293

getEventNames

getEventNames(__namedParameters: {
nameOnly?: boolean;
}): string[]
Parameters
- __namedParameters: {
  nameOnly?: boolean;
  }
  - Optional nameOnly?: boolean
Returns string[]
Inherited from AccessControlEnumerable.getEventNames
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:24

getRoleAdmin

getRoleAdmin(role: IRole): Promise<any>
Function
getRoleAdmin

Returns
string
Parameters
- role: IRole
Returns Promise<any>
Inherited from AccessControlEnumerable.getRoleAdmin
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:17

getRoleMember

getRoleMember(params: IGetRoleMember): Promise<any>
Function
getRoleMember

Returns
address
Parameters
- params: IGetRoleMember
Returns Promise<any>
Inherited from AccessControlEnumerable.getRoleMember
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control_enumerable.d.ts:16

getRoleMemberCount

getRoleMemberCount(role: IRole): Promise<any>
Function
getRoleMemberCount

Returns
BigNumber
Parameters
- role: IRole
Returns Promise<any>
Inherited from AccessControlEnumerable.getRoleMemberCount
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control_enumerable.d.ts:23

grantRole

grantRole(params: IRoleAccount): Promise<any>
Function
grantRole

Returns
string
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.grantRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:24

hasRole

hasRole(params: IRoleAccount): Promise<any>
Function
hasRole

Returns
string

Async
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.hasRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:32

isAddressWhitelisted

isAddressWhitelisted(address: {
address: string;
}): Promise<boolean>
Wrapper for Solidity Function isAddressWhitelisted If Address is Contract -> True If Whitelisted -> True Else -> False

Function
isAddressWhitelisted

Returns
If Address is whitelisted
Parameters
- address: {
  address: string;
  }
  
  The Address to Check
  - address: string
Returns Promise<boolean>
- Defined in ../../packages/config-controller/src/contract.ts:118

isFCDEnabled

isFCDEnabled(): Promise<boolean>
Wrapper for Solidity Function isFCDEnabled

Function
isFCDEnabled

Returns
Whether Free Contract Deployment is Enabled

Returns Promise<boolean>
- Defined in ../../packages/config-controller/src/contract.ts:100

isMTMEnabled

isMTMEnabled(): Promise<boolean>
Wrapper for Solidity Function isMTMEnabled

Function
isMTMEnabled

Returns
Whether Multi-Transaction Mode is Enabled

Returns Promise<boolean>
- Defined in ../../packages/config-controller/src/contract.ts:133

`Private` mtmChecks

mtmChecks(isEnable: {
isEnable: boolean;
}): Promise<void>
Private
Internal Function Utilized to Run Pre MTM Flip Checks

Function
mtmChecks

Returns
This function does not return anything
Parameters
- isEnable: {
  isEnable: boolean;
  }
  
  Whether Callers Plans to Enable (True) or Disable(False) MTM Mode
  - isEnable: boolean
Returns Promise<void>
- Defined in ../../packages/config-controller/src/contract.ts:271

removeFromWhitelist

removeFromWhitelist(params: IWhitelist): Promise<ContractReceipt>
Wrapper for Solidity Function removeFromWhitelist. Utilizes grantRole under the hood Must have {DEPLOYER_ADMIN_ROLE} to successfully call Optional: Can optionally call runChecks to run contract requirements on the client

Function
removeFromWhitelist

Returns
Transaction Information
Parameters
- params: IWhitelist
  
  IWhitelist contains the address to whitelist and the checkParams flag
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:80

renounceRole

renounceRole(params: IRoleAccount): Promise<any>
Function
renounceRole

Returns
string
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.renounceRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:46

revokeRole

revokeRole(params: IRoleAccount): Promise<any>
Function
revokeRole

Returns
string
Parameters
- params: IRoleAccount
Returns Promise<any>
Inherited from AccessControlEnumerable.revokeRole
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/access_control.d.ts:39

setSigner

setSigner(__namedParameters: {
signer: Wallet;
}): void
Parameters
- __namedParameters: {
  signer: Wallet;
  }
  - signer: Wallet
Returns void
Inherited from AccessControlEnumerable.setSigner
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:27

setVersion

setVersion(params: IVersion): Promise<ContractReceipt>
Wrapper for Solidity Function setVersion

Function
setVersion

Returns
Transaction Information
Parameters
- params: IVersion
  
  Core Params
Returns Promise<ContractReceipt>
- Defined in ../../packages/config-controller/src/contract.ts:244

Class ConfigController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: IInitParams

Returns ConfigController

Properties

DEFAULT_ADMIN_ROLE

DEPLOYER_ADMIN_ROLE

DEPLOYER_ROLE

MTM_ADMIN_ROLE

contract

Protected hasSigner

Protected signer

Methods

addToWhitelist

Parameters

params: IWhitelist

Returns Promise<ContractReceipt>

checkSigner

Returns void

disableFreeContractDeployment

Function

Returns

Parameters

Optional params: IDefault

Returns Promise<ContractReceipt>

disableMTM

Function

Returns

Parameters

Optional params: IDefault

Returns Promise<ContractReceipt>

enableFreeContractDeployment

Function

Returns

Parameters

Optional params: IDefault

Returns Promise<ContractReceipt>

enableMTM

Function

Returns

Parameters

Optional params: IDefault

Returns Promise<ContractReceipt>

Private fcdChecks

Function

Returns

Parameters

isEnable: { isEnable: boolean; }

isEnable: boolean

Returns Promise<void>

getEventNames

Parameters

__namedParameters: { nameOnly?: boolean; }

Optional nameOnly?: boolean

Returns string[]

getRoleAdmin

Function

Returns

Parameters

role: IRole

Returns Promise<any>

getRoleMember

Function

Returns

Parameters

params: IGetRoleMember

Returns Promise<any>

getRoleMemberCount

Function

Returns

Parameters

role: IRole

Returns Promise<any>

`Protected` hasSigner

`Protected` signer

`Optional` params: IDefault

`Optional` params: IDefault

`Optional` params: IDefault

`Optional` params: IDefault

`Private` fcdChecks

isEnable: {
isEnable: boolean;
}

__namedParameters: {
nameOnly?: boolean;
}

`Optional` nameOnly?: boolean

address: {
address: string;
}

`Private` mtmChecks

isEnable: {
isEnable: boolean;
}

__namedParameters: {
signer: Wallet;
}