Class Etherbase

Hierarchy

AccessControlEnumerable
- Etherbase

Index

Constructors

constructor

new Etherbase(params: IInitParams): Etherbase
Initialization of the Etherbase Contract This is a wrapper of the solidity smart contract
Parameters
- params: IInitParams
  
  The core parameters passed into the constructor
Returns Etherbase
Overrides AccessControlEnumerable.constructor
- Defined in ../../packages/etherbase/src/contract.ts:37

Properties

DEFAULT_ADMIN_ROLE

DEFAULT_ADMIN_ROLE: string

ETHER_MANAGER_ROLE

ETHER_MANAGER_ROLE: string = ...

contract

contract: Contract

`Protected` hasSigner

hasSigner: boolean

`Protected` signer

signer: Wallet

Methods

checkSigner

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

`Private` fullCheck

fullCheck(params: IFullCheck): Promise<void>
Private
Internal Async Function Check to see if input values are acceptable

Function
onlyEtherManagerCheck
Parameters
- params: IFullCheck
  
  Full Check Params Contains address check and amount chec
Returns Promise<void>
- Defined in ../../packages/etherbase/src/contract.ts:112

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

`Private` isEtherManager

isEtherManager(address: string): Promise<boolean>
Internal Function to check if address has ETHER_MANAGER_ROLE

Function
isEtherManager

Returns
Has Ether Manager Role
Parameters
- address: string
  
  Address to Check
Returns Promise<boolean>
- Defined in ../../packages/etherbase/src/contract.ts:127

`Private` onlyEtherManagerCheck

onlyEtherManagerCheck(): Promise<void>
Private
Internal Async Function check to see whether the signer has ETHER_MANAGER_ROLE

Function
onlyEtherManagerCheck

Returns Promise<void>
- Defined in ../../packages/etherbase/src/contract.ts:96

partiallyRetrieve

partiallyRetrieve(params: IPartiallyRetrieve): Promise<ContractReceipt>
Wrapper for Solidity Function partiallyRetreive. Allows requester to withdraw a specific amount of sFUEL to a specific address. Must have {ETHER_MANAGER_ROLE} to successfully call Optional: Can optionally callRunChecks to run contract requirements on the client

Function
partiallyRetreive

Returns
Transaction Information
Parameters
- params: IPartiallyRetrieve
  
  The retriever params
Returns Promise<ContractReceipt>
- Defined in ../../packages/etherbase/src/contract.ts:78

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

retrieve

retrieve(params: IRetrieve): Promise<ContractReceipt>
Wrapper for Solidity Function retrieve. Allows requester to withdraw all funds from Etherbase to a specific address Must have {ETHER_MANAGER_ROLE} to successfully call Optional: Can optionally callRunChecks to run contract requirements on the client

Function
retrieve

Returns
Transaction Information
Parameters
- params: IRetrieve
  
  The retriever params
Returns Promise<ContractReceipt>
- Defined in ../../packages/etherbase/src/contract.ts:59

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

Class Etherbase

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: IInitParams

Returns Etherbase

Properties

DEFAULT_ADMIN_ROLE

ETHER_MANAGER_ROLE

contract

Protected hasSigner

Protected signer

Methods

checkSigner

Returns void

Private fullCheck

Function

Parameters

params: IFullCheck

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>

grantRole

Function

Returns

Parameters

params: IRoleAccount

Returns Promise<any>

hasRole

Function

Returns

Async

Parameters

params: IRoleAccount

Returns Promise<any>

Private isEtherManager

Function

Returns

Parameters

address: string

Returns Promise<boolean>

Private onlyEtherManagerCheck

Function

Returns Promise<void>

partiallyRetrieve

Function

Returns

Parameters

params: IPartiallyRetrieve

Returns Promise<ContractReceipt>

renounceRole

Function

Returns

Parameters

`Protected` hasSigner

`Protected` signer

`Private` fullCheck

__namedParameters: {
nameOnly?: boolean;
}

`Optional` nameOnly?: boolean

`Private` isEtherManager

`Private` onlyEtherManagerCheck

__namedParameters: {
signer: Wallet;
}