Add fees to UnsignedOriginatorEnvelope #548
Conversation
|
Warning Rate limit exceeded@neekolas has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 3 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (12)
WalkthroughThe pull request updates the protobuf generation script and enhances the envelope structure. The script in Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Envelope as UnsignedOriginatorEnvelope
Client->>+Envelope: BaseFee()
Note right of Envelope: Access proto.BaseFeePicodollars
Envelope-->>-Client: currency.PicoDollar (base fee)
Client->>+Envelope: CongestionFee()
Note right of Envelope: Access proto.CongestionFeePicodollars
Envelope-->>-Client: currency.PicoDollar (congestion fee)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pkg/envelopes/unsignedOriginator.go (1)
54-57: LGTM! Consider adding tests.The
CongestionFee()method is well-implemented, following the same pattern asBaseFee(). Consider adding unit tests to verify both fee methods work correctly with various fee values.Would you like me to help generate unit tests for both fee methods?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
pkg/proto/openapi/xmtpv4/message_api/message_api.swagger.jsonis excluded by!pkg/proto/**pkg/proto/openapi/xmtpv4/message_api/misbehavior_api.swagger.jsonis excluded by!pkg/proto/**pkg/proto/xmtpv4/envelopes/envelopes.pb.gois excluded by!**/*.pb.go,!pkg/proto/**
📒 Files selected for processing (2)
dev/gen-protos(1 hunks)pkg/envelopes/unsignedOriginator.go(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build pre-baked anvil-xmtpd
- GitHub Check: Test (Node)
🔇 Additional comments (3)
dev/gen-protos (1)
4-4: Verify the branch usage for protobuf generation.The script now generates protobuf definitions from the
nm/add-feesbranch instead ofmain. Please ensure that:
- The branch contains stable protobuf definitions.
- There is a plan to merge these changes back to
mainto avoid depending on a feature branch.pkg/envelopes/unsignedOriginator.go (2)
6-6: LGTM!The added import for the
currencypackage is necessary for the new fee methods.
49-52: LGTM!The
BaseFee()method is well-implemented:
- Returns the correct type (
currency.PicoDollar).- Safely accesses the proto field (nil check in constructor).
- Clear and focused implementation.
neekolas
force-pushed
the
02-21-add_fee_calculation_helpers
branch
from
13eca3f to
ce9b947
Compare
neekolas
force-pushed
the
02-24-add_fees_to_unsignedoriginatorenvelope
branch
from
242069b to
b21cb0d
Compare
neekolas
force-pushed
the
02-21-add_fee_calculation_helpers
branch
from
ce9b947 to
1ec1c15
Compare
neekolas
force-pushed
the
02-24-add_fees_to_unsignedoriginatorenvelope
branch
2 times, most recently
from
9a2fafe to
4b7a5dc
Compare
neekolas
force-pushed
the
02-21-add_fee_calculation_helpers
branch
from
1ec1c15 to
b727641
Compare
neekolas
force-pushed
the
02-24-add_fees_to_unsignedoriginatorenvelope
branch
from
4b7a5dc to
d977442
Compare
neekolas
force-pushed
the
02-21-add_fee_calculation_helpers
branch
from
b727641 to
77b36c3
Compare
neekolas
force-pushed
the
02-24-add_fees_to_unsignedoriginatorenvelope
branch
from
d977442 to
0078ca4
Compare
neekolas
changed the base branch from
02-21-add_fee_calculation_helpers
to
graphite-base/548
neekolas
force-pushed
the
02-24-add_fees_to_unsignedoriginatorenvelope
branch
from
0078ca4 to
3c50b54
Compare
TL;DR
Added fee-related fields to message envelopes. Populates them using a
FixedRateFetcherwhich uses hard-coded rates. This will have to do until we can get rates from a smart contract.What changed?
base_fee_picodollarsandcongestion_fee_picodollarsfields toUnsignedOriginatorEnvelopetarget_originatorfield toPayerEnvelopenm/add-feesbranch instead ofmainHow to test?
./dev/gen-protosto verify protobuf generation works with new branchtarget_originatorfield is properly serialized/deserializedWhy make this change?
To support fee calculation and payment functionality in the messaging system, allowing for base fees and congestion-based pricing while maintaining proper message routing through originators.
Summary by CodeRabbit
Chores
New Features