@xyo-network/xl1-providers
v1.18.40
Published
XYO Layer One API
Keywords
Readme
@xyo-network/chain-viewers
XYO Layer One API
Reference
@xyo-network/chain-viewers
Classes
- SimpleNetworkStakeViewer
- SimpleStepRewardsByPositionViewer
- SimpleStepRewardsByStakerViewer
- SimpleStepRewardsByStepViewer
- SimpleStepRewardsViewer
Interfaces
- SimpleNetworkStakeViewerParams
- SimpleStepRewardsByPositionViewerParams
- SimpleStepRewardsByStakerViewerParams
- SimpleStepRewardsByStepViewerParams
- NodeStepRewardsViewerParams
classes
SimpleNetworkStakeViewer
Extends
AbstractCreatable<SimpleNetworkStakeViewerParams>
Implements
NetworkStakeViewer
Constructors
Constructor
new SimpleNetworkStakeViewer(key, params): SimpleNetworkStakeViewer;Parameters
key
unknown
params
Partial<TParams & RequiredCreatableParams>
Returns
SimpleNetworkStakeViewer
Inherited from
AbstractCreatable<SimpleNetworkStakeViewerParams>.constructorAccessors
context
Get Signature
get context(): StakedChainContextRead;Returns
StakedChainContextRead
rewardMultipliers
Get Signature
get rewardMultipliers(): XL1RangeMultipliers | undefined;Returns
XL1RangeMultipliers | undefined
stepRewards
Get Signature
get stepRewards(): NetworkStakeStepRewardsViewer;Returns
NetworkStakeStepRewardsViewer
Implementation of
NetworkStakeViewer.stepRewardsMethods
active()
active(blockNumber?): Promise<[bigint, number]>;Parameters
blockNumber?
number
Returns
Promise<[bigint, number]>
the active stake and the number of active validators [active, block]
Implementation of
NetworkStakeViewer.activecreateHandler()
createHandler(): Promise<void>;Returns
Promise<void>
Overrides
AbstractCreatable.createHandlerstartHandler()
protected startHandler(): Promise<void>;Returns
Promise<void>
Overrides
AbstractCreatable.startHandlerSimpleStepRewardsByPositionViewer
Extends
AbstractCreatable<SimpleStepRewardsByPositionViewerParams>
Implements
NetworkStakeStepRewardsByPositionViewer
Constructors
Constructor
new SimpleStepRewardsByPositionViewer(key, params): SimpleStepRewardsByPositionViewer;Parameters
key
unknown
params
Partial<TParams & RequiredCreatableParams>
Returns
SimpleStepRewardsByPositionViewer
Inherited from
AbstractCreatable<SimpleStepRewardsByPositionViewerParams>.constructorAccessors
context
Get Signature
get context(): StakedChainContextRead;Returns
StakedChainContextRead
rewardMultipliers
Get Signature
get rewardMultipliers(): XL1RangeMultipliers;Returns
XL1RangeMultipliers
Methods
bonus()
bonus(__namedParameters): Promise<Record<number, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByPositionViewerOptions = {}
Returns
Promise<Record<number, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByPositionViewer.bonusclaimed()
claimed(_options?): Promisable<Record<number, AttoXL1>>;Parameters
_options?
NetworkStakeStepRewardsByPositionViewerOptions
Returns
Promisable<Record<number, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByPositionViewer.claimedearned()
earned(__namedParameters): Promise<Record<number, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByPositionViewerOptions = {}
Returns
Promise<Record<number, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByPositionViewer.earnedtotal()
total(__namedParameters): Promise<Record<number, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByPositionViewerOptions = {}
Returns
Promise<Record<number, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByPositionViewer.totalunclaimed()
unclaimed(_options): Promisable<Record<number, AttoXL1>>;Parameters
_options
NetworkStakeStepRewardsByPositionViewerOptions = {}
Returns
Promisable<Record<number, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByPositionViewer.unclaimedcalculateRewards()
protected calculateRewards(__namedParameters, rewardMultipliers?): Promise<Record<number, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByPositionViewerOptions = {}
rewardMultipliers?
XL1RangeMultipliers
Returns
Promise<Record<number, AttoXL1>>
SimpleStepRewardsByStakerViewer
Extends
AbstractCreatable<SimpleStepRewardsByStakerViewerParams>
Implements
NetworkStakeStepRewardsByStakerViewer
Constructors
Constructor
new SimpleStepRewardsByStakerViewer(key, params): SimpleStepRewardsByStakerViewer;Parameters
key
unknown
params
Partial<TParams & RequiredCreatableParams>
Returns
SimpleStepRewardsByStakerViewer
Inherited from
AbstractCreatable<SimpleStepRewardsByStakerViewerParams>.constructorAccessors
context
Get Signature
get context(): StakedChainContextRead;Returns
StakedChainContextRead
rewardMultipliers
Get Signature
get rewardMultipliers(): XL1RangeMultipliers;Returns
XL1RangeMultipliers
stakedChainContext
Get Signature
get stakedChainContext(): StakedChainContextRead;Returns
StakedChainContextRead
Methods
bonus()
bonus(__namedParameters): Promise<Record<Address, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByStakerViewerOptions = {}
Returns
Promise<Record<Address, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStakerViewer.bonusclaimed()
claimed(_options?): Promisable<Record<Address, AttoXL1>>;Parameters
_options?
NetworkStakeStepRewardsByStakerViewerOptions
Returns
Promisable<Record<Address, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStakerViewer.claimedearned()
earned(options): Promise<Record<Address, AttoXL1>>;Parameters
options
NetworkStakeStepRewardsByStakerViewerOptions = {}
Returns
Promise<Record<Address, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStakerViewer.earnedtotal()
total(options): Promise<Record<Address, AttoXL1>>;Parameters
options
NetworkStakeStepRewardsByStakerViewerOptions = {}
Returns
Promise<Record<Address, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStakerViewer.totalunclaimed()
unclaimed(_options): Promisable<Record<Address, AttoXL1>>;Parameters
_options
NetworkStakeStepRewardsByStakerViewerOptions = {}
Returns
Promisable<Record<Address, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStakerViewer.unclaimedcalculateRewards()
protected calculateRewards(__namedParameters, rewardMultipliers?): Promise<Record<Address, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByStakerViewerOptions = {}
rewardMultipliers?
XL1RangeMultipliers
Returns
Promise<Record<Address, AttoXL1>>
SimpleStepRewardsByStepViewer
Extends
AbstractCreatable<SimpleStepRewardsByStepViewerParams>
Implements
NetworkStakeStepRewardsByStepViewer
Constructors
Constructor
new SimpleStepRewardsByStepViewer(key, params): SimpleStepRewardsByStepViewer;Parameters
key
unknown
params
Partial<TParams & RequiredCreatableParams>
Returns
SimpleStepRewardsByStepViewer
Inherited from
AbstractCreatable<SimpleStepRewardsByStepViewerParams>.constructorAccessors
context
Get Signature
get context(): StakedChainContextRead;Returns
StakedChainContextRead
rewardMultipliers
Get Signature
get rewardMultipliers(): XL1RangeMultipliers;Returns
XL1RangeMultipliers
Methods
bonus()
bonus(__namedParameters): Promise<Record<StepIdentityString, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByStepViewerOptions = {}
Returns
Promise<Record<StepIdentityString, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStepViewer.bonusclaimed()
claimed(_options?): Promisable<Record<StepIdentityString, AttoXL1>>;Parameters
_options?
NetworkStakeStepRewardsByStepViewerOptions
Returns
Promisable<Record<StepIdentityString, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStepViewer.claimedearned()
earned(__namedParameters): Promise<Record<StepIdentityString, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByStepViewerOptions = {}
Returns
Promise<Record<StepIdentityString, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStepViewer.earnedtotal()
total(__namedParameters): Promise<Record<StepIdentityString, AttoXL1>>;Parameters
__namedParameters
NetworkStakeStepRewardsByStepViewerOptions = {}
Returns
Promise<Record<StepIdentityString, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStepViewer.totalunclaimed()
unclaimed(_options): Promisable<Record<StepIdentityString, AttoXL1>>;Parameters
_options
NetworkStakeStepRewardsByStepViewerOptions = {}
Returns
Promisable<Record<StepIdentityString, AttoXL1>>
Implementation of
NetworkStakeStepRewardsByStepViewer.unclaimedSimpleStepRewardsViewer
Extends
AbstractCreatable<NodeStepRewardsViewerParams>
Implements
NetworkStakeStepRewardsViewer
Constructors
Constructor
new SimpleStepRewardsViewer(key, params): SimpleStepRewardsViewer;Parameters
key
unknown
params
Partial<TParams & RequiredCreatableParams>
Returns
SimpleStepRewardsViewer
Inherited from
AbstractCreatable<NodeStepRewardsViewerParams>.constructorAccessors
position
Get Signature
get position(): NetworkStakeStepRewardsByPositionViewer;Returns
NetworkStakeStepRewardsByPositionViewer
Implementation of
NetworkStakeStepRewardsViewer.positionstaker
Get Signature
get staker(): NetworkStakeStepRewardsByStakerViewer;Returns
NetworkStakeStepRewardsByStakerViewer
Implementation of
NetworkStakeStepRewardsViewer.stakerstep
Get Signature
get step(): NetworkStakeStepRewardsByStepViewer;Returns
NetworkStakeStepRewardsByStepViewer
Implementation of
NetworkStakeStepRewardsViewer.steptotal
Get Signature
get total(): NetworkStakeStepRewardsTotalViewer;Returns
NetworkStakeStepRewardsTotalViewer
Implementation of
NetworkStakeStepRewardsViewer.totalcontext
Get Signature
get protected context(): StakedChainContextRead;Returns
StakedChainContextRead
rewardMultipliers
Get Signature
get protected rewardMultipliers(): XL1RangeMultipliers | undefined;Returns
XL1RangeMultipliers | undefined
Methods
createHandler()
createHandler(): Promise<void>;Returns
Promise<void>
Overrides
AbstractCreatable.createHandlerstartHandler()
protected startHandler(): Promise<void>;Returns
Promise<void>
Overrides
AbstractCreatable.startHandlerinterfaces
NodeStepRewardsViewerParams
Extends
CreatableParams
Properties
context
context: StakedChainContextRead;rewardMultipliers?
optional rewardMultipliers: XL1RangeMultipliers;SimpleNetworkStakeViewerParams
Extends
CreatableParams
Properties
context
context: StakedChainContextRead;rewardMultipliers?
optional rewardMultipliers: XL1RangeMultipliers;SimpleStepRewardsByPositionViewerParams
Extends
CreatableParams
Properties
context
context: StakedChainContextRead;rewardMultipliers?
optional rewardMultipliers: XL1RangeMultipliers;SimpleStepRewardsByStakerViewerParams
Extends
CreatableParams
Properties
context
context: StakedChainContextRead;rewardMultipliers?
optional rewardMultipliers: XL1RangeMultipliers;SimpleStepRewardsByStepViewerParams
Extends
CreatableParams
Properties
context
context: StakedChainContextRead;rewardMultipliers?
optional rewardMultipliers: XL1RangeMultipliers;stakeEventsViewer
stakeEventsViewer: StakeEventsViewer;Maintainers
License
See the LICENSE file for license details

