Class PierTwoStakingApi

Title

Pier Two Staking API

Version

1.0.57-mainnet

Base Url

https://gw-1.api.piertwo.io

Contact

The Pier Two Staking API Docs

Hierarchy (view full)

Api<null>
- PierTwoStakingApi

Index

Constructors

constructor

new PierTwoStakingApi(args): PierTwoStakingApi
Parameters
- args: ApiConfig<null> & {
  apiKey?: string;
  jwt?: string;
  }
Returns PierTwoStakingApi
Overrides Api.constructor
- Defined in src/PierTwoStakingApi.ts:52

Properties

account

account: {
    addNewApiKey: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: GetApiKeyDto;
    }>);
    getAccount: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: GetAccountResponse;
    }>);
    getApiKeys: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: GetApiKeyDto[];
    }>);
    revokeApiKey: ((key, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: GetApiKeyDto;
    }>);
} = ...

Type declaration

addNewApiKey: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto;
}>)
Description
Add a new api key for your account with a specified name.

Tags
Account

Name
AddNewApiKey

Summary
Create a new API key

Request
POST:/account/apikeys
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetApiKeyDto;
    }>
  - Parameters
    - data: CreateApiKeyDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetApiKeyDto;
    }>
getAccount: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetAccountResponse;
}>)
Description
Returns basic account details such as name, email address, KYC status, etc.

Tags
Account

Name
GetAccount

Summary
Get basic account details

Request
GET:/account
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetAccountResponse;
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetAccountResponse;
    }>
getApiKeys: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto[];
}>)
Description
Returns all api keys for your account, optionally including revoked keys.

Tags
Account

Name
GetApiKeys

Summary
Get API keys

Request
GET:/account/apikeys
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetApiKeyDto[];
    }>
  - Parameters
    - Optional query: {
      includeRevokedKeys?: string;
      }
      Optional includeRevokedKeys?: string
      Anything except 'true' will be considered false.
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetApiKeyDto[];
    }>
revokeApiKey: ((key, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto;
}>)
Description
Revoke an api key for your account.

Tags
Account

Name
RevokeApiKey

Summary
Revoke an API key

Request
PUT:/account/apikeys/{key}
- - (key, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetApiKeyDto;
    }>
  - Parameters
    - key: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: GetApiKeyDto;
    }>

baseUrl

baseUrl: string = "https://gw-1.api.piertwo.io"

ethereum

ethereum: {
    abandonStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: DataWithMessage;
    }>);
    broadcastPresignedExitMessage: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: BeaconNodeVoluntaryExitResponse;
    }>);
    bulkWithdraw: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: BulkWithdrawError[];
    }>);
    createStake: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: CreateStakeResponse;
    }>);
    createStakeV2: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: CreateStakeV2Response;
    }>);
    createStakeV3: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: CreateStakeV2Response;
    }>);
    estimateWithdrawalTimes: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: EstimatedWithdrawalTimes[];
    }>);
    genPresignedExitMsg: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorExitMessageResp[];
    }>);
    generateDepositData: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorDepositJson[];
    }>);
    getDepositDataForStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorDepositJson[];
    }>);
    getEthereumStakes: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: StakeDetailsWithValidators[];
    }>);
    getOrderedValidators: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorWithStakeDetails[];
    }>);
    getStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: StakeDetailsWithValidators;
    }>);
    getStakesWithValidatorStatusCounts: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: StakeWithValidatorStatusCounts[];
    }>);
    getValidatorAccountsSummary: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: CustomerAccount[];
    }>);
    getValidatorDailyPerformance: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorPerformance[];
    }>);
    getValidatorDailyRewards: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorStat[];
    }>);
    getValidatorDashboardSummary: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: CustomerDashboard;
    }>);
    getValidatorIncomeHistory: ((query, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorIncomeHistory[];
    }>);
    getValidatorInfo: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorInfo[];
    }>);
    getValidatorQueueStats: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: QueueStats;
    }>);
    getValidatorRewardsChartData: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: ValidatorDailyPerformanceStat[];
    }>);
} = ...

Type declaration

abandonStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: DataWithMessage;
}>)
Description
Abandon stake request and all associated validators.

