StakeKeyLifeCycleController.java

package org.cardanofoundation.explorer.api.controller;

import java.util.Date;

import jakarta.validation.Valid;

import lombok.RequiredArgsConstructor;

import org.springframework.data.domain.Sort;

import org.springframework.http.ResponseEntity;

import org.springframework.validation.annotation.Validated;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.RestController;

import io.swagger.v3.oas.annotations.Operation;

import io.swagger.v3.oas.annotations.Parameter;

import io.swagger.v3.oas.annotations.tags.Tag;

import org.springdoc.core.annotations.ParameterObject;

import org.cardanofoundation.explorer.api.common.constant.CommonConstant;

import org.cardanofoundation.explorer.api.config.LogMessage;

import org.cardanofoundation.explorer.api.controller.validation.StakeKeyLengthValid;

import org.cardanofoundation.explorer.api.model.request.stake.StakeLifeCycleFilterRequest;

import org.cardanofoundation.explorer.api.model.response.BaseFilterResponse;

import org.cardanofoundation.explorer.api.model.response.stake.lifecycle.*;

import org.cardanofoundation.explorer.api.service.StakeKeyLifeCycleService;

import org.cardanofoundation.explorer.common.entity.enumeration.RewardType;

import org.cardanofoundation.explorer.common.entity.ledgersync.BaseEntity_;

import org.cardanofoundation.explorer.common.entity.ledgersync.Delegation_;

import org.cardanofoundation.explorer.common.entity.ledgersync.StakeRegistration_;

import org.cardanofoundation.explorer.common.entity.ledgersyncsagg.AddressTxAmount_;

import org.cardanofoundation.explorer.common.validation.date.DatePattern;

import org.cardanofoundation.explorer.common.validation.date.param.DateValid;

import org.cardanofoundation.explorer.common.validation.length.LengthValid;

import org.cardanofoundation.explorer.common.validation.pagination.Pagination;

import org.cardanofoundation.explorer.common.validation.pagination.PaginationDefault;

import org.cardanofoundation.explorer.common.validation.pagination.PaginationValid;

import org.cardanofoundation.explorer.common.validation.prefixed.PrefixedValid;

@RestController

@RequestMapping("/api/v1/stake-lifecycle")

@Validated

@Tag(name = "stake-lifecycle", description = "The stake key lifecycle APIs")

public class StakeKeyLifeCycleController {

  private final StakeKeyLifeCycleService stakeKeyLifeCycleService;

  @GetMapping("/{stakeKey}")

  @LogMessage

  @Operation(

      summary = "Check lifecycle of stake key",

      description =

          "Check stake key lifecycle contains: registration, de-registration, delegation, reward,  withdrawal",

      tags = {"stake-lifecycle"})

  public ResponseEntity<StakeLifecycleResponse> getStakeLifeCycle(

      @PathVariable

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          String stakeKey) {

  }

  @GetMapping("/{stakeKey}/registrations")

  @LogMessage

