From 7237af7152cb6290eae265aae2b99c02b3a2f698 Mon Sep 17 00:00:00 2001
From: Cardano Wallet Documentation Bot <adrestia@cardano-foundation.io>
Date: Thu, 8 Aug 2024 10:35:20 +0000
Subject: [PATCH] =?UTF-8?q?docs:=20[ADP-3270]=20Support=20key=20deposit=20?=
 =?UTF-8?q?refund=20lookup=20in=20`Write.balanceTx`=20&=20new=20tx=20workf?=
 =?UTF-8?q?low=20(#4690)=20-=20[x]=20Add=20new=20`PartialTx`=20field=20`ke?=
 =?UTF-8?q?yDeposits`=20for=20looking=20up=20stake=20key=20UnReg=20refunds?=
 =?UTF-8?q?=20-=20This=20allows=20us=20to=20stop=20assuming=20the=20deposi?=
 =?UTF-8?q?ted=20amount=20equals=20the=20`ppKeyDeposit`=20value=20of=20the?=
 =?UTF-8?q?=20current=20protocol=20parameters.=20-=20[x]=20Test=20that=20`?=
 =?UTF-8?q?Write.balanceTx`=20takes=20it=20into=20account=20-=20[x]=20Quer?=
 =?UTF-8?q?y=20deposit=20amounts=20with=20LSQ=20for=20the=20new=20tx=20wor?=
 =?UTF-8?q?kflow=20(construct,=20construct-shared,=20balance)=20###=20For?=
 =?UTF-8?q?=20later=20-=20Query=20deposit=20amounts=20for=20the=20old=20tx?=
 =?UTF-8?q?=20workflow=20-=20Improve=20the=20internals=20of=20`Write.balan?=
 =?UTF-8?q?ceTx`.=20This=20PR=20muddies=20the=20point=20of=20`TxWithUTxO`?=
 =?UTF-8?q?=20and=20the=20distinction=20between=20`balanceTx`=20and=20`bal?=
 =?UTF-8?q?anceTxInner`.=20We=20could=20imagine=20a=20new=20type=20```hask?=
 =?UTF-8?q?ell=20--=20|=20Tx=20with=20enough=20additional=20context=20to?=
 =?UTF-8?q?=20evaluate=20it's=20balance=20etc=20(may=20or=20may=20not=20in?=
 =?UTF-8?q?clude=20PParams)=20data=20TxWithContext=20evaluateBalanceAfterS?=
 =?UTF-8?q?ettingMinFee=20::=20TxWithContext=20->=20(Value,=20Coin,=20KeyW?=
 =?UTF-8?q?itnessCounts)=20balance=20::=20TxWithContext=20->=20Value=20--?=
 =?UTF-8?q?=20|=20Will=20also=20modify=20the=20UTxO=20applySelection=20::?=
 =?UTF-8?q?=20TxWithContext=20->=20SelectAssetsResult=20->=20TxWithContext?=
 =?UTF-8?q?=20```=20where=20we'd=20let=20`balanceTxInner`=20take=20`TxWith?=
 =?UTF-8?q?Context`=20instead=20of=20`Tx`=20+=20related=20args.=20However,?=
 =?UTF-8?q?=20we'd=20either=20need=20to=20include=20the=20entire=20`refere?=
 =?UTF-8?q?nceUTxO`=20(`extraUTxO=20<>=20walletUTxO`)=20in=20the=20`utxo`?=
 =?UTF-8?q?=20of=20the=20`TxWithContext`=20and=20later=20trust=20that=20th?=
 =?UTF-8?q?e=20inputs=20from=20the=20`SelectAssetsResult`=20can=20be=20res?=
 =?UTF-8?q?olved,=20or=20we'd=20need=20to=20do=20something=20else...=20The?=
 =?UTF-8?q?=20relationship=20of=20`PartialTx`=20with=20a=20new=20`TxWithCo?=
 =?UTF-8?q?ntext`=20may=20also=20be=20awkward,=20as=20they=20would=20be=20?=
 =?UTF-8?q?almost=20=E2=80=94=20but=20not=20quite=20=E2=80=94=20the=20same?=
 =?UTF-8?q?.=20E.g.=20`PartialTx`=20contains=20a=20`redeemers`=20field.=20?=
 =?UTF-8?q?###=20Comments=20<!--=20Additional=20comments,=20links,=20or=20?=
 =?UTF-8?q?screenshots=20to=20attach,=20if=20any.=20-->=20###=20Issue=20Nu?=
 =?UTF-8?q?mber=20ADP-3270=20Source=20commit:=2017cc50f6c42aca009fcb554622?=
 =?UTF-8?q?73abeffec3f08b?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 api/edge/swagger.yaml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/api/edge/swagger.yaml b/api/edge/swagger.yaml
index b6e6aaad64c..f93466ccabc 100644
--- a/api/edge/swagger.yaml
+++ b/api/edge/swagger.yaml
@@ -5609,6 +5609,19 @@ x-errUnresolvedInputs: &errUnresolvedInputs
       type: string
       enum: ['unknown_inputs']
 
+x-errUnresolvedRefunds: &errUnresolvedRefunds
+  <<: *responsesErr
+  title: unresolved_refunds
+  properties:
+    message:
+      type: string
+      description: |
+        There are stake key deregistration certificates in the transaction for which corresponding
+        deposit amounts could not be found.
+    code:
+      type: string
+      enum: ['unresolved_refunds']
+
 x-errRedeemerInvalidData: &errRedeemerInvalidData
   <<: *responsesErr
   title: redeemer_invalid_data