Tags
Ethereum

Name
AbandonStake

Summary
Abandon Stake

Request
PUT:/ethereum/stake/{stakeId}/abandon
- - (stakeId, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: DataWithMessage;
    }>
  - Parameters
    - stakeId: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: DataWithMessage;
    }>
broadcastPresignedExitMessage: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BeaconNodeVoluntaryExitResponse;
}>)
Description
Broadcast one or more pre-signed exit messages to the beacon chain

Tags
Ethereum

Name
BroadcastPresignedExitMessage

Summary
Broadcast exit message(s)

Request
POST:/ethereum/broadcastPresignedExitMsg
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: BeaconNodeVoluntaryExitResponse;
    }>
  - Parameters
    - data: ValidatorExitMessage
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: BeaconNodeVoluntaryExitResponse;
    }>
bulkWithdraw: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BulkWithdrawError[];
}>)
Description
Generate pre-signed exit message(s) for a specified list of public keys and broadcast the message to a beacon node in a single request.

Tags
Ethereum

Name
BulkWithdraw

Summary
Bulk withdraw Validators

Request
POST:/ethereum/bulkWithdrawValidators
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: BulkWithdrawError[];
    }>
  - Parameters
    - data: GenPresignedExitMsgDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: BulkWithdrawError[];
    }>
createStake: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeResponse;
}>)
Description
DEPRECATED use /stakeV2 instead. Request one or more new validators. Validators created via this endpoint will have 0x01 withdrawal credentials.

Tags
Ethereum

Name
CreateStake

Summary
[Deprecated] Create Capella-era (0x01) validator(s)

Request
POST:/ethereum/stake
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CreateStakeResponse;
    }>
  - Parameters
    - data: CreateStakeDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CreateStakeResponse;
    }>
createStakeV2: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeV2Response;
}>)
Description
Request one or more new validators, returning the individual validator details in the response. Validators created via this endpoint will have 0x01 withdrawal credentials.

Tags
Ethereum

Name
CreateStakeV2

Summary
Create Capella-era (0x01) validator(s)

Request
POST:/ethereum/stakeV2
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CreateStakeV2Response;
    }>
  - Parameters
    - data: CreateStakeDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CreateStakeV2Response;
    }>
createStakeV3: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeV2Response;
}>)
Description
Stake an arbitrary amount of ETH (Denoted in gwei) post-Pectra. This endpoint will calculate and create the appropriate number of validators for the staked amount. The data required for the deposit transaction will be returned in the response. Validators created via this endpoint will have 0x02 withdrawal credentials.

Tags
Ethereum

Name
CreateStakeV3

Summary
Create Pectra-era (0x02) validator(s)

Request
POST:/ethereum/stakeV3
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CreateStakeV2Response;
    }>
  - Parameters
    - data: CreateStakePectraDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CreateStakeV2Response;
    }>
estimateWithdrawalTimes: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: EstimatedWithdrawalTimes[];
}>)
Description
This endpoint will simulate all pending withdrawals up to and including the specified validator indexes. The simulation calculates the estimated exit as if the exit had been processed at that moment in time. The results are indicative and can only account for the state of the exit queue at the time of simulating. If this is being used optimise validator exits, caution should be taken since missing the predictedExitSubmissionDeadlineEpoch will result in the longest possible period of no rewards earned. Submitting exit messages during the deadline epoch can be risky, some time (2-4 minutes) should be allowed for the beacon chain to process any exit messages broadcasted to the network. We recommend submitting exit messages at least an hour before the deadline epoch to account for unexpected changes to the exit queue. You should also consider the impact of your own withdrawals on the exit queue if you are exiting large amounts of validators at once. This endpoint will return an error in the following situations: - one or more invalid validator indexes are passed - one or more of the specified validators does not have withdrawal credentials set (0x01...) - one or more validators has already exited - one or more validators is not known to the beacon chain Below is a description of each of the fields returned: - expectedExitEpoch - the epoch in which the validator would exit the Beacon chain if its exit was processed at the current time - expectedFullWithdrawalEligibilityEpoch - the epoch where the validator would become eligible for receiving the full staked balance ETH plus any excess - predictedUpcomingWithdrawalEpoch - the predicted epoch in which the validator's withdrawal will be processed by the Beacon chain, taking the current exit queue into account - predictedExitSubmissionDeadlineEpoch - the deadline epoch in which the validator should already be queued for exiting the Beacon chain

