Merge pull request #11239 from hassnian/issue-11237

fix: Misleading `Withdraw Amount` wording in Offers
kodadot · Dec 16, 2024 · 8f84816 · 8f84816
2 parents 80509dd + ea37970
commit 8f84816
Show file tree

Hide file tree

Showing 11 changed files with 72 additions and 68 deletions.
diff --git a/components/trade/TradeOwnerButton.vue b/components/trade/TradeOwnerButton.vue
@@ -21,20 +21,22 @@ const onClick = () => emit('click', props.trade)
 
 const details = {
   [TradeType.SWAP]: {
-    cancel: 'transaction.withdrawSwap',
+    cancel: 'transaction.cancelSwap',
     accept: 'transaction.acceptSwap',
+    withdraw: 'swap.withdrawSwap',
   },
   [TradeType.OFFER]: {
-    cancel: 'transaction.withdrawOffer',
+    cancel: 'transaction.cancelOffer',
     accept: 'transaction.acceptOffer',
+    withdraw: 'offer.withdrawOffer',
   },
 }
 
 const buttonConfig = computed<ButtonConfig | null>(() => {
   if (props.trade.status === 'EXPIRED') {
     return isCreatorOfTrade.value
       ? {
-          label: $i18n.t('offer.withdrawAmount'),
+          label: $i18n.t(details[props.trade.type].withdraw),
           onClick,
         }
       : null

diff --git a/components/trade/overviewModal/TradeOverviewModal.vue b/components/trade/overviewModal/TradeOverviewModal.vue
@@ -104,8 +104,8 @@ const TradeTypeOverviewModeDetails: Record<TradeType, Record<OverviewMode, Overv
     },
     owner: {
       title: $i18n.t('swap.yourSwap'),
-      signingTitle: $i18n.t('transaction.withdrawSwap'),
-      notificationTitle: $i18n.t('swap.swapWithdrawl'),
+      signingTitle: $i18n.t('transaction.cancelSwap'),
+      notificationTitle: $i18n.t('swap.swapCancellation'),
     },
   },
   [TradeType.OFFER]: {
@@ -116,8 +116,8 @@ const TradeTypeOverviewModeDetails: Record<TradeType, Record<OverviewMode, Overv
     },
     owner: {
       title: $i18n.t('offer.yourOffer'),
-      signingTitle: $i18n.t('transaction.withdrawOffer'),
-      notificationTitle: $i18n.t('offer.offerWithdrawl'),
+      signingTitle: $i18n.t('transaction.cancelOffer'),
+      notificationTitle: $i18n.t('offer.offerCancellation'),
     },
   },
 }
