AddressController.java

package org.cardanofoundation.explorer.api.controller;

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

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.enumeration.AnalyticType;

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

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

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

import org.cardanofoundation.explorer.api.model.response.address.AddressChartBalanceResponse;

import org.cardanofoundation.explorer.api.model.response.address.AddressResponse;

import org.cardanofoundation.explorer.api.model.response.token.TokenAddressResponse;

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

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

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

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

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

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

@RestController

@RequestMapping("/api/v1/addresses")

@Validated

@Tag(name = "address", description = "The address APIs")

public class AddressController {

  private final AddressService addressService;

  private final TxService txService;

  @GetMapping("/{address}")

  @LogMessage

  @Operation(

      summary = "Get detail information of payment address",

      description =

          "Get detail information of payment address with balance, txs, token and check contract",

      tags = {"address"})

  public ResponseEntity<AddressResponse> getAddressDetail(

      @PathVariable

          @Parameter(

              description =

                  "The human readable encoding of the output address."

                      + " Will be Base58 for Byron era addresses and Bech32 for Shelley era.")

          String address) {

  }

  @GetMapping("/analytics/{address}/{type}")

  @LogMessage

  @Operation(

      summary = "Get analytics of address",

      description = "Get analytics balance of address and time type",

      tags = {"address"})

  public ResponseEntity<AddressChartBalanceResponse> getAddressAnalytics(

      @PathVariable

          @Parameter(

              description =

                  "The human readable encoding of the output address."

                      + " Will be Base58 for Byron era addresses and Bech32 for Shelley era.")

          String address,

      @PathVariable @Parameter(description = "Type for analytics by time") AnalyticType type) {

  }

  @GetMapping("/{address}/txs")

  @LogMessage

  @Operation(

      summary = "Get list transaction by address",

      tags = {"address"})

  public ResponseEntity<BaseFilterResponse<TxFilterResponse>> getTransactions(

      @PathVariable

          @Parameter(

              description =

                  "The human readable encoding of the output address."

                      + " Will be Base58 for Byron era addresses and Bech32 for Shelley era.")

          String address,

      @ParameterObject

          @PaginationDefault(

              size = 20,

              sort = {AddressTxAmount_.SLOT},

              direction = Sort.Direction.DESC)

          @PaginationValid

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/{address}/tokens")

  @LogMessage

  @Operation(

      summary = "Get list token by address",

      description =

          "Get list token by address with search by display name, will return all token if display name is null or empty",

      tags = {"address"})

  public ResponseEntity<BaseFilterResponse<TokenAddressResponse>> getTokenByAddress(

      @PathVariable

          @Parameter(

              description =

                  "The human readable encoding of the output address."

                      + " Will be Base58 for Byron era addresses and Bech32 for Shelley era.")

          String address,

      @RequestParam(required = false) @Parameter(description = "Display name query for search")

          String displayName,

      @ParameterObject @PaginationValid @Valid Pagination pagination) {

  }

}

Mutations