Staker Event API V1

[surbhit14]

Staker Event API V1

Introduction

This API will cover the following 6 events

• EventLogs_StakerDelegated
• EventLogs_StakerUndelegated
• EventLogs_OperatorSharesIncreased
• EventLogs_OperatorSharesDecreased
• EventLogs_Deposit
• EventLogs_WithdrawalQueued

with event types

• DELEGATION
• UNDELEGATION
• SHARES_INCREASED
• SHARES_DECREASED
• DEPOSIT
• WITHDRAWAL_QUEUED
• WITHDRAWAL_COMPLETED

divided into 3 endpoints as follows

API endpoints

1. /stakers/[address]/events/delegation
   (This is similar to the operator event delegation endpoint except this one is for stakers)

Event Types

• DELEGATION
• UNDELEGATION
• SHARES_INCREASED
• SHARES_DECREASED

Response

{
  type: string // name of the event
  tx: string // transaction hash
  blockNumber: number // block number of the tx
  blockTime: Date // blocktime of the tx
  args: {
    operator: string
    strategy?: string
    shares?: number
  },
   underlyingToken?: string
   underlyingValue?: number
   ethValue?: number
}

Supported Filters

• event type
• transaction hash
• start date for blockTime
• end date for blockTime
• operator address
• strategy address (for shares increased, shares decreased)
• withTokenData (when enabled, returns underlyingToken and underlyingValue)
• withEthValue (when enabled, returns ethValue)

2. /stakers/[address]/events/deposit

Event Type
DEPOSIT

Response

{
  type: string // name of the event
  tx: string // transaction hash
  blockNumber: number // block number of the tx
  blockTime: Date // blocktime of the tx
  args: {
    token: string
    strategy: string
    shares: number
  },
   underlyingToken?: string
   underlyingValue?: number
   ethValue?: number
}

Supported Filters

• transaction hash
• start date for blockTime
• end date for blockTime
• token address
• strategy address
• withTokenData (when enabled, returns underlyingToken and underlyingValue)
• withEthValue (when enabled, returns ethValue)

3./stakers/[address]/events/withdrawal

Event Types
WITHDRAWAL_QUEUED
WITHDRAWAL_COMPLETED

Response

{
  type: string // name of the event
  tx: string // transaction hash
  blockNumber: number // block number of the tx
  blockTime: Date // blocktime of the tx
  args: {
    withdrawalRoot: string
    delegatedTo?: string
    withdrawer?: string
    nonce?: number
    startBlock?: number
    strategies?: [
	{
	    strategy: string
            shares: string
            underlyingToken?: string
            underlyingValue?: number
            ethValue?: number
	}	
    ]
  }
}

Supported Filters

• type
• transaction hash
• withdrawalRoot
• start date for blockTime
• end date for blockTime
• delegatedTo (for WITHDRAWAL_QUEUED)
• withdrawer (for WITHDRAWAL_QUEUED)
• withTokenData (for WITHDRAWAL_QUEUED)(when enabled, returns underlyingToken and underlyingValue)
• withEthValue (for WITHDRAWAL_QUEUED)(when enabled, returns ethValue)