Class GovHandler

Hierarchy

GovHandler

Implements

IGovHandler

Index

Constructors

constructor

Properties

qH walletRef

Constructors

`Private` constructor

new GovHandler(wallet): GovHandler
Private
Create a GovHandler instance.
Parameters
- wallet: IWalletHandler
  
  Instance of WalletHandler.
Returns GovHandler
- Defined in src/classes/govHandler.ts:32

Properties

`Private` `Readonly` qH

qH: IQueryHandler

`Private` `Readonly` walletRef

walletRef: IWalletHandler

Methods

claimDelegatorRewards

claimDelegatorRewards(validatorAddresses): Promise<void>
Claim user's staking rewards for target validator.
Parameters
- validatorAddresses: string[]
  
  Bech32 address of validator.
Returns Promise<void>
Implementation of IGovHandler.claimDelegatorRewards
- Defined in src/classes/govHandler.ts:420

delegateTokens

delegateTokens(validatorAddress, amount): Promise<void>
Delegates specified amount of tokens to target validator. Wraps rawDelegateTokens().
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
- amount: string | number
  
  Amount to delegate in ujkl.
Returns Promise<void>
Implementation of IGovHandler.delegateTokens
- Defined in src/classes/govHandler.ts:462

getAllCompletedPropDetailsMap

getAllCompletedPropDetailsMap(): Promise<IPropDetailsMap>
Query details of all governance proposals with a completed status as Map. Wraps getAllPropDetailsInStatus().

Returns Promise<IPropDetailsMap>
Implementation of IGovHandler.getAllCompletedPropDetailsMap
- Defined in src/classes/govHandler.ts:407

getAllDelegatorValidatorDetails

getAllDelegatorValidatorDetails(): Promise<IStakingValidator[]>
Query details for all validator details user is delegated to.

Returns Promise<IStakingValidator[]>
Implementation of IGovHandler.getAllDelegatorValidatorDetails
- Defined in src/classes/govHandler.ts:189

getAllDelegatorValidatorDetailsMap

getAllDelegatorValidatorDetailsMap(): Promise<IStakingValidatorMap>
Query details for all validator details user is delegated to as a Map. Wraps getAllDelegatorValidatorDetails().

Returns Promise<IStakingValidatorMap>
Implementation of IGovHandler.getAllDelegatorValidatorDetailsMap
- Defined in src/classes/govHandler.ts:205

getAllPropDetailsInStatus

getAllPropDetailsInStatus(status): Promise<IPropDetails[]>
Query details of all governance proposals with target status.
Parameters
- status: TPropStatus
  
  String matching 1 of the 7 TPropStatus statuses.
Returns Promise<IPropDetails[]>
Implementation of IGovHandler.getAllPropDetailsInStatus
- Defined in src/classes/govHandler.ts:378

getAllPropDetailsInStatusMap

getAllPropDetailsInStatusMap(status): Promise<IPropDetailsMap>
Query details of all governance proposals with target status as Map. Wraps getAllPropDetailsInStatus().
Parameters
- status: TPropStatus
  
  String matching 1 of the 7 TPropStatus statuses.
Returns Promise<IPropDetailsMap>
Implementation of IGovHandler.getAllPropDetailsInStatusMap
- Defined in src/classes/govHandler.ts:393

getAllValidatorDetails

getAllValidatorDetails(status): Promise<IStakingValidator[]>
Query details for all validators with target status.
Parameters
- status: TValidatorStatus
  
  String matching 1 of the 4 TValidatorStatus statuses.
Returns Promise<IStakingValidator[]>
Implementation of IGovHandler.getAllValidatorDetails
- Defined in src/classes/govHandler.ts:238

getAllValidatorDetailsMap

getAllValidatorDetailsMap(status): Promise<IStakingValidatorMap>
Query details for all validators with target status as Map. Wraps getAllValidatorDetails().
Parameters
- status: TValidatorStatus
  
  String matching 1 of the 4 TValidatorStatus statuses.
Returns Promise<IStakingValidatorMap>
Implementation of IGovHandler.getAllValidatorDetailsMap
- Defined in src/classes/govHandler.ts:253

getCompleteMergedValidatorDetailsMap

getCompleteMergedValidatorDetailsMap(): Promise<IStakingValidatorExtendedMap>
Query details including staking details for all validators as Map. Wraps getAllDelegatorValidatorDetailsMap() and getAllValidatorDetailsMap().

Returns Promise<IStakingValidatorExtendedMap>
Implementation of IGovHandler.getCompleteMergedValidatorDetailsMap
- Defined in src/classes/govHandler.ts:324

getCondensedRewards

getCondensedRewards(validatorAddress): Promise<number>
Query total rewards for all delegators on target validator.
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
Returns Promise<number>
Implementation of IGovHandler.getCondensedRewards
- Defined in src/classes/govHandler.ts:98

getCondensedTotalRewards

getCondensedTotalRewards(): Promise<number>
Query total rewards for all delegators on all validators.

Returns Promise<number>
Implementation of IGovHandler.getCondensedTotalRewards
- Defined in src/classes/govHandler.ts:64

