chore: Release ATS v3.1.0 (#785)

Signed-off-by: Miguel_LZPF <miguel.carpena@io.builders>
Signed-off-by: mamoralesiob <miguelangel@io.builders>
Co-authored-by: mamoralesiob <miguelangel@io.builders>

Author: MiguelLZPF

.github/workflows/mp.publish.yml

@@ -103,7 +103,7 @@ jobs:
               popd > /dev/null
             fi
           done
-          
+
           # Verify successful packing
           if [ -z "$(ls -A dist-artifacts)" ]; then
              echo "::warning::No public packages were found to pack."

apps/ats/web/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @hashgraph/asset-tokenization-dapp
 
+## 3.1.0
+
+### Patch Changes
+
+- @hashgraph/asset-tokenization-sdk@3.1.0
+
 ## 3.0.0
 
 ### Minor Changes

apps/ats/web/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hashgraph/asset-tokenization-dapp",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "license": "Apache-2.0",
   "scripts": {
     "build": "tsc && vite build",

apps/mass-payout/backend/.env.example

@@ -1,20 +1,32 @@
-NODE_ENV=local
 APP_ENV=local
-LOG_LEVEL=log
 PORT=3000
 POSTGRESQL_HOST=localhost
 POSTGRESQL_PORT=5432
 POSTGRESQL_USER=postgres
 POSTGRESQL_PASSWORD=postgres
 POSTGRESQL_DB=postgres
 BATCH_SIZE=100
-
-# Mainnet
-#BLOCKCHAIN_MIRROR_NODE_URL=https://mainnet-public.mirrornode.hedera.com
-#BLOCKCHAIN_CONTRACT_ID=0.0.456858
-# Testnet
+HEDERA_USDC_ADDRESS=0.0.429274
+ATS_NETWORK=testnet
+ATS_MIRROR_URL=https://testnet.mirrornode.hedera.com/api/v1/
+ATS_RPC_URL=https://testnet.hashio.io/api
+RPC_URL=https://testnet.hashio.io/api
+ATS_FACTORY_ADDRESS='0.0.6224505'
+ATS_RESOLVER_ADDRESS='0.0.6224426'
+#Just in case...
+FACTORY_ADDRESS='0.0.6224505'
+RESOLVER_ADDRESS='0.0.6224426'
+DFNS_SERVICE_ACCOUNT_AUTHORIZATION_TOKEN=
+DFNS_SERVICE_ACCOUNT_PRIVATE_KEY_PATH=
+DFNS_SERVICE_ACCOUNT_CREDENTIAL_ID=
+DFNS_APP_ORIGIN=
+DFNS_APP_ID=
+DFNS_BASE_URL=
+DFNS_WALLET_ID=
+DFNS_WALLET_PUBLIC_KEY=
+DFNS_HEDERA_ACCOUNT_ID=
 BLOCKCHAIN_MIRROR_NODE_URL=https://testnet.mirrornode.hedera.com
 BLOCKCHAIN_CONTRACT_ID=0.0.429274
 BLOCKCHAIN_TOKEN_DECIMALS=6
 BLOCKCHAIN_LISTENER_POLL_TIMEOUT=10000
-BLOCKCHAIN_LISTENER_START_TIMESTAMP=2025-08-26T00:00:00.000Z
+BLOCKCHAIN_LISTENER_START_TIMESTAMP=2025-09-24T15:25:00.000Z

apps/mass-payout/backend/src/domain/model/blockchain-listener.ts

@@ -203,6 +203,7 @@
  */
 
 import { CustomError } from "@domain/errors/shared/custom.error"
+import { ApiProperty } from "@nestjs/swagger"
 
 export interface MirrorNodeLog {
   timestamp: string
@@ -237,9 +238,33 @@ export interface ApprovalEventData extends BlockchainEvent {
 export class BlockchainEventListenerError extends CustomError {}
 
 export class BlockchainEventListenerConfig {
+  @ApiProperty({
+    description: "The id of the event listener config",
+    example: "32264ce1-76fb-44bb-a8a2-d1a516dcf34d",
+  })
   id: string
+
+  @ApiProperty({
+    description: "The Hedera mirror node url",
+    example: "https://testnet.mirrornode.hedera.com/api/v1/",
+  })
   mirrorNodeUrl: string
+
+  @ApiProperty({
+    description: "The payment token Hedera contract Id",
+    example: "0.0.123456",
+  })
   contractId: string
+
+  @ApiProperty({
+    description: "The payment token decimals",
+    example: "2",
+  })
   tokenDecimals: number
+
+  @ApiProperty({
+    description: "The blockchain listener start date",
+    example: "2025-01-15 13:45:30",
+  })
   startTimestamp: string
 }

apps/mass-payout/backend/src/infrastructure/rest/asset/asset.controller.ts

@@ -213,6 +213,7 @@ import { ImportAssetUseCase } from "@application/use-cases/import-asset.use-case
 import { PauseAssetUseCase } from "@application/use-cases/pause-asset.use-case"
 import { UnpauseAssetUseCase } from "@application/use-cases/unpause-asset.use-case"
 import { Body, Get, HttpCode, HttpStatus, Param, Patch, Post, Query } from "@nestjs/common"
+import { ApiOperation, ApiResponse, ApiTags, ApiParam } from "@nestjs/swagger"
 import { DistributionResponse } from "../distribution/distribution.response"
 import { PageOptionsRequest } from "../page-options.request"
 import { PageResponse } from "../page.response"
@@ -224,6 +225,7 @@ import { GetBasicAssetInformationResponse } from "./get-basic-asset-information.
 import { ImportAssetRequest } from "./import-asset.request"
 import { GetDistributionHolderCountUseCase } from "@application/use-cases/get-distribution-holder-count.use-case"
 
+@ApiTags("Assets")
 @RestController("assets")
 export class AssetController {
   constructor(
@@ -240,36 +242,97 @@ export class AssetController {
     private readonly executePayoutUseCase: ExecutePayoutUseCase,
   ) {}
 
+  @ApiOperation({
+    summary: "Import an asset so the payments to its holders are managed by the Scheduler Payment Distribution Service",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 201, type: AssetResponse })
   @Post("import")
   async importAsset(@Body() request: ImportAssetRequest): Promise<AssetResponse> {
     const asset = await this.importAssetUseCase.execute(request.hederaTokenAddress)
     return AssetResponse.fromAsset(asset)
   }
 
+  @ApiOperation({ summary: "Pause the Scheduler Payment Distribution Service for a certain asset." })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to pause.",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({
+    status: 200,
+    description: "The asset LifeCycleCashFlow contract has been successfully paused.",
+  })
   @Patch(":assetId/pause")
   @HttpCode(HttpStatus.OK)
   async pauseAsset(@Param("assetId") assetId: string): Promise<void> {
     await this.pauseAssetUseCase.execute(assetId)
   }
 
+  @ApiOperation({ summary: "Unpause the Scheduler Payment Distribution Service for a certain asset." })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to unpause.",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({
+    status: 200,
+    description: "The asset LifeCycleCashFlow contract has been successfully unpaused.",
+  })
   @Patch(":assetId/unpause")
   @HttpCode(HttpStatus.OK)
   async unpauseAsset(@Param("assetId") assetId: string): Promise<void> {
     await this.unpauseAssetUseCase.execute(assetId)
   }
 
+  @ApiOperation({ summary: "Get the assets list managed by the Scheduler Payment Distribution Service." })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 200, type: PageResponse<AssetResponse> })
   @Get()
   async getAssets(@Query() pageOptions: PageOptionsRequest): Promise<PageResponse<AssetResponse>> {
     const result = await this.getAssetsUseCase.execute(pageOptions.toPageOptions())
     return PageResponse.fromPage(result, AssetResponse.fromAsset)
   }
 