  @Operation(

      summary = "Get list registration transaction of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeRegistrationFilterResponse>> getStakeRegistrations(

      @PathVariable

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          String stakeKey,

      @ParameterObject StakeLifeCycleFilterRequest condition,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {StakeRegistration_.TX},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/{stakeKey}/registrations/{hash}")

  @LogMessage

  @Operation(

      summary = "Get stake key registration transaction detail",

      tags = {"stake-lifecycle"})

  public ResponseEntity<StakeRegistrationDetailResponse> getStakeRegistrationDetail(

      @PathVariable

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          String stakeKey,

      @PathVariable

          @Parameter(description = "The hash identifier of the transaction.")

          @LengthValid(CommonConstant.TX_HASH_LENGTH)

          String hash) {

  }

  @GetMapping("/{stakeKey}/de-registrations")

  @LogMessage

  @Operation(

      summary = "Get list de-registration transaction of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeRegistrationFilterResponse>>

      getStakeDeRegistrations(

          @PathVariable

              @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

              @StakeKeyLengthValid

              @Parameter(description = "The Bech32 encoded version of the stake address.")

              String stakeKey,

          @ParameterObject StakeLifeCycleFilterRequest condition,

          @ParameterObject

              @PaginationValid

              @PaginationDefault(

                  size = 20,

                  sort = {StakeRegistration_.TX},

                  direction = Sort.Direction.DESC)

              @Valid

              Pagination pagination) {

  }

  @GetMapping("/{stakeKey}/de-registrations/{hash}")

  @LogMessage

  @Operation(

      summary = "Get stake key de-registration transaction detail",

      tags = {"stake-lifecycle"})

  public ResponseEntity<StakeRegistrationDetailResponse> getStakeDeRegistrationDetail(

      @PathVariable

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          String stakeKey,

      @PathVariable

          @Parameter(description = "The hash identifier of the transaction.")

          @LengthValid(CommonConstant.TX_HASH_LENGTH)

          String hash) {

  }

  @GetMapping("/{stakeKey}/delegations")

  @LogMessage

  @Operation(

      summary = "Get list delegation transaction of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeDelegationFilterResponse>> getDelegations(

      @PathVariable

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          String stakeKey,

      @ParameterObject StakeLifeCycleFilterRequest condition,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {Delegation_.TX},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/{stakeKey}/delegations/{hash}")

  @LogMessage

  @Operation(

      summary = "Get stake key delegation transaction detail",

      tags = {"stake-lifecycle"})

  public ResponseEntity<StakeDelegationDetailResponse> getDelegationDetail(

      @PathVariable

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          String stakeKey,

      @PathVariable

          @Parameter(description = "The hash identifier of the transaction.")

          @LengthValid(CommonConstant.TX_HASH_LENGTH)

          String hash) {

  }

  @GetMapping("/{stakeKey}/rewards")

  @LogMessage

  @Operation(

      summary = "Get list reward of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeRewardResponse>> getRewards(

      @PathVariable

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          String stakeKey,

      @RequestParam(value = "type", required = false) RewardType type,

      @RequestParam(value = "fromDate", required = false)

          @DateValid(pattern = DatePattern.YYYY_MM_DD)

          Date fromDate,

      @RequestParam(value = "toDate", required = false) @DateValid(pattern = DatePattern.YYYY_MM_DD)

          Date toDate,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {BaseEntity_.ID},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/{stakeKey}/withdrawals")

  @LogMessage

  @Operation(

      summary = "Get list withdrawal transaction of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeWithdrawalFilterResponse>> getWithdrawals(

      @PathVariable

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          String stakeKey,

      @ParameterObject @Parameter(description = "filter condition")

          StakeLifeCycleFilterRequest condition,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {BaseEntity_.ID},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/{stakeKey}/withdrawals/{hash}")

  @LogMessage

  @Operation(

      summary = "Get stake key withdrawal transaction detail",

      tags = {"stake-lifecycle"})

  public ResponseEntity<StakeWithdrawalDetailResponse> getDetailWithdrawal(

      @PathVariable

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          String stakeKey,

      @PathVariable

          @Parameter(description = "The hash identifier of the transaction.")

          @LengthValid(CommonConstant.TX_HASH_LENGTH)

          String hash) {

  }

  @GetMapping("/{stakeKey}/wallet-activity")

  @LogMessage

  @Operation(

      summary = "Get wallet activity of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeWalletActivityResponse>> getWalletActivities(

      @PathVariable

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          String stakeKey,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {AddressTxAmount_.BLOCK_TIME},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/{stakeKey}/reward-activity")

  @LogMessage

  @Operation(

      summary = "Get reward activity of stake key",

      tags = {"stake-lifecycle"})

  public ResponseEntity<BaseFilterResponse<StakeRewardActivityResponse>> getRewardActivities(

      @PathVariable

          @Parameter(description = "The Bech32 encoded version of the stake address.")

          @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

          @StakeKeyLengthValid

          String stakeKey,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {"time"},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

}

Mutations