StakeKeyReportController.java

package org.cardanofoundation.explorer.api.controller;

import jakarta.validation.Valid;

import lombok.RequiredArgsConstructor;

import org.springframework.core.io.InputStreamResource;

import org.springframework.core.io.Resource;

import org.springframework.data.domain.Sort;

import org.springframework.http.HttpHeaders;

import org.springframework.http.MediaType;

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.PostMapping;

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

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

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.common.enumeration.ExportType;

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

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

import org.cardanofoundation.explorer.api.interceptor.auth.UserPrincipal;

import org.cardanofoundation.explorer.api.model.request.stake.report.ReportHistoryFilterRequest;

import org.cardanofoundation.explorer.api.model.request.stake.report.StakeKeyReportRequest;

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

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

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

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

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

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

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

import org.cardanofoundation.explorer.api.model.response.stake.report.ReportHistoryResponse;

import org.cardanofoundation.explorer.api.model.response.stake.report.StakeKeyReportHistoryResponse;

import org.cardanofoundation.explorer.api.model.response.stake.report.StakeKeyReportResponse;

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

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

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/staking-lifecycle/report")

@Validated

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

public class StakeKeyReportController {

  private final StakeKeyReportService stakeKeyReportService;

  private final ReportHistoryService reportHistoryService;

  @PostMapping(value = "/stake-key")

  @LogMessage

  @Operation(summary = "Generate stake key report")

  public ResponseEntity<StakeKeyReportHistoryResponse> generateStakeKeyReport(

      @RequestAttribute("user") UserPrincipal userPrincipal,

      @RequestBody StakeKeyReportRequest stakeKeyReportRequest) {

  }

  @GetMapping(value = "/stake-key/{reportId}/export")

  @LogMessage

  @Operation(summary = "Export stake key report by id")

  public ResponseEntity<Resource> exportStakeKeyReportByStorageKey(

      @RequestAttribute("user") UserPrincipal userPrincipal,

      @PathVariable @Parameter(description = "The identifier of report") Long reportId,

      @RequestParam(required = false) @Parameter(description = "Type for export")

          ExportType exportType) {

            HttpHeaders.CONTENT_DISPOSITION,

  }

  @GetMapping(value = "/stake-key/{stakeKey}/history")

  @LogMessage

  @Operation(summary = "Get stake key report history by stake key")

  public ResponseEntity<BaseFilterResponse<StakeKeyReportHistoryResponse>>

      getStakeReportHistoryByStakeKey(

          @RequestAttribute("user") UserPrincipal userPrincipal,

          @PathVariable

              @PrefixedValid(CommonConstant.PREFIXED_STAKE_KEY)

              @StakeKeyLengthValid

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

              String stakeKey,

          @ParameterObject @PaginationValid @Valid Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/detail")

  @LogMessage

  @Operation(summary = "Get stake key report detail by report id")

  public ResponseEntity<StakeKeyReportHistoryResponse> getStakeReportDetail(

      @RequestAttribute("user") UserPrincipal userPrincipal,

      @PathVariable @Parameter(description = "The identifier of report") Long reportId) {

  }

  @GetMapping(value = "/stake-key/history")

  @LogMessage

  @Operation(summary = "Get all stake key report history")

  public ResponseEntity<BaseFilterResponse<StakeKeyReportHistoryResponse>> getStakeReportHistory(

      @RequestAttribute("user") UserPrincipal userPrincipal,

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

          ReportHistoryFilterRequest filterRequest,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {"id"},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping(value = "/dashboard")

  @LogMessage

  @Operation(summary = "Get report history of stake key and pool id")

  public ResponseEntity<BaseFilterResponse<ReportHistoryResponse>> getReportHistory(

      @RequestAttribute("user") UserPrincipal userPrincipal,

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

          ReportHistoryFilterRequest filterRequest,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {"createdAt"},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/registrations")

  @LogMessage

  @Operation(summary = "Get stake registrations by report id")

  public ResponseEntity<BaseFilterResponse<StakeRegistrationFilterResponse>>

      getStakeKeyRegistrationsByReportId(

          @RequestAttribute("user") UserPrincipal userPrincipal,

          @PathVariable @Parameter(description = "The identifier of report") Long reportId,

          @ParameterObject

              @PaginationValid

              @PaginationDefault(

                  size = 20,

                  sort = {"time"},

                  direction = Sort.Direction.DESC)

              @Valid

              Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/de-registrations")

  @LogMessage

  @Operation(summary = "Get stake deregistrations by report id")

  public ResponseEntity<BaseFilterResponse<StakeRegistrationFilterResponse>>

      getStakeKeyDeregistrationsByReportId(

          @RequestAttribute("user") UserPrincipal userPrincipal,

          @PathVariable @Parameter(description = "The identifier of report") Long reportId,

          @ParameterObject

              @PaginationValid

              @PaginationDefault(

                  size = 20,

                  sort = {"time"},

                  direction = Sort.Direction.DESC)

              @Valid

              Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/delegations")

  @LogMessage

  @Operation(summary = "Get stake delegations by report id")

  public ResponseEntity<BaseFilterResponse<StakeDelegationFilterResponse>>

      getStakeKeyDelegationsByReportId(

          @RequestAttribute("user") UserPrincipal userPrincipal,

          @PathVariable @Parameter(description = "The identifier of report") Long reportId,

          @ParameterObject

              @PaginationValid

              @PaginationDefault(

                  size = 20,

                  sort = {"time"},

                  direction = Sort.Direction.DESC)

              @Valid

              Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/rewards")

  @LogMessage

  @Operation(summary = "Get stake rewards by report id")

  public ResponseEntity<BaseFilterResponse<StakeRewardResponse>> getStakeKeyRewardsByReportId(

      @RequestAttribute("user") UserPrincipal userPrincipal,

      @PathVariable @Parameter(description = "The identifier of report") Long reportId,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {"id"},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/withdrawals")

  @LogMessage

  @Operation(summary = "Get stake withdrawals by report id")

  public ResponseEntity<BaseFilterResponse<StakeWithdrawalFilterResponse>>

      getStakeKeyWithdrawalsByReportId(

          @RequestAttribute("user") UserPrincipal userPrincipal,

          @PathVariable @Parameter(description = "The identifier of report") Long reportId,

          @ParameterObject

              @PaginationValid

              @PaginationDefault(

                  size = 20,

                  sort = {"time"},

                  direction = Sort.Direction.DESC)

              @Valid

              Pagination pagination) {

  }

  @GetMapping(value = "/stake-key/{reportId}/wallet-activity")

  @LogMessage

  @Operation(summary = "Get wallet activity by report id")

  public ResponseEntity<BaseFilterResponse<StakeWalletActivityResponse>>

      getWalletActivityByReportId(

          @RequestAttribute("user") UserPrincipal userPrincipal,

          @PathVariable @Parameter(description = "The identifier of report") Long reportId,

          @ParameterObject

              @PaginationValid

              @PaginationDefault(

                  size = 20,

                  sort = {"time"},

                  direction = Sort.Direction.DESC)

              @Valid

              Pagination pagination) {

  }

  @GetMapping(value = "/report-limit")

  @LogMessage

  @Operation(summary = "Get report limit information")

  public ResponseEntity<ReportLimitResponse> getReportLimit(

      @RequestAttribute("user") UserPrincipal userPrincipal) {

  }

}

Mutations