Tags
Ethereum

Name
EstimateWithdrawalTimes

Summary
Estimate validator exit times

Request
POST:/ethereum/estimateWithdrawalTimes
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: EstimatedWithdrawalTimes[];
    }>
  - Parameters
    - data: EstimateWithdrawalTimesDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: EstimatedWithdrawalTimes[];
    }>
genPresignedExitMsg: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorExitMessageResp[];
}>)
Description
Generate one or more pre-signed exit messages for a specified list of public keys

Tags
Ethereum

Name
GenPresignedExitMsg

Summary
Generate exit message(s)

Request
POST:/ethereum/genPresignedExitMsg
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorExitMessageResp[];
    }>
  - Parameters
    - data: GenPresignedExitMsgDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorExitMessageResp[];
    }>
generateDepositData: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDepositJson[];
}>)
Description
By default, validator records are populated with deposit transaction data suitable for deposits of 32ETH. This endpoint can be used in situations where you want to perform deposits of amounts other than 32ETH. This will generate the deposit transaction data for one or more validators corresponding to the amount(s) specified in the request body. Note that this will not replace nor invalidate the deposit data that is stored on the validator records themselves This endpoint will return an error in the following situations: - an invalid amount is specified (<= 0 or > 32000000000) - one or more of the specified validators is not in a WAITING_DEPOSIT state - one or more validators is not associated your account - the list of specified validators contains duplicate pubkeys

Tags
Ethereum

Name
GenerateDepositData

Summary
Generate arbitrary amount deposit data

Request
POST:/ethereum/validators/generateDepositData
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorDepositJson[];
    }>
  - Parameters
    - data: GenerateDepositDataDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorDepositJson[];
    }>
getDepositDataForStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDepositJson[];
}>)
Description
Returns deposit data for all validators in the specified stake request.

Tags
Ethereum

Name
GetDepositDataForStake

Summary
Get deposit data for Stake

Request
GET:/ethereum/stake/{stakeId}/depositdata
- - (stakeId, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorDepositJson[];
    }>
  - Parameters
    - stakeId: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorDepositJson[];
    }>
getEthereumStakes: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakeDetailsWithValidators[];
}>)
Description
Returns details of all staking requests for your account including withdrawal address, fee recipient, and validator details.

Tags
Ethereum

Name
GetEthereumStakes

Summary
Get Stakes

Request
GET:/ethereum/stakes
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakeDetailsWithValidators[];
    }>
  - Parameters
    - Optional query: {
      reference?: string;
      }
      Optional reference?: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakeDetailsWithValidators[];
    }>
getOrderedValidators: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorWithStakeDetails[];
}>)
Description
Returns Validators for your account with filtering on reference, withdrawal address, and status. Records are returned in order of initial request.

Tags
Ethereum

Name
GetOrderedValidators

Summary
Get Validators

Request
GET:/ethereum/orderedValidators
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorWithStakeDetails[];
    }>
  - Parameters
    - Optional query: {
          count?: string;
          reference?: string;
          skip?: string;
          status?: string;
          withdrawalAddress?: string;
      }
      Optional count?: string
      defaults to 100
      
      Optional reference?: string
      Optional skip?: string
      Optional status?: string
      Optional withdrawalAddress?: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorWithStakeDetails[];
    }>
getStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakeDetailsWithValidators;
}>)
Description
Returns stake details and associated validators by stakeId.

Tags
Ethereum

Name
GetStake

Summary
Get Stake details by stakeId

Request
GET:/ethereum/stake/{stakeId}
- - (stakeId, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakeDetailsWithValidators;
    }>
  - Parameters
    - stakeId: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakeDetailsWithValidators;
    }>
getStakesWithValidatorStatusCounts: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakeWithValidatorStatusCounts[];
}>)
Description
Returns all staking requests with validator status counts.

Tags
Ethereum

Name
GetStakesWithValidatorStatusCounts

Summary
Get Stakes with validator counts bystatus

