Providing a Simple Example

Oct 13, 2025 by wbrum.org 89 views

As a user of the RP2 (RP2) framework, I recently encountered a minor point of confusion in the documentation that I believe could be clarified for the benefit of others. The input_files page contains fields with names like no_fee and with_fee, which refer to "excluding fees" and "including fees" in their descriptions. In this article, I will provide a suggestion for clarifying the meaning of these fields to avoid confusion.

Understanding Fee-Related Fields

The fields in question are used to represent the amount of cryptocurrency or fiat value in a transaction, with or without fees. The descriptions for these fields are as follows:

crypto_out_no_fee: how much of the given cryptocurrency was sold or sent with the transaction (excluding fees).
crypto_out_with_fee (optional): how much of the given cryptocurrency was sold or sent with the transaction (including fees). If not provided, RP2 will compute this value automatically.
fiat_out_no_fee (optional): fiat value of the transaction without fees. If not provided, RP2 will compute this value automatically.

Clarifying the Meaning of `no_fee` and `with_fee`

The descriptions for these fields are not entirely clear, which can lead to confusion. Specifically, the terms "excluding fees" and "including fees" are used, but their meaning is not explicitly stated. This can lead to questions like:

Does no_fee mean that the fee has already been subtracted from the amount (i.e., what remains is net of fees)?
Or does it mean "excluding the impact of the fee" (i.e., the fee has not yet been subtracted and it is the gross amount)?

Similarly, the meaning of with_fee is unclear. Does it mean that the fee has already been added to the amount (i.e., what remains is gross of fees)? Or does it mean "including the impact of the fee" (i.e., the fee has not yet been added and it is the net amount)?

Providing a Simple Example

To clarify the meaning of these fields, a simple example would be helpful. For instance, consider a transaction where 10 units of cryptocurrency are sent, with a fee of 1 unit. In this case:

crypto_out_no_fee would represent the net amount of cryptocurrency sent, which is 9 units (10 - 1).
crypto_out_with_fee would represent the gross amount of cryptocurrency sent, which is 10 units (including the fee).
fiat_out_no_fee would represent the net fiat value of the transaction, which is the value of 9 units of cryptocurrency (excluding the fee).

Conclusion

In conclusion, the fields no_fee and with_fee in the RP2 documentation could benefit from clarification to avoid confusion. A simple example, as provided above, can help to illustrate the meaning of these fields and provide a clear understanding of how they are used in the RP2 framework.

Recommendations for Clarification

To clarify the meaning of these fields, I recommend the following:

Add a brief explanation to the documentation that defines the terms "excluding fees" and "including fees" and how they relate to the fields no_fee and with_fee.
Provide a simple example, like the one above, to illustrate the meaning of these fields and how they are used in the RP2 framework.
Consider adding a note or a warning to the documentation that highlights the potential for confusion and encourages users to carefully review the documentation before using these fields.

In our previous article, we discussed the potential for confusion in the RP2 documentation regarding the fields no_fee and with_fee. To provide further clarification, we have compiled a Q&A guide that addresses common questions and concerns related to these fields.

Q: What is the difference between `no_fee` and `with_fee`?

A: The main difference between no_fee and with_fee is the inclusion or exclusion of fees in the calculation. no_fee represents the amount of cryptocurrency or fiat value without fees, while with_fee represents the amount with fees included.

Q: Does `no_fee` mean that the fee has already been subtracted from the amount?

A: No, no_fee does not mean that the fee has already been subtracted from the amount. Instead, it represents the amount of cryptocurrency or fiat value without fees, which is the net amount after fees have been deducted.

Q: Does `with_fee` mean that the fee has already been added to the amount?

A: No, with_fee does not mean that the fee has already been added to the amount. Instead, it represents the amount of cryptocurrency or fiat value with fees included, which is the gross amount before fees have been deducted.

Q: How do I determine whether to use `no_fee` or `with_fee`?

A: To determine whether to use no_fee or with_fee, consider the following:

If you want to represent the net amount of cryptocurrency or fiat value after fees have been deducted, use no_fee.
If you want to represent the gross amount of cryptocurrency or fiat value before fees have been deducted, use with_fee.

Q: What happens if I don't provide a value for `with_fee`?

A: If you don't provide a value for with_fee, RP2 will compute the value automatically. This means that RP2 will calculate the gross amount of cryptocurrency or fiat value before fees have been deducted.

Q: What happens if I don't provide a value for `no_fee`?

A: If you don't provide a value for no_fee, RP2 will compute the value automatically. This means that RP2 will calculate the net amount of cryptocurrency or fiat value after fees have been deducted.

Q: Can I use both `no_fee` and `with_fee` in the same calculation?

A: Yes, you can use both no_fee and with_fee in the same calculation. However, be aware that using both fields may lead to confusion, and it's recommended to use one field consistently throughout your calculation.

Q: How can I ensure that I'm using `no_fee` and `with_fee` correctly?

A: To ensure that you're using no_fee and with_fee correctly, follow these best practices:

Read the documentation carefully and understand the definitions of no_fee and with_fee.
Use a simple example to illustrate the meaning of these fields and how they are used in your calculation.
Test your calculation with different values for no_fee and with_fee to ensure that you're getting the expected results.

By following these guidelines and best practices, you can ensure that you're using no_fee and with_fee correctly and accurately in your RP2 calculations.