getDelegatorValidatorDetails

getDelegatorValidatorDetails(validatorAddress): Promise<IStakingValidator>
Query details of target validator user is delegated to.
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
Returns Promise<IStakingValidator>
Implementation of IGovHandler.getDelegatorValidatorDetails
- Defined in src/classes/govHandler.ts:165

getInactiveMergedValidatorDetailsMap

getInactiveMergedValidatorDetailsMap(): Promise<IStakingValidatorExtendedMap>
Query details for all validators with user delegation and all validators with an inactive status as Map. Wraps getAllDelegatorValidatorDetailsMap() and getAllValidatorDetailsMap().

Returns Promise<IStakingValidatorExtendedMap>
Implementation of IGovHandler.getInactiveMergedValidatorDetailsMap
- Defined in src/classes/govHandler.ts:311

getInactiveMergedValidatorDetailsStakedMap

getInactiveMergedValidatorDetailsStakedMap(): Promise<IStakingValidatorExtendedMap>
Query details including staking details for all validators with user delegation and all validators with an inactive status as Map. Wraps getAllDelegatorValidatorDetailsMap() and getInactiveMergedValidatorDetailsMap().

Returns Promise<IStakingValidatorExtendedMap>
Implementation of IGovHandler.getInactiveMergedValidatorDetailsStakedMap
- Defined in src/classes/govHandler.ts:298

getMergedValidatorDetailsMap

getMergedValidatorDetailsMap(status): Promise<IStakingValidatorExtendedMap>
Query details for all validators with user delegation and all validators with target status as Map. Wraps getAllDelegatorValidatorDetailsMap() and getAllValidatorDetailsMap().
Parameters
- status: TValidatorStatus
  
  String matching 1 of the 4 TValidatorStatus statuses.
Returns Promise<IStakingValidatorExtendedMap>
Implementation of IGovHandler.getMergedValidatorDetailsMap
- Defined in src/classes/govHandler.ts:269

getMergedValidatorDetailsStakedMap

getMergedValidatorDetailsStakedMap(status): Promise<IStakingValidatorStakedMap>
Query details including staking details for all validators with user delegation and all validators with target status as Map. Wraps getAllDelegatorValidatorDetailsMap() and getAllValidatorDetailsMap().
Parameters
- status: TValidatorStatus
  
  String matching 1 of the 4 TValidatorStatus statuses.
Returns Promise<IStakingValidatorStakedMap>
Implementation of IGovHandler.getMergedValidatorDetailsStakedMap
- Defined in src/classes/govHandler.ts:283

getPropDetails

getPropDetails(proposalId): Promise<IPropDetails>
Query details of target governance proposal.
Parameters
- proposalId: number
  
  Index of proposal.
Returns Promise<IPropDetails>
Implementation of IGovHandler.getPropDetails
- Defined in src/classes/govHandler.ts:366

getPublicInactiveMergedValidatorDetailsStakedMap

getPublicInactiveMergedValidatorDetailsStakedMap(): Promise<IStakingValidatorExtendedMap>
Query details including public staking details for all inactive status validators as Map. Wraps getAllValidatorDetailsMap().

Returns Promise<IStakingValidatorExtendedMap>
Implementation of IGovHandler.getPublicInactiveMergedValidatorDetailsStakedMap
- Defined in src/classes/govHandler.ts:353

getPublicMergedValidatorDetailsMap

getPublicMergedValidatorDetailsMap(status): Promise<IStakingValidatorStakedMap>
Query details including public staking details for all validators as Map. Wraps getAllValidatorDetailsMap().
Parameters
- status: TValidatorStatus
  
  String matching 1 of the 4 TValidatorStatus statuses.
Returns Promise<IStakingValidatorStakedMap>
Implementation of IGovHandler.getPublicMergedValidatorDetailsMap
- Defined in src/classes/govHandler.ts:342

getRewards

getRewards(validatorAddress): Promise<ICoin[]>
Query all individual rewards for all delegators on target validator.
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
Returns Promise<ICoin[]>
Implementation of IGovHandler.getRewards
- Defined in src/classes/govHandler.ts:83

getStakedMap

getStakedMap(): Promise<IDelegationSummaryMap>
Query $JKL staked for target delegator on all validators as map of validator Bech32 addresses.

Returns Promise<IDelegationSummaryMap>
Implementation of IGovHandler.getStakedMap
- Defined in src/classes/govHandler.ts:133

getStakedValidatorDetailsMap

getStakedValidatorDetailsMap(): Promise<IStakingValidatorStakedMap>
Query details for only validators user delegates to and amount delegated.

Returns Promise<IStakingValidatorStakedMap>
Implementation of IGovHandler.getStakedValidatorDetailsMap
- Defined in src/classes/govHandler.ts:154

getTotalRewards

getTotalRewards(): Promise<IDelegationRewards>
Query all individual rewards for all delegators on all validators.

Returns Promise<IDelegationRewards>
Implementation of IGovHandler.getTotalRewards
- Defined in src/classes/govHandler.ts:51

getTotalStaked

getTotalStaked(): Promise<number>
Query total $JKL staked for target delegator on all validators.