Request
GET:/ethereum/stakesWithValidatorStatusCounts
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakeWithValidatorStatusCounts[];
    }>
  - Parameters
    - Optional query: {
      reference?: string;
      withdrawalAddress?: string;
      }
      Optional reference?: string
      Optional withdrawalAddress?: string
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakeWithValidatorStatusCounts[];
    }>
getValidatorAccountsSummary: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CustomerAccount[];
}>)
Description
Returns the accounts summary. Individual stakes are not flattened

Tags
Ethereum

Name
GetValidatorAccountsSummary

Summary
Get Staking accounts summary

Request
GET:/ethereum/validators/accounts
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CustomerAccount[];
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CustomerAccount[];
    }>
getValidatorDailyPerformance: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorPerformance[];
}>)
Description
Returns daily performance stats of validators, returns stats for all active validators if none are specified

Tags
Ethereum

Name
GetValidatorDailyPerformance

Summary
Get Validator daily performance

Request
GET:/ethereum/validators/performance
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorPerformance[];
    }>
  - Parameters
    - Optional query: {
      validatorIndex?: string;
      }
      Optional validatorIndex?: string
      comma seperated list of validator indexes
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorPerformance[];
    }>
getValidatorDailyRewards: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorStat[];
}>)
Description
Returns daily rewards stats of validators, returns stats for all active validators if none are specified

Tags
Ethereum

Name
GetValidatorDailyRewards

Summary
Get Validator daily rewards

Request
GET:/ethereum/validators/dailyRewards
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorStat[];
    }>
  - Parameters
    - Optional query: {
          currency?: string;
          dateFrom?: number;
          dateTo?: number;
          validatorIndex?: string;
      }
      Optional currency?: string
      fiat currency for ethereum pricing
      
      Optional dateFrom?: number
      unix timestamp of starting date from
      
      Optional dateTo?: number
      unix timestamp of ending date to
      
      Optional validatorIndex?: string
      comma seperated list of validator indexes
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorStat[];
    }>
getValidatorDashboardSummary: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CustomerDashboard;
}>)
Description
Returns the dashboard summary. Individual stakes are flattened

Tags
Ethereum

Name
GetValidatorDashboardSummary

Summary
Get Staking dashboard summary

Request
GET:/ethereum/validators/dashboard
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CustomerDashboard;
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: CustomerDashboard;
    }>
getValidatorIncomeHistory: ((query, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorIncomeHistory[];
}>)
Description
Returns validator income history for a given time frame and validator indices

Tags
Ethereum

Name
GetValidatorIncomeHistory

Summary
Get Validator income history

Request
GET:/ethereum/validators/incomeHistory
- - (query, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorIncomeHistory[];
    }>
  - Parameters
    - query: {
          account?: string;
          timeFrame: "1D" | "1W";
          validatorIds?: string;
      }
      Optional account?: string
      account reference to use as filter
      
      timeFrame: "1D" | "1W"
      Time frame for the data: 1D (1 day in 1-hour chunks) or 1W (1 week in 6-hour chunks)
      
      Optional validatorIds?: string
      comma seperated list of validator indexes
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorIncomeHistory[];
    }>
getValidatorInfo: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorInfo[];
}>)
Description
Returns beacon chain information of validators, returns info for all active validators if none are specified.

Tags
Ethereum

Name
GetValidatorInfo

Summary
Get Validator beacon chain info

Request
GET:/ethereum/validators/info
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorInfo[];
    }>
  - Parameters
    - Optional query: {
      validatorIndex?: string;
      }
      Optional validatorIndex?: string
      comma seperated list of validator indexes
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorInfo[];
    }>
getValidatorQueueStats: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: QueueStats;
}>)
Description
Returns the estimated wait times and other queue stats for entering and exiting validators.

Tags
Ethereum

Name
GetValidatorQueueStats

Summary
Get Validator queue

Request
GET:/ethereum/validators/queueStats
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: QueueStats;
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: QueueStats;
    }>
getValidatorRewardsChartData: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDailyPerformanceStat[];
}>)
Description
Returns summarized validator rewards data suitable for use in charts.

Tags
Ethereum

Name
GetValidatorRewardsChartData