+  @ApiOperation({ summary: "Get a certain asset managed by the Scheduler Payment Distribution Service." })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to unpause.",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 200, type: AssetResponse })
   @Get(":assetId")
   async getAsset(@Param("assetId") assetId: string): Promise<AssetResponse> {
     const asset = await this.getAssetUseCase.execute(assetId)
     return AssetResponse.fromAsset(asset)
   }
 
+  @ApiOperation({
+    summary: "Get the basic information of a certain asset managed by the Scheduler Payment Distribution Service.",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 200, type: GetBasicAssetInformationResponse })
   @Get(":hederaTokenAddress/metadata")
   async getBasicAssetInformation(
     @Param() request: GetBasicAssetInformationRequest,
@@ -284,6 +347,19 @@ export class AssetController {
     )
   }
 
+  @ApiOperation({
+    summary: "Get distributions information of a certain asset managed by the Scheduler Payment Distribution Service.",
+  })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to get its distributions information.",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 200, type: PageResponse<DistributionResponse> })
   @Get(":assetId/distributions")
   async getAssetDistributions(
     @Param("assetId") assetId: string,
@@ -299,6 +375,20 @@ export class AssetController {
     return distributions
   }
 
+  @ApiOperation({ summary: "Create a batch payout." })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to create a batch payout for",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({
+    status: 201,
+    description: "The asset payout has been successfully created.",
+  })
   @Post(":assetId/distributions/payout")
   @HttpCode(HttpStatus.CREATED)
   async createPayout(@Param("assetId") assetId: string, @Body() request: CreatePayoutRequest): Promise<void> {
@@ -313,13 +403,35 @@ export class AssetController {
     })
   }
 