Returns Promise<number>
Implementation of IGovHandler.getTotalStaked
- Defined in src/classes/govHandler.ts:115

getValidatorDetails

getValidatorDetails(validatorAddress): Promise<IStakingValidator>
Query details of target validator.
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
Returns Promise<IStakingValidator>
Implementation of IGovHandler.getValidatorDetails
- Defined in src/classes/govHandler.ts:218

rawDelegateTokens

rawDelegateTokens(validatorAddress, amount): EncodeObject
Creates and returns Staking EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
- amount: string | number
  
  Amount to delegate in ujkl.
Returns EncodeObject
Implementation of IGovHandler.rawDelegateTokens
- Defined in src/classes/govHandler.ts:439

rawRedelegateTokens

rawRedelegateTokens(fromAddress, toAddress, amount): EncodeObject
Creates and returns Staking EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- fromAddress: string
  
  Bech32 address of source validator.
- toAddress: string
  
  Bech32 address of receiving validator.
- amount: string | number
  
  Amount to undelegate in ujkl.
Returns EncodeObject
Implementation of IGovHandler.rawRedelegateTokens
- Defined in src/classes/govHandler.ts:520

rawUndelegateTokens

rawUndelegateTokens(validatorAddress, amount): EncodeObject
Creates and returns Staking EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
- amount: string | number
  
  Amount to undelegate in ujkl.
Returns EncodeObject
Implementation of IGovHandler.rawUndelegateTokens
- Defined in src/classes/govHandler.ts:479

redelegateTokens

redelegateTokens(fromAddress, toAddress, amount): Promise<void>
Redelegates specified amount of tokens between target validators. Wraps rawRedelegateTokens().
Parameters
- fromAddress: string
  
  Bech32 address of source validator.
- toAddress: string
  
  Bech32 address of receiving validator.
- amount: string | number
  
  Amount to undelegate in ujkl.
Returns Promise<void>
Implementation of IGovHandler.redelegateTokens
- Defined in src/classes/govHandler.ts:546

undelegateTokens

undelegateTokens(validatorAddress, amount): Promise<void>
Undelegates specified amount of tokens from target validator. Wraps rawUndelegateTokens().
Parameters
- validatorAddress: string
  
  Bech32 address of validator.
- amount: string | number
  
  Amount to undelegate in ujkl.
Returns Promise<void>
Implementation of IGovHandler.undelegateTokens
- Defined in src/classes/govHandler.ts:502

`Static` trackGov

trackGov(wallet): Promise<IGovHandler>
Async wrapper to create a GovHandler instance.
Parameters
- wallet: IWalletHandler
  
  Instance of WalletHandler.
Returns Promise<IGovHandler>
- Instance of GovHandler.
- Defined in src/classes/govHandler.ts:42

Class GovHandler

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

wallet: IWalletHandler

Returns GovHandler

Properties

Private Readonly qH

Private Readonly walletRef

Methods

claimDelegatorRewards

Parameters

validatorAddresses: string[]

Returns Promise<void>

delegateTokens

Parameters

validatorAddress: string

amount: string | number

Returns Promise<void>

getAllCompletedPropDetailsMap

Returns Promise<IPropDetailsMap>

getAllDelegatorValidatorDetails

Returns Promise<IStakingValidator[]>

getAllDelegatorValidatorDetailsMap

Returns Promise<IStakingValidatorMap>

getAllPropDetailsInStatus

Parameters

status: TPropStatus

Returns Promise<IPropDetails[]>

getAllPropDetailsInStatusMap

Parameters

status: TPropStatus

Returns Promise<IPropDetailsMap>

getAllValidatorDetails

Parameters

status: TValidatorStatus

Returns Promise<IStakingValidator[]>

getAllValidatorDetailsMap

Parameters

status: TValidatorStatus

Returns Promise<IStakingValidatorMap>

getCompleteMergedValidatorDetailsMap

Returns Promise<IStakingValidatorExtendedMap>

getCondensedRewards

Parameters

validatorAddress: string

Returns Promise<number>

getCondensedTotalRewards

Returns Promise<number>

getDelegatorValidatorDetails

Parameters

validatorAddress: string

Returns Promise<IStakingValidator>

getInactiveMergedValidatorDetailsMap

Returns Promise<IStakingValidatorExtendedMap>

getInactiveMergedValidatorDetailsStakedMap

Returns Promise<IStakingValidatorExtendedMap>

getMergedValidatorDetailsMap

Parameters

status: TValidatorStatus

Returns Promise<IStakingValidatorExtendedMap>

getMergedValidatorDetailsStakedMap

Parameters

status: TValidatorStatus

Returns Promise<IStakingValidatorStakedMap>

getPropDetails

Parameters

proposalId: number

Returns Promise<IPropDetails>

getPublicInactiveMergedValidatorDetailsStakedMap

Returns Promise<IStakingValidatorExtendedMap>

getPublicMergedValidatorDetailsMap

Parameters

status: TValidatorStatus

`Private` constructor

`Private` `Readonly` qH

`Private` `Readonly` walletRef

`Static` trackGov