Summary
Get staking rewards chart data

Request
GET:/ethereum/validators/rewardsChartData
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorDailyPerformanceStat[];
    }>
  - Parameters
    - Optional query: {
          account?: string;
          currency?: string;
          datapoints?: number;
          dateFrom?: number;
          dateTo?: number;
          validatorIds?: string;
      }
      Optional account?: string
      account reference to use as filter
      
      Optional currency?: string
      currency used for price data
      
      Optional datapoints?: number
      number of datapoints to return
      
      Optional dateFrom?: number
      unix timestamp of starting date from
      
      Optional dateTo?: number
      unix timestamp of ending date to
      
      Optional validatorIds?: string
      comma seperated list of validator indexes
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: ValidatorDailyPerformanceStat[];
    }>

public

public: {
    getSystemInfo: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: SystemInfoResponse;
    }>);
    getWebsiteData: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: WebsiteData;
    }>);
    networkConfig: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: PierTwoInfo;
    }>);
} = ...

Type declaration

getSystemInfo: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: SystemInfoResponse;
}>)
Description
Get system information including API versions

Tags
Public

Name
GetSystemInfo

Summary
Get System Info

Request
GET:/public/systemInfo
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: SystemInfoResponse;
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: SystemInfoResponse;
    }>
getWebsiteData: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: WebsiteData;
}>)
Description
get data for rendering network statistics (asset prices, assets UAM, etc)

Tags
Public

Name
GetWebsiteData

Summary
Get Pier Two Public Data

Request
GET:/public/websiteData
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: WebsiteData;
    }>
  - Parameters
    - Optional query: {
      currency?: string;
      }
      Optional currency?: string
      currency used for price data (usd by default)
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: WebsiteData;
    }>
networkConfig: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: PierTwoInfo;
}>)
Description
get static network config such as chain id, contract addresses, operator addresses, etc

Tags
Public

Name
NetworkConfig

Summary
Get Network Config

Request
GET:/public/networkConfig
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: PierTwoInfo;
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: PierTwoInfo;
    }>

solana

solana: {
    buildTransactionPayload: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: BuildTransactionPayloadResponseDto;
    }>);
    getNetworkStakingInfo: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: StakingNetworkInfo;
    }>);
    getPerformanceSummary: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: StakingPerformanceSummary;
    }>);
    getSolanaStakes: ((query?, params?) => Promise<Omit<PaginatedApiResponseBase, "data"> & Required<Pick<PaginatedApiResponseBase, "data">> & {
        data: SolanaStakeAccount[];
    }>);
    getStakeAccoutDailyRewards: ((query, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: SolanaStakeAccountRewards[];
    }>);
    getStakeRewardsChartData: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
        data: StakingRewardsChartData[];
    }>);
} = ...

Type declaration

buildTransactionPayload: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BuildTransactionPayloadResponseDto;
}>)
Description
Generate a stake transaction payload containing one or more instructions. Possible instruction types and inputs are described below: This returns a serialized transaction which can be deserialized, signed and submitted to the network. See @solana/web.js docs for deserializing Versioned Messages and working with Versioned Transactions N.B any instructions operating on an existing stake account must specify target stakePubkey in the request body seperate to the instructions Create and delegate new stake account ~~~ { type: 'createAndDelegate' input: { fromPubkey: pubkey of funding address, stakeAuthority: address authorized to delegate and undelegate stake, withdrawAuthority: address authorized to withdraw stake, lamports: amount of lamports to stake (1 sol = 1000000000 lamports), reference: an arbitrary reference used to identify/group the stake within the Pier Two platform, label: an arbitrary label/memo for use within the Pier Two platform } } ~~~ Create a new stake account (same input data as 'createAndDelegate') ~~~ { type: 'create' input: { fromPubkey: pubkey of funding address, stakeAuthority: address authorized to delegate and undelegate stake, withdrawAuthority: address authorized to withdraw stake, lamports: amount of lamports to stake (1 sol = 1000000000 lamports), reference: an arbitrary reference used to identify/group the stake within the Pier Two platform, label: an arbitrary label/memo for use within the Pier Two platform } } ~~~ Delegate an existing stake account ~~~ { type: 'delegate' input: { authorizedPubkey: address authorized to delegate and undelegate stake } } ~~~ Undelegate (deactivate) an existing stake account ~~~ { type: 'undelegate' input: { authorizedPubkey: address authorized to delegate and undelegate stake } } ~~~ Withdraw inactive stake (deactivated stake balance or any other excess SOL held by account) ~~~ { type: 'withdraw' input: { toPubkey: recipient of withdrawn funds, authorizedPubkey: address authorized to withdraw stake, lamports: amount of lamports to withdraw (1 sol = 1000000000 lamports), } } ~~~ Merge an eligible stake account into target stake account An eligible stake account must have the same stakeAuthority and withdrawAuthority and have been active for an entire epoch and earned rewards ~~~ { type: 'merge' input: { sourceStakePubkey: address of stake account to merge (this account will be dissolved/closed onchain), authorizedPubkey: address authorized to delegate and undelegate } } ~~~

