Add effective received amount field (#4660)

* Add effective received amount field * Update API doc
massalabs · Mar 11, 2024 · df156f3 · df156f3
1 parent 7dd1ac2
commit df156f3
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 0 deletions.
diff --git a/massa-api-exports/src/execution.rs b/massa-api-exports/src/execution.rs
@@ -110,6 +110,8 @@ pub struct Transfer {
     pub to: Address,
     /// The amount of the transfer
     pub amount: Amount,
+    /// The effective amount received by the receiver
+    pub effective_amount_received: Amount,
     /// If the transfer succeed or not
     pub succeed: bool,
     /// Fee

diff --git a/massa-api/src/public.rs b/massa-api/src/public.rs
@@ -158,6 +158,7 @@ impl MassaRpcServer for API<Public> {
                                 from: Address::from_str(&t_from).unwrap(),
                                 to: Address::from_str(&t_to).unwrap(),
                                 amount: Amount::from_raw(t_amount),
+                                effective_amount_received: Amount::from_raw(t_amount),
                                 context: TransferContext::ASC(i as u64),
                                 succeed: true,
                                 fee: Amount::from_raw(0),
@@ -178,6 +179,7 @@ impl MassaRpcServer for API<Public> {
                                 from: Address::from_str(&t_from).unwrap(),
                                 to: Address::from_str(&t_to).unwrap(),
                                 amount: Amount::from_raw(t_amount),
+                                effective_amount_received: Amount::from_raw(t_amount),
                                 context: TransferContext::Operation(op_id),
                                 succeed: true,
                                 fee: Amount::from_raw(0),
@@ -197,6 +199,7 @@ impl MassaRpcServer for API<Public> {
                     from: t.from,
                     to: t.to,
                     amount: t.amount,
+                    effective_amount_received: t.effective_received_amount,
                     context: TransferContext::Operation(t.op_id),
                     succeed: t.succeed,
                     fee: t.fee,

diff --git a/massa-execution-exports/src/types.rs b/massa-execution-exports/src/types.rs
@@ -373,6 +373,8 @@ pub struct Transfer {
     pub to: Address,
     /// Amount
     pub amount: Amount,
+    /// Effective received amount
+    pub effective_received_amount: Amount,
     /// operation id
     pub op_id: OperationId,
     /// success or not

diff --git a/massa-execution-worker/src/execution.rs b/massa-execution-worker/src/execution.rs
@@ -1270,10 +1270,33 @@ impl ExecutionState {
                                     recipient_address,
                                     amount,
                                 } => {
+                                    let receiver_balance = {
+                                        let context = context_guard!(self);
+                                        context.get_balance(recipient_address).unwrap_or_default()
+                                    };
+                                    let mut effective_received_amount = *amount;
+                                    if receiver_balance
+                                        == amount
+                                            .checked_sub(
+                                                self.config
+                                                    .storage_costs_constants
+                                                    .ledger_entry_base_cost,
+                                            )
+                                            .unwrap_or_default()
+                                    {
+                                        effective_received_amount = amount
+                                            .checked_sub(
+                                                self.config
+                                                    .storage_costs_constants
+                                                    .ledger_entry_base_cost,
+                                            )
+                                            .unwrap_or_default();
+                                    }
                                     transfers.push(Transfer {
                                         from: operation.content_creator_address,
                                         to: *recipient_address,
                                         amount: *amount,
+                                        effective_received_amount,
                                         op_id: operation.id,
                                         succeed: _op_return.1,
                                         fee: operation.content.fee,
@@ -1286,6 +1309,7 @@ impl ExecutionState {
                                         from: operation.content_creator_address,
                                         to: *target_addr,
                                         amount: *coins,
+                                        effective_received_amount: *coins,
                                         op_id: operation.id,
                                         succeed: _op_return.1,
                                         fee: operation.content.fee,

diff --git a/massa-node/base_config/openrpc.json b/massa-node/base_config/openrpc.json
@@ -3151,6 +3151,7 @@
                     "from",
                     "to",
                     "amount",
+                    "effective_amount_received",
                     "context",
                     "succeed",
                     "fee",
@@ -3170,6 +3171,10 @@
                         "description": "Amount transferred",
                         "type": "integer"
                     },
+                    "effective_amount_received": {
+                        "description": "Amount received by the receiver",
+                        "type": "integer"
+                    },
                     "context": {
                         "description": "Context of the transfer : operation or asyncronous execution",
                         "type": "object"