@@ -137,7 +137,7 @@ const TradeTypeTx: Record<TradeType, Record<OverviewMode, (params: ExecTxParams)
   [TradeType.SWAP]: {
     owner: ({ offered }) => {
       transaction({
-        interaction: ShoppingActions.WITHDRAW_SWAP,
+        interaction: ShoppingActions.CANCEL_SWAP,
         urlPrefix: urlPrefix.value,
         offeredId: offered.sn,
         offeredCollectionId: offered.collection.id,
@@ -159,7 +159,7 @@ const TradeTypeTx: Record<TradeType, Record<OverviewMode, (params: ExecTxParams)
   [TradeType.OFFER]: {
     owner: ({ offered }) => {
       transaction({
-        interaction: ShoppingActions.WITHDRAW_OFFER,
+        interaction: ShoppingActions.CANCEL_OFFER,
         urlPrefix: urlPrefix.value,
         offeredId: offered.sn,
       })

diff --git a/composables/transaction/transactionOfferCancel.ts b/composables/transaction/transactionOfferCancel.ts
@@ -0,0 +1,18 @@
+import type { ApiPromise } from '@polkadot/api'
+import type { ActionCancelOffer } from './types'
+import { getOfferCollectionId } from './transactionOffer'
+
+async function execCancelOfferAssetHub(item: ActionCancelOffer, api: ApiPromise, executeTransaction) {
+  executeTransaction({
+    cb: api.tx.nfts.cancelSwap,
+    arg: [getOfferCollectionId(item.urlPrefix), Number(item.offeredId)],
+    successMessage: item.successMessage,
+    errorMessage: item.errorMessage,
+  })
+}
+
+export async function execCancelOffer(item: ActionCancelOffer, api, executeTransaction) {
+  if (isAssetHub(item.urlPrefix)) {
+    await execCancelOfferAssetHub(item, api, executeTransaction)
+  }
+}
diff --git a/composables/transaction/transactionOfferWithdraw.ts b/composables/transaction/transactionOfferWithdraw.ts
diff --git a/composables/transaction/transactionSwapCancel.ts b/composables/transaction/transactionSwapCancel.ts
@@ -0,0 +1,17 @@
+import type { ApiPromise } from '@polkadot/api'
+import type { ActionCancelSwap } from './types'
+
+async function execCancelSwapAssetHub(item: ActionCancelSwap, api: ApiPromise, executeTransaction) {
+  executeTransaction({
+    cb: api.tx.nfts.cancelSwap,
+    arg: [Number(item.offeredCollectionId), Number(item.offeredId)],
+    successMessage: item.successMessage,
+    errorMessage: item.errorMessage,
+  })
+}
+
+export async function execCancelSwap(item: ActionCancelSwap, api: ApiPromise, executeTransaction) {
+  if (isAssetHub(item.urlPrefix)) {
+    await execCancelSwapAssetHub(item, api, executeTransaction)
+  }
+}
diff --git a/composables/transaction/transactionSwapWithdraw.ts b/composables/transaction/transactionSwapWithdraw.ts
diff --git a/composables/transaction/types.ts b/composables/transaction/types.ts
@@ -210,8 +210,8 @@ export type ActionSwap = {
   errorMessage?: string
 }
 
-export type ActionWithdrawOffer = {
-  interaction: typeof ShoppingActions.WITHDRAW_OFFER
+export type ActionCancelOffer = {
+  interaction: typeof ShoppingActions.CANCEL_OFFER
   urlPrefix: Prefix
   offeredId: string
   successMessage?: string
@@ -229,8 +229,8 @@ export type ActionAcceptOffer = {
   errorMessage?: string
 }
 
-export type ActionWithdrawSwap = {
-  interaction: typeof ShoppingActions.WITHDRAW_SWAP
+export type ActionCancelSwap = {
+  interaction: typeof ShoppingActions.CANCEL_SWAP
   urlPrefix: Prefix
   offeredId: string
   offeredCollectionId: string
@@ -339,9 +339,9 @@ export type Actions =
   | ActionSend
   | ActionOffer
   | ActionConsume
-  | ActionWithdrawSwap
+  | ActionCancelSwap
   | ActionAcceptSwap
-  | ActionWithdrawOffer
+  | ActionCancelOffer
   | ActionAcceptOffer
   | ActionMintToken
   | ActionMintCollection

diff --git a/composables/transaction/utils.ts b/composables/transaction/utils.ts
@@ -18,9 +18,9 @@ import type {
   ActionSwap,
   ActionSend,
   ActionUpdateCollection,
-  ActionWithdrawOffer,
+  ActionCancelOffer,
   ActionSetNftMetadata,
-  ActionWithdrawSwap,
+  ActionCancelSwap,
   ActionAcceptSwap,
   Actions,
 } from '../transaction/types'
@@ -53,9 +53,9 @@ export function isActionValid(action: Actions): boolean {
     [Interaction.CONSUME]: (action: ActionConsume) => hasContent(action.nftIds),
     [ShoppingActions.MAKE_OFFER]: (action: ActionOffer) =>
       hasContent(action.token),
-    [ShoppingActions.WITHDRAW_OFFER]: (action: ActionWithdrawOffer) =>
+    [ShoppingActions.CANCEL_OFFER]: (action: ActionCancelOffer) =>
       Boolean(action.offeredId),
-    [ShoppingActions.WITHDRAW_SWAP]: (action: ActionWithdrawSwap) =>
+    [ShoppingActions.CANCEL_SWAP]: (action: ActionCancelSwap) =>
       Boolean(action.offeredId) && Boolean(action.offeredCollectionId),
     [ShoppingActions.ACCEPT_SWAP]: (action: ActionAcceptSwap) =>
       Boolean(action.receiveItem) && Boolean(action.receiveCollection) && Boolean(action.sendItem) && Boolean(action.sendCollection),

diff --git a/composables/useTransaction.ts b/composables/useTransaction.ts
@@ -9,9 +9,9 @@ import {
   execBurnCollection,
   execBurn,
 } from './transaction/transactionBurn'
-import { execWithdrawSwap } from './transaction/transactionSwapWithdraw'
+import { execCancelSwap } from './transaction/transactionSwapCancel'
 import { execAcceptSwap } from './transaction/transactionSwapAccept'
-import { execWithdrawOfferTx } from './transaction/transactionOfferWithdraw'
+import { execCancelOffer } from './transaction/transactionOfferCancel'
 import { execAcceptOfferTx } from './transaction/transactionOfferAccept'
 import { execMakingOfferTx } from './transaction/transactionOffer'
 import { execCreateSwap } from './transaction/transactionCreateSwap'
@@ -33,13 +33,13 @@ import type {
   ActionSend,
   ActionUpdateCollection,
   ActionSetNftMetadata,
-  ActionWithdrawOffer,
+  ActionCancelOffer,
   Actions,
   ExecuteEvmTransactionParams,
   ExecuteSubstrateTransactionParams,
   ExecuteTransactionParams,
   ObjectMessage,
-  ActionWithdrawSwap,
+  ActionCancelSwap,
   ActionAcceptSwap,
 } from './transaction/types'
 import { Collections, NFTs } from './transaction/types'
@@ -231,12 +231,12 @@ export const executeAction = ({
       execSendTx(item as ActionSend, api, executeTransaction),
     [ShoppingActions.CONSUME]: () =>
       execBurn(item as ActionConsume, api, executeTransaction),
-    [ShoppingActions.WITHDRAW_SWAP]: () =>
-      execWithdrawSwap(item as ActionWithdrawSwap, api!, executeTransaction),
+    [ShoppingActions.CANCEL_SWAP]: () =>
+      execCancelSwap(item as ActionCancelSwap, api!, executeTransaction),
     [ShoppingActions.ACCEPT_SWAP]: () =>
       execAcceptSwap(item as ActionAcceptSwap, api!, executeTransaction),
-    [ShoppingActions.WITHDRAW_OFFER]: () =>
-      execWithdrawOfferTx(item as ActionWithdrawOffer, api, executeTransaction),
+    [ShoppingActions.CANCEL_OFFER]: () =>
+      execCancelOffer(item as ActionCancelOffer, api, executeTransaction),
     [ShoppingActions.ACCEPT_OFFER]: () =>
       execAcceptOfferTx(item as ActionAcceptOffer, api, executeTransaction),
     [ShoppingActions.MAKE_OFFER]: () =>

diff --git a/locales/en.json b/locales/en.json
@@ -1515,11 +1515,12 @@
     "manageOffers": "Manage Offers",
     "newOffer": "New Offer",
     "offerAccept": "Accepting Offer",
+    "offerCancellation": "Offer Cancellation",
     "offerCreation": "Offer Creation",
     "offerFees": "Offer Fee",
-    "offerWithdrawl": "Offer Cancelation",
     "typeOffer": "Type An Offer",
     "withdrawAmount": "Withdraw Amount",
+    "withdrawOffer": "Withdraw Offer",
     "yourOffer": "Your Offer",
     "yourOfferAmount": "Your Offer Amount"
   },
@@ -1844,7 +1845,8 @@
     "surchargeIncludedWithYourItems": "Included with your items",
     "surchargeTitle": "Additional Funds",
     "swap": "Swap",
-    "swapWithdrawl": "Swap Cancelation",
+    "swapCancellation": "Swap Cancellation",
+    "withdrawSwap": "Withdraw Swap",
     "youOffer": "You offer",
     "youWillReceive": "You will receive",
     "yourAddress": "Your Address",
@@ -1986,6 +1988,8 @@
     "addressIncorrect": "Address Incorrect",
     "burnNft": "Burn NFT | Burn NFTs",
     "buy": { "error": "Failed to buy this item" },
+    "cancelOffer": "Cancel Offer",
+    "cancelSwap": "Cancel Swap",
     "consume": { "error": "Failed to burn item", "success": "Item burned" },
     "inputAddressFirst": "Input address first",
     "item": { "error": "Failed to send item", "success": "Item sent" },
@@ -2008,8 +2012,6 @@
       "error": "Item unlisting failed",
       "success": "Item successfully unlisted"
     },
-    "withdrawOffer": "Cancel Offer",
-    "withdrawSwap": "Cancel Swap",
     "wrongAddressCannotRecoveredWarning": "Items sent to the wrong address cannot be recovered."
   },
   "transactionLoader": {

diff --git a/utils/shoppingActions.ts b/utils/shoppingActions.ts
@@ -5,14 +5,14 @@ import { Interaction } from '@kodadot1/minimark/v1'
 enum OfferActions {
   MAKE_OFFER = 'MAKE_OFFER',
   SET_ROYALTY = 'SET_ROYALTY',
-  WITHDRAW_OFFER = 'WITHDRAW_OFFER',
+  CANCEL_OFFER = 'CANCEL_OFFER',
   ACCEPT_OFFER = 'ACCEPT_OFFER',
   CREATE_SWAP = 'CREATE_SWAP',
 }
 
 enum SwapActions {
-  WITHDRAW_SWAP = 'WITHDRAW_SWAP',
   ACCEPT_SWAP = 'ACCEPT_SWAP',
+  CANCEL_SWAP = 'CANCEL_SWAP',
 }
 
 export type ShoppingActions = Interaction | OfferActions | SwapActions