Tags
Solana

Name
BuildTransactionPayload

Summary
Generate a stake transaction payload

Request
POST:/solana/stake/buildTransaction
- - (data, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: BuildTransactionPayloadResponseDto;
    }>
  - Parameters
    - data: BuildTransactionPayloadRequestDto
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: BuildTransactionPayloadResponseDto;
    }>
getNetworkStakingInfo: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakingNetworkInfo;
}>)
Description
Returns information about the current epoch and inflation reward rate.

Tags
Solana

Name
GetNetworkStakingInfo

Summary
Get current epoch staking reward info

Request
GET:/solana/stake/networkInfo
- - (params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakingNetworkInfo;
    }>
  - Parameters
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakingNetworkInfo;
    }>
getPerformanceSummary: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakingPerformanceSummary;
}>)
Description
Returns the 7D, 30D and total inflation and MEV rewards for the specified stake accounts.

Tags
Solana

Name
GetPerformanceSummary

Summary
Get Solana stake performance summary

Request
GET:/solana/stake/performanceSummary
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakingPerformanceSummary;
    }>
  - Parameters
    - Optional query: {
      stakePubkey?: string;
      }
      Optional stakePubkey?: string
      comma seperated list of stake account pubkeys, will return data for all active stake accounts if none are provided
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakingPerformanceSummary;
    }>
getSolanaStakes: ((query?, params?) => Promise<Omit<PaginatedApiResponseBase, "data"> & Required<Pick<PaginatedApiResponseBase, "data">> & {
data: SolanaStakeAccount[];
}>)
Description
Returns the details of Solana staking positions for your account.

Tags
Solana

Name
GetSolanaStakes

Summary
Get Solana Stake Accounts

Request
GET:/solana/stakes
- - (query?, params?): Promise<Omit<PaginatedApiResponseBase, "data"> & Required<Pick<PaginatedApiResponseBase, "data">> & {
    data: SolanaStakeAccount[];
    }>
  - Parameters
    - Optional query: {
      pageNumber?: number;
      pageSize?: number;
      }
      Optional pageNumber?: number
      Optional pageSize?: number
    - params: RequestParams = {}
    Returns Promise<Omit<PaginatedApiResponseBase, "data"> & Required<Pick<PaginatedApiResponseBase, "data">> & {
    data: SolanaStakeAccount[];
    }>
getStakeAccoutDailyRewards: ((query, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: SolanaStakeAccountRewards[];
}>)
Description
Returns daily rewards stats of specified stake accounts.

Tags
Solana

Name
GetStakeAccoutDailyRewards

Summary
Get daily rewards stats

Request
GET:/solana/stake/dailyRewards
- - (query, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: SolanaStakeAccountRewards[];
    }>
  - Parameters
    - query: {
          currency?: string;
          dateFrom?: number;
          dateTo?: number;
          stakePubkey: string;
      }
      Optional currency?: string
      fiat currency for ethereum pricing
      
      Optional dateFrom?: number
      unix timestamp of starting date from
      
      Optional dateTo?: number
      unix timestamp of ending date to
      
      stakePubkey: string
      comma seperated list of stake account pubkeys
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: SolanaStakeAccountRewards[];
    }>
getStakeRewardsChartData: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakingRewardsChartData[];
}>)
Description
Returns summarized Solana staking rewards data suitable for use in charts.

