@@ -78,6 +78,47 @@ components:
7878 - peginLiquidityAmount
7979 - pegoutLiquidityAmount
8080 type : object
81+ BtcAssetAllocationDTO :
82+ properties :
83+ available :
84+ description : BTC available for new pegout quotes
85+ example : " 43200000"
86+ reservedForUsers :
87+ description : BTC reserved for users (accepted pegout quotes)
88+ example : " 4500000"
89+ waitingForRefund :
90+ description : BTC waiting to be refunded to the LP
91+ example : " 19800000"
92+ type : object
93+ BtcAssetLocationDTO :
94+ properties :
95+ btcWallet :
96+ description : BTC in the LP's Bitcoin wallet
97+ example : " 50000000"
98+ federation :
99+ description : BTC in the federation (rebalancing or waiting for refund)
100+ example : " 5000000"
101+ lbc :
102+ description : BTC represented as RBTC locked in the Liquidity Bridge Contract
103+ example : " 5300000"
104+ rskWallet :
105+ description : BTC represented as RBTC in the RSK wallet (waiting for rebalancing)
106+ example : " 6500000"
107+ type : object
108+ BtcAssetReportDTO :
109+ properties :
110+ allocation :
111+ $ref : ' #/components/schemas/BtcAssetAllocationDTO'
112+ description : BTC allocation by usage/purpose
113+ type : object
114+ location :
115+ $ref : ' #/components/schemas/BtcAssetLocationDTO'
116+ description : BTC distribution across different locations
117+ type : object
118+ total :
119+ description : Total BTC assets under LP control
120+ example : " 67500000"
121+ type : object
81122 ChangeStatusRequest :
82123 properties :
83124 status :
@@ -123,6 +164,17 @@ components:
123164 $ref : ' #/components/schemas/GeneralConfigurationDTO'
124165 type : object
125166 type : object
167+ GetAssetsReportResponse :
168+ properties :
169+ btcAssetReport :
170+ $ref : ' #/components/schemas/BtcAssetReportDTO'
171+ description : Detailed BTC asset report
172+ type : object
173+ rbtcAssetReport :
174+ $ref : ' #/components/schemas/RbtcAssetReportDTO'
175+ description : Detailed RBTC asset report
176+ type : object
177+ type : object
126178 GetCollateralResponse :
127179 properties :
128180 collateral :
@@ -306,6 +358,9 @@ components:
306358 description : A boolean value indicating whether the callForUser can be called
307359 on registerPegIn
308360 type : boolean
361+ chainId :
362+ description : Chain ID of the RSK network where the quote is valid
363+ type : integer
309364 confirmations :
310365 description : The number of confirmations that the LP requires before making
311366 the call
@@ -322,7 +377,7 @@ components:
322377 gasFee :
323378 $ref : ' #/components/schemas/'
324379 description : Fee to pay for the gas of every call done during the pegin
325- (call on behalf of the user and call to the dao fee collector )
380+ (call on behalf of the user)
326381 gasLimit :
327382 description : The gas limit
328383 type : integer
@@ -346,9 +401,6 @@ components:
346401 $ref : ' #/components/schemas/'
347402 description : The penalty fee that the LP pays if it fails to deliver the
348403 service
349- productFeeAmount :
350- $ref : ' #/components/schemas/'
351- description : The DAO Fee amount
352404 rskRefundAddr :
353405 description : A User RSK refund address
354406 type : string
@@ -379,7 +431,7 @@ components:
379431 - confirmations
380432 - callOnRegister
381433 - gasFee
382- - productFeeAmount
434+ - chainId
383435 type : object
384436 PeginQuoteRequest :
385437 properties :
@@ -478,6 +530,9 @@ components:
478530 type : string
479531 callFee :
480532 $ref : ' #/components/schemas/'
533+ chainId :
534+ description : Chain ID of the RSK network where the quote is valid
535+ type : integer
481536 depositAddr :
482537 type : string
483538 depositConfirmations :
@@ -491,8 +546,7 @@ components:
491546 gasFee :
492547 $ref : ' #/components/schemas/'
493548 description : Fee to pay for the gas of every call done during the pegout
494- (call on behalf of the user in Bitcoin network and call to the dao fee
495- collector in Rootstock)
549+ (call on behalf of the user in Bitcoin network)
496550 lbcAddress :
497551 type : string
498552 liquidityProviderRskAddress :
@@ -503,9 +557,6 @@ components:
503557 type : integer
504558 penaltyFee :
505559 $ref : ' #/components/schemas/'
506- productFeeAmount :
507- $ref : ' #/components/schemas/'
508- description : The DAO fee amount
509560 rskRefundAddress :
510561 type : string
511562 transferConfirmations :
@@ -533,7 +584,7 @@ components:
533584 - expireDate
534585 - expireBlocks
535586 - gasFee
536- - productFeeAmount
587+ - chainId
537588 type : object
538589 PegoutQuoteRequest :
539590 properties :
@@ -612,6 +663,44 @@ components:
612663 - pegin
613664 - pegout
614665 type : object
666+ RbtcAssetAllocationDTO :
667+ properties :
668+ available :
669+ description : RBTC available for new pegin quotes
670+ example : " 12000000000000000000"
671+ reservedForUsers :
672+ description : RBTC reserved for users (accepted pegin quotes)
673+ example : " 3000000000000000000"
674+ waitingForRefund :
675+ description : RBTC waiting to be refunded to the LP
676+ example : " 2000000000000000000"
677+ type : object
678+ RbtcAssetLocationDTO :
679+ properties :
680+ federation :
681+ description : RBTC in the federation (waiting for refund)
682+ example : " 2000000000000000000"
683+ lbc :
684+ description : RBTC locked in the Liquidity Bridge Contract
685+ example : " 5000000000000000000"
686+ rskWallet :
687+ description : RBTC in the LP's RSK wallet
688+ example : " 10000000000000000000"
689+ type : object
690+ RbtcAssetReportDTO :
691+ properties :
692+ allocation :
693+ $ref : ' #/components/schemas/RbtcAssetAllocationDTO'
694+ description : RBTC allocation by usage/purpose
695+ type : object
696+ location :
697+ $ref : ' #/components/schemas/RbtcAssetLocationDTO'
698+ description : RBTC distribution across different locations
699+ type : object
700+ total :
701+ description : Total RBTC assets under LP control
702+ example : " 17000000000000000000"
703+ type : object
615704 RecommendedOperationDTO :
616705 properties :
617706 estimatedCallFee :
@@ -622,18 +711,13 @@ components:
622711 description : Estimated gas fee if a quote is created with the recommended
623712 amount
624713 example : " 100000"
625- estimatedProductFee :
626- description : Estimated product fee if a quote is created with the recommended
627- amount
628- example : " 100000"
629714 recommendedQuoteValue :
630715 description : Recommended quote value for the input amount
631716 example : " 100000"
632717 required :
633718 - recommendedQuoteValue
634719 - estimatedCallFee
635720 - estimatedGasFee
636- - estimatedProductFee
637721 type : object
638722 RetainedPeginQuoteDTO :
639723 properties :
@@ -761,36 +845,6 @@ components:
761845 rsk :
762846 type : string
763847 type : object
764- SummaryDataDTO :
765- properties :
766- acceptedQuotesCount :
767- type : integer
768- lpEarnings :
769- $ref : ' #/components/schemas/'
770- paidQuotesAmount :
771- $ref : ' #/components/schemas/'
772- paidQuotesCount :
773- type : integer
774- refundedQuotesCount :
775- type : integer
776- totalAcceptedQuotedAmount :
777- $ref : ' #/components/schemas/'
778- totalFeesCollected :
779- $ref : ' #/components/schemas/'
780- totalPenaltyAmount :
781- $ref : ' #/components/schemas/'
782- totalQuotesCount :
783- type : integer
784- type : object
785- SummaryResultDTO :
786- properties :
787- peginSummary :
788- $ref : ' #/components/schemas/SummaryDataDTO'
789- type : object
790- pegoutSummary :
791- $ref : ' #/components/schemas/SummaryDataDTO'
792- type : object
793- type : object
794848 TrustedAccountRequest :
795849 properties :
796850 address :
@@ -884,18 +938,13 @@ components:
884938 description : Estimated gas fee if a quote is created with the recommended
885939 amount
886940 example : " 100000"
887- estimatedProductFee :
888- description : Estimated product fee if a quote is created with the recommended
889- amount
890- example : " 100000"
891941 recommendedQuoteValue :
892942 description : Recommended quote value for the input amount
893943 example : " 100000"
894944 required :
895945 - recommendedQuoteValue
896946 - estimatedCallFee
897947 - estimatedGasFee
898- - estimatedProductFee
899948 type : object
900949 pkg.TrustedAccountRequest :
901950 properties :
@@ -1387,10 +1436,15 @@ paths:
13871436 summary : Withdraw PegIn Collateral
13881437 /reports/assets :
13891438 get :
1390- description : ' Get the asset information for the LPS.'
1439+ description : ' Get the asset information for the LPS including BTC and RBTC
1440+ balances, locations, and allocations.'
13911441 responses :
13921442 " 200 " :
1393- description : " "
1443+ content :
1444+ application/json :
1445+ schema :
1446+ $ref : ' #/components/schemas/GetAssetsReportResponse'
1447+ description : Detailed asset report with BTC and RBTC information
13941448 summary : Get asset Reports
13951449 /reports/pegin :
13961450 get :
@@ -1478,32 +1532,33 @@ paths:
14781532 summary : Get revenue Reports
14791533 /reports/summaries :
14801534 get :
1481- description : ' Returns financial data for a given period'
1535+ description : ' Get the summary data for the specified period including total
1536+ quotes, accepted, paid, and refunded statistics.'
14821537 parameters :
1483- - description : Start date in YYYY-MM-DD format
1538+ - description : Start date for the report. Supports YYYY-MM-DD (expands to full
1539+ day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
14841540 in : query
14851541 name : startDate
14861542 required : true
14871543 schema :
1488- description : Start date in YYYY-MM-DD format
1544+ description : Start date for the report. Supports YYYY-MM-DD (expands to
1545+ full day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
14891546 format : string
14901547 type : string
1491- - description : End date in YYYY-MM-DD format
1548+ - description : End date for the report. Supports YYYY-MM-DD (expands to end
1549+ of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
14921550 in : query
14931551 name : endDate
14941552 required : true
14951553 schema :
1496- description : End date in YYYY-MM-DD format
1554+ description : End date for the report. Supports YYYY-MM-DD (expands to end
1555+ of day) or ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)
14971556 format : string
14981557 type : string
14991558 responses :
15001559 " 200 " :
1501- content :
1502- application/json :
1503- schema :
1504- $ref : ' #/components/schemas/SummaryResultDTO'
1505- description : Financial data for the given period
1506- summary : Summaries
1560+ description : " "
1561+ summary : Get summaries Reports
15071562 /reports/transactions :
15081563 get :
15091564 description : ' Get a paginated list of individual transactions of a specific
0 commit comments