+  @ApiOperation({ summary: "Enable the asset synchronization." })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to enable the sync.",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 200, type: AssetResponse })
   @Patch(":assetId/enable-sync")
   @HttpCode(HttpStatus.OK)
   async enableAssetSync(@Param("assetId") assetId: string): Promise<AssetResponse> {
     const asset = await this.enableAssetSyncUseCase.execute(assetId)
     return AssetResponse.fromAsset(asset)
   }
 
+  @ApiOperation({ summary: "Disable the asset synchronization." })
+  @ApiParam({
+    name: "assetId",
+    description: "The ID of the asset to disable the sync.",
+    example: "0.0.123456",
+  })
+  @ApiResponse({ status: 500, description: "Internal server error" })
+  @ApiResponse({ status: 400, description: "Bad Request" })
+  @ApiResponse({ status: 401, description: "Unauthorized" })
+  @ApiResponse({ status: 404, description: "Not Found" })
+  @ApiResponse({ status: 200, type: AssetResponse })
   @Patch(":assetId/disable-sync")
   @HttpCode(HttpStatus.OK)
   async disableAssetSync(@Param("assetId") assetId: string): Promise<AssetResponse> {

apps/mass-payout/backend/src/infrastructure/rest/asset/asset.response.ts

@@ -203,20 +203,88 @@
  */
 
 import { Asset } from "@domain/model/asset"
+import { ApiProperty } from "@nestjs/swagger"
 
 export class AssetResponse {
+  @ApiProperty({
+    description: "The id of the asset in the service",
+    example: "32264ce1-76fb-44bb-a8a2-d1a516dcf34d",
+  })
   id: string
+
+  @ApiProperty({
+    description: "The name of the asset",
+    example: "Sella River Clean",
+  })
   name: string
+
+  @ApiProperty({
+    description: "The type of the asset",
+    example: "BOND | EQUITY",
+  })
   type: string
+
+  @ApiProperty({
+    description: "The asset Hedera token contract Id",
+    example: "0.0.123456",
+  })
   hederaTokenAddress: string
+
+  @ApiProperty({
+    description: "The EVM address of the asset Hedera token contract",
+    example: "0x0123456789abcdef0123456789abcdef01234567",
+  })
   evmTokenAddress: string
+
+  @ApiProperty({
+    description: "The symbol of the asset",
+    example: "SRC",
+  })
   symbol: string
+
+  @ApiProperty({
+    description: "The LifeCycleCashFlow Hedera contract Id",
+    example: "0.0.123456",
+    required: false,
+  })
   lifeCycleCashFlowHederaAddress?: string
+
+  @ApiProperty({
+    description: "The EVM address of the LifeCycleCashFlow Hedera contract",
+    example: "0x0123456789abcdef0123456789abcdef01234567",
+    required: false,
+  })
   lifeCycleCashFlowEvmAddress?: string
+
+  @ApiProperty({
+    description: "The asset maturity date",
+    example: "2025-01-15 13:45:30",
+    required: false,
+  })
   maturityDate?: Date
+
+  @ApiProperty({
+    description: "Whether the asset is paused",
+    example: "true | false",
+  })
   isPaused: boolean
+
+  @ApiProperty({
+    description: "Whether the asset sync is enabled",
+    example: "true | false",
+  })
   syncEnabled: boolean
+
+  @ApiProperty({
+    description: "The asset creation date in the service",
+    example: "2025-01-15 13:45:30",
+  })
   createdAt: Date
+
+  @ApiProperty({
+    description: "The asset update date in the service",
+    example: "2025-01-15 13:45:30",
+  })
   updatedAt: Date
 
   static fromAsset(asset: Asset): AssetResponse {