Tags
Solana

Name
GetStakeRewardsChartData

Summary
Get staking rewards chart data

Request
GET:/solana/stake/rewardsChartData
- - (query?, params?): Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakingRewardsChartData[];
    }>
  - Parameters
    - Optional query: {
          currency?: number;
          datapoints?: number;
          dateFrom?: number;
          dateTo?: number;
          stakePubkeys?: string;
      }
      Optional currency?: number
      currency used for price data
      
      Optional datapoints?: number
      number of datapoints to return, defaults to 30
      
      Optional dateFrom?: number
      unix timestamp of starting date from
      
      Optional dateTo?: number
      unix timestamp of ending date to
      
      Optional stakePubkeys?: string
      comma seperated list of stake pubkeys, will return all rewards if none are specified
    - params: RequestParams = {}
    Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
    data: StakingRewardsChartData[];
    }>

utils

utils: {
    waitForActiveMnemonic: ((args?) => Promise<unknown>);
    waitForValidatorStatus: ((args) => Promise<unknown>);
    generateBatchDepositCallData(args): `0x${string}`;
    validatorWithStakeDetailsToDepositDataJson(validatorWithStakeDetails): ValidatorDepositJson;
} = ...

Type declaration

waitForActiveMnemonic: ((args?) => Promise<unknown>)
Description
a promise that resolves when your mnemonic status is ACTIVE

Tags
utils
- - (args?): Promise<unknown>
  - Parameters
    - Optional args: {
      interval?: number;
      }
      Optional interval?: number
    Returns Promise<unknown>
waitForValidatorStatus: ((args) => Promise<unknown>)
Description
a promise that resolves when all validators associated to stakeId reach desiredStatus

Tags
utils
- - (args): Promise<unknown>
  - Parameters
    - args: {
          desiredStatus: EthereumValidatorStatus;
          interval?: number;
          network: ethereum;
          stakeId: string;
      }
      desiredStatus: EthereumValidatorStatus
      Optional interval?: number
      network: ethereum
      stakeId: string
    Returns Promise<unknown>
generateBatchDepositCallData:function
- generateBatchDepositCallData(args): `0x${string}`
- Parameters
  - args: {
    depositData: ValidatorDepositJson[];
    }
    - depositData: ValidatorDepositJson[]
  Returns `0x${string}`
  Description
  generate call data for a batch validator deposit the data field returned from ethereum.getDepositDataForStake can be passed to this function
  
  Tags
  utils
  - Defined in src/PierTwoStakingApi.ts:178
validatorWithStakeDetailsToDepositDataJson:function
- validatorWithStakeDetailsToDepositDataJson(validatorWithStakeDetails): ValidatorDepositJson
- Parameters
  - validatorWithStakeDetails: ValidatorWithStakeDetails
  Returns ValidatorDepositJson
  Description
  converts data fetched from ethereum.getOrderedValidators to be used with utils.generateBatchDepositCallData
  
  Tags
  utils
  - Defined in src/PierTwoStakingApi.ts:155

Methods

abortRequest

abortRequest(cancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
Inherited from Api.abortRequest
- Defined in src/PierTwoStakingApiBase.ts:698

`Protected` addArrayQueryParam

addArrayQueryParam(query, key): any
Parameters
- query: QueryParamsType
- key: string
Returns any
Inherited from Api.addArrayQueryParam
- Defined in src/PierTwoStakingApiBase.ts:633

`Protected` addQueryParam

addQueryParam(query, key): string
Parameters
- query: QueryParamsType
- key: string
Returns string
Inherited from Api.addQueryParam
- Defined in src/PierTwoStakingApiBase.ts:629

`Protected` addQueryParams

addQueryParams(rawQuery?): string
Parameters
- Optional rawQuery: QueryParamsType
Returns string
Inherited from Api.addQueryParams
- Defined in src/PierTwoStakingApiBase.ts:646

`Protected` createAbortSignal

createAbortSignal(cancelToken): undefined | AbortSignal
Parameters
- cancelToken: CancelToken
Returns undefined | AbortSignal
Inherited from Api.createAbortSignal
- Defined in src/PierTwoStakingApiBase.ts:684

`Protected` encodeQueryParam

encodeQueryParam(key, value): string
Parameters
- key: string
- value: any
Returns string
Inherited from Api.encodeQueryParam
- Defined in src/PierTwoStakingApiBase.ts:624

`Protected` mergeRequestParams

mergeRequestParams(params1, params2?): RequestParams
Parameters
- params1: RequestParams
- Optional params2: RequestParams
Returns RequestParams
Inherited from Api.mergeRequestParams
- Defined in src/PierTwoStakingApiBase.ts:671

request

request<T, E>(__namedParameters): Promise<T>
Type Parameters
- T = any
- E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<T>
Inherited from Api.request
- Defined in src/PierTwoStakingApiBase.ts:707

setSecurityData

setSecurityData(data): void
Parameters
- data: null
Returns void
Inherited from Api.setSecurityData
- Defined in src/PierTwoStakingApiBase.ts:620

`Protected` toQueryString

toQueryString(rawQuery?): string
Parameters
- Optional rawQuery: QueryParamsType
Returns string
Inherited from Api.toQueryString
- Defined in src/PierTwoStakingApiBase.ts:638

Class PierTwoStakingApi

Title

Version

Base Url

Contact

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PierTwoStakingApi

Properties

account

Type declaration

addNewApiKey: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetApiKeyDto; }>)

Description

Tags

Name

Summary

Request

Parameters

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetApiKeyDto; }>

getAccount: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetAccountResponse; }>)

Description

Tags

Name

Summary

Request

Parameters

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetAccountResponse; }>

getApiKeys: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetApiKeyDto[]; }>)

Description

Tags

Name

Summary

Request

Parameters

Optional includeRevokedKeys?: string

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetApiKeyDto[]; }>

revokeApiKey: ((key, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetApiKeyDto; }>)

Description

Tags

Name

Summary

Request

Parameters

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: GetApiKeyDto; }>

baseUrl

ethereum

Type declaration

abandonStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: DataWithMessage; }>)

Description

Tags

Name

Summary

Request

Parameters

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: DataWithMessage; }>

broadcastPresignedExitMessage: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: BeaconNodeVoluntaryExitResponse; }>)

Description

Tags

Name

Summary

Request

Parameters

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: BeaconNodeVoluntaryExitResponse; }>

bulkWithdraw: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: BulkWithdrawError[]; }>)

Description

Tags

Name

Summary

Request

Parameters

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: BulkWithdrawError[]; }>

createStake: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & { data: CreateStakeResponse; }>)

Description

Tags

addNewApiKey: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto;
}>

getAccount: ((params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetAccountResponse;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetAccountResponse;
}>

getApiKeys: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto[];
}>)

`Optional` includeRevokedKeys?: string

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto[];
}>

revokeApiKey: ((key, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: GetApiKeyDto;
}>

abandonStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: DataWithMessage;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: DataWithMessage;
}>

broadcastPresignedExitMessage: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BeaconNodeVoluntaryExitResponse;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BeaconNodeVoluntaryExitResponse;
}>

bulkWithdraw: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BulkWithdrawError[];
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: BulkWithdrawError[];
}>

createStake: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeResponse;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeResponse;
}>

createStakeV2: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeV2Response;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeV2Response;
}>

createStakeV3: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeV2Response;
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: CreateStakeV2Response;
}>

estimateWithdrawalTimes: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: EstimatedWithdrawalTimes[];
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: EstimatedWithdrawalTimes[];
}>

genPresignedExitMsg: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorExitMessageResp[];
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorExitMessageResp[];
}>

generateDepositData: ((data, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDepositJson[];
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDepositJson[];
}>

getDepositDataForStake: ((stakeId, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDepositJson[];
}>)

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorDepositJson[];
}>

getEthereumStakes: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakeDetailsWithValidators[];
}>)

`Optional` reference?: string

Returns Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: StakeDetailsWithValidators[];
}>

getOrderedValidators: ((query?, params?) => Promise<Omit<ApiResponseBase, "data"> & Required<Pick<ApiResponseBase, "data">> & {
data: ValidatorWithStakeDetails[];
}>)

`Optional` count?: string