Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Throttle garbage collection #557

Merged
merged 6 commits into from
Dec 7, 2022
Merged

Throttle garbage collection #557

merged 6 commits into from
Dec 7, 2022

Conversation

shaspitz
Copy link
Contributor

@shaspitz shaspitz commented Dec 5, 2022

Implements the throttling related cleanup that is needed when a consumer is stopped. Queued slash packet and vsc matured packet data is thrown out

@shaspitz shaspitz changed the base branch from main to circuit-breaker December 5, 2022 20:50
@shaspitz shaspitz marked this pull request as ready for review December 5, 2022 20:51
shaspitz
shaspitz commented Dec 5, 2022
View reviewed changes
x/ccv/provider/keeper/proposal.go
k.DeletePendingSlashPacketEntriesForConsumer(ctx, chainID)

// Remove all pending slash packets and vsc matured packets queued for this consumer.
// Note: queued VSC matured packets can be safely removed from the per-chain queue,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could someone confirm for me that it is indeed safe to throw out queued VSC matured packets when stopping a consumer? This seems safe since the unbonding ops are already released above

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good to me. @mpoke?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the queued VSCMatured packets is fine. I don't like the idea that we remove queued slash packets. These packets were already relayed on the provider and the only reason were not handled is the throttling mechanism. IMO, a consumer state should not be removed until the queue of received packets is empty.

@shaspitz shaspitz mentioned this pull request Dec 5, 2022
Merged
jtremback
jtremback approved these changes Dec 5, 2022
View reviewed changes
Copy link
Contributor

@jtremback jtremback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

mpoke
mpoke requested changes Dec 6, 2022
View reviewed changes
Copy link
Contributor

@mpoke mpoke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment below.

x/ccv/provider/keeper/proposal.go
k.DeletePendingSlashPacketEntriesForConsumer(ctx, chainID)

// Remove all pending slash packets and vsc matured packets queued for this consumer.
// Note: queued VSC matured packets can be safely removed from the per-chain queue,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the queued VSCMatured packets is fine. I don't like the idea that we remove queued slash packets. These packets were already relayed on the provider and the only reason were not handled is the throttling mechanism. IMO, a consumer state should not be removed until the queue of received packets is empty.

@danwt
Copy link
Contributor

danwt commented Dec 6, 2022

If the decision is that both maturities and slash packets are able to be removed, I would suggest, instead of removing them from the queue, to just ignore them when they are pulled from the queue.

If the decision is that one of the packet times should not be removable, I would suggest applying that decision to both packet types (addressing Marius' 'IMO, a consumer state should not be removed until the queue of received packets is empty.')

@shaspitz shaspitz mentioned this pull request Dec 6, 2022
Closed
@shaspitz
Copy link
Contributor Author

shaspitz commented Dec 6, 2022

@mpoke issue as mentioned over call #566

@shaspitz
Copy link
Contributor Author

shaspitz commented Dec 7, 2022

If the decision is that both maturities and slash packets are able to be removed, I would suggest, instead of removing them from the queue, to just ignore them when they are pulled from the queue.

Although this may be the better solution, and less of a big-hammer, it'd be inconsistent with how all other consumer-specific state, including pending/queued state, is handled in StopConsumerChain

As far as whether slash/vsc matured packets are able to be safely removed/dropped, this topic will be tracked in #566

@shaspitz shaspitz requested a review from mpoke December 7, 2022 03:27
@mpoke mpoke merged commit 35192c0 into circuit-breaker Dec 7, 2022
@mpoke mpoke deleted the throttle-garbage-collection branch December 7, 2022 08:49
danwt pushed a commit that referenced this pull request Dec 8, 2022
@shaspitz
Throttle garbage collection (#557)
26c8e9e 
* changes

* Update proposal.go

* add log

* Update throttle_test.go

* fixes
jtremback added a commit that referenced this pull request Dec 16, 2022
@shaspitz @jtremback
@mpoke @sainoe @MSalopek @danwt
Slash packet throttling (#462)
ae66785 
* wip

* Update module.go

* wip

* tests pass

* Update relay.go

* Update relay.go

* Update relay.go

* Update relay.go

* wip

* still wip

* panic with too many packets

* Update relay.go

* wip

* checkpoint

* Update throttle.go

* make relay.go closer to main

* merge fixes

* Update expected_keepers.go

* Update throttle_test.go

* Update throttle.go

* second queue is now implemented

* smalls

* Update throttle.go

* removed pointer silliness

* Update throttle_test.go

* test improvements

* small

* where it's called

* Update relay.go

* comments n stuff

* Update throttle.go

* Update throttle.go

* comments

* wip

* callbacks

* cleans

* mas tests

* Update README.md

* less diff

* mas

* keys

* wip

* changes

* Update params.go

* size constraints

* Update keys_test.go

* Update throttle_test.go

* wip

* on recv new behavior and test

* on recv slash packet

* so close

* clean

* Update slashing.go

* cleans

* wip

* params

* wip

* tests

* changes

* mas

* Update README.md

* Update README.md

* Update README.md

* sorry for the friday night emails

* Update instance_test.go

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* works

* Update generic_setup.go

* Update setup.go

* smol

* small

* path to ccv chan setup

* todos

* Update setup.go

* Create debug_test.go

* democ

* Update debug_test.go

* setup all ccv channels

* bump to main

* another bump, missed one

* fix after merge main

* fixes

* Update slashing.go

* expired client tests

* checks

* fixed the stuff

* smol

* changes

* updates

* cleans

* clean

* todo

* fixes

* cleans

* Update slashing.go

* Update slashing.go

* mod tidy

* fix build errs

* test fixes

* Update slashing.go

* Update throttle.go

* base rounding

* mas unit tests

* updates

* comments

* comments

* cleans

* clean

* small

* sin gas

* more understandable logic

* crypto rand

* utils

* one e2e

* helpers

* Update slashing.go

* helpers

* cleans

* shiz works

* tcs

* smalls

* un mas

* allowance changing test

* smol

* smol

* e2e tests are done

* lets try this

* Key Assignment -> goc-december (#527)

* add MsgAssignConsumerKey

* add MsgAssignConsumerKey

* fix package name

* add keys

* add keeper methods for key assignment

* handle MsgAssignConsumerKey

* map addresses in slash requests

* prune old consumer addresses

* move AssignConsumerKey logic to keeper

* update consumer initial valset

* add ApplyKeyAssignmentToValUpdates

* fix client creation

* do not check init valset on consumer

* clean state on val removal

* fix TestAssignConsensusKeyForConsumerChain

* delete on val removal

* remove reverse mapping on val removal

* remove pending key assignment in EndBlock

* add query endpoints
add summary of indexes
change ConsumerValidatorByVscID to ConsumerAddrsToPrune

* Refactor AssignConsumerKey for clarity (IMO)

* finish key assignment genesis code- untested

* FIxed mocks compile issue - not sure if it works right though.

* add test for init and export genesis

* set after get in AssignConsumerKey

* enable AssignConsumerKey to be called twice

* remove key assignment on chain removal

* apply some review comments

* fix bug: two validator with same consumer key

* rename key: ConsumerValidatorsByVscIDBytePrefix -> ConsumerAddrsToPruneBytePrefix

* PendingKeyAssignment -> KeyAssignmentReplacements

* msg.ProviderAddr is a validator addr

* fix: key assignment genesis tests (#517)

* Fix consumer init genesis test

* fix provider genesis tests

* fix key assignement handler

* fix linter

* fix merge conflict

* fix ProviderValidatorAddress

* remove unused expectation

Co-authored-by: Marius Poke <[email protected]>

* add key assignment CRUD operations unit tests (#516)

* test val consumer key related CRUD

* test val consumer addr related CRUD

* test pending key assignments related CRUD

* refactor after review session

* refactor after review session

* add prune key CRUD tests

* renamings in testfiles

* improve KeyAssignmentReplacement set and get

* remove ApplyKeyAssignmentToInitialValset (redundant)

* add invariant to docstring of AppendConsumerAddrsToPrune

* fix address conversion

* adding e2e tests

* fix linter

* add queries; setup integration tests (#519)

* add queries; setup integration testse

* test key assignment before chain start

* fix state queries; refactor

* rm extra comment

* rm unused action field

* bump voting times in all tests

* add provider address query to tests

* Adds some very basic random testing and unit tests (#522)

* Adds imports

* Does multi iterations: fails!

* Handle errs

* checkpoint debug

* Pre introduce dynamic mock

* Issue seems to be resolved

* Removes prints in key asisgn

* Removes debug, pre reintroduce all test features

* Fix some magic numbers, bring back prune check

* Pre rework initial assignments

* Refactor and tidyup

* Better docs, clarity, org

Co-authored-by: Daniel <[email protected]>

* Enable key assignment testing for all e2e tests (#524)

* split CCVTestSuite.setupCallback in two

* pre-assign keys for all vals of first consumer

* fix linter

* remove TestConsumerGenesis

Co-authored-by: mpoke <[email protected]>
Co-authored-by: Simon Noetzlin <[email protected]>
Co-authored-by: MSalopek <[email protected]>
Co-authored-by: Daniel T <[email protected]>
Co-authored-by: Daniel <[email protected]>

* Fix errors in merge commit, comment out failing TestRelayAndApplySlashPacket test

* add simon's test fixes

* Update state.go

* last replenish time -> last full time

* readme

* increment i

* shared method

* iteration change

* Meter allowance lockstep (#553)

changes

* log

* requested key format changes (#560)

changes

* Throttle garbage collection (#557)

* changes

* Update proposal.go

* add log

* Update throttle_test.go

* fixes

* update invariant

* Throttle bug fixes + req refactors (#565)

* fixes

* Update throttle.go

* fix tests

* set replenish frac = 1.0 for all test runs

* rm unmarshal func

* req refactors

* small lint fix

* comment adjustment

* found <-> jailed order swap

* 100% change

* weird

* merge fixes to build

* tests now pass

* name change

* better ordering tests

* remove integration test diff

* avoid double call to address mapping

* Update throttle.go

* 0 included in iteration start

* naming refactors

* Update keys_test.go

* more refactors

* clarify allowance terminology

* update doc with explanation on min value

* md clarification

* Update throttle.md

* swap replenish order

* add max limit note

* #533 Adds normal operation diff testing

* reb

* reb

* Del unused

Co-authored-by: Daniel <[email protected]>

* progress save

* cleans

* name change

* Bugfix (#605)

* Circuit breaker refactor (#606)

* quick fix

* small key correction

* smol

* don't store time length

* use big endian, shawn you dingus

Co-authored-by: Jehan <[email protected]>
Co-authored-by: mpoke <[email protected]>
Co-authored-by: Simon Noetzlin <[email protected]>
Co-authored-by: MSalopek <[email protected]>
Co-authored-by: Daniel T <[email protected]>
Co-authored-by: Daniel <[email protected]>
Co-authored-by: Jehan Tremback <[email protected]>
ThanhNhann pushed a commit to decentrio/interchain-security that referenced this pull request Jan 3, 2024
@AdityaSripal @colin-axner
@seantking @charleenfei @dependabot @crodriguezvega @lukerhoads @damiannolan @ValarDragon @jackzampolin @fedekunze @allthatjazzleo @technicallyty @tac0turtle @alexanderbez @nir1218 @assafmo @dkmccandless @ramacarlucho @rigelrozanski
ICS 29: Fee Middleware (cosmos#276)
4271027 
* scaffolding for 29-fee (cosmos#274)

* scaffolding for 29-fee

* fix build

* update keeper test

* remove module test

* feat: adding proto files for fee payment middleware (cosmos#272)

* feat: adding proto files for fee payment middleware

* grammar

* fix: remove generated .pb files

* fix: comment

* feat: adding PacketId type

* refactor: fee / genesis

* refactor: escrowed fees map

* Apply suggestions from code review

Co-authored-by: colin axnér <[email protected]>

* Update proto/ibc/applications/middleware/fee/v1/tx.proto

Co-authored-by: colin axnér <[email protected]>

* Update proto/ibc/applications/middleware/fee/v1/tx.proto

Co-authored-by: colin axnér <[email protected]>

* Update proto/ibc/applications/middleware/fee/v1/tx.proto

Co-authored-by: colin axnér <[email protected]>

* refactor: use packetID + minor changes

* feat: adding query for all incentivized packets + some fixes

* feat: adding pagination to incentivized query

* fix: removing generated ibc directory + adding import/yaml

* fix: naming

* increase max depth for proto file searching and make proto all

* Update proto/ibc/applications/middleware/fee/v1/fee.proto

Co-authored-by: colin axnér <[email protected]>

* refactor: remove file imports/add yaml/add argument for requests

* refactor: updating IdentifiedPacketFee

* fix: remove hidden file

* removing middleware dir & adding query

* remove junk file and update query rpcs

* Apply suggestions from code review

* Apply suggestions from code review

* remove query yaml, make proto-all

Co-authored-by: colin axnér <[email protected]>
Co-authored-by: Aditya Sripal <[email protected]>

* fix: removing unncessary fields MsgEscrow & adding query params (cosmos#300)

* fix: removing unncessary fields MsgEscrow & adding query params

* fix: grammar

* fix: add yaml

* feat: cosmos#258 Register Counterparty Address (cosmos#376)

* feat: adding MsgServer for RegisterCounterPartyAddress &
EscrowPacketFree

* test: adding test for ValidateBasic

* fix: removing validate basic check

* fix: removing empty file

* Update modules/apps/29-fee/keeper/msg_server.go

Co-authored-by: colin axnér <[email protected]>

* Update modules/apps/29-fee/types/msgs.go

Co-authored-by: colin axnér <[email protected]>

* Update modules/apps/29-fee/types/keys.go

Co-authored-by: colin axnér <[email protected]>

* Update modules/apps/29-fee/keeper/keeper.go

Co-authored-by: Aditya <[email protected]>

* fix: fixing typos, variable names, comments

* fix: updating import comments

* test: adding test for KeyRelayerAddress

* update: comments & key_test

* Update modules/apps/29-fee/keeper/msg_server.go

Co-authored-by: colin axnér <[email protected]>

* fix: error message

* docs: updating RegisterCounterpartyAddress fn description

Co-authored-by: colin axnér <[email protected]>
Co-authored-by: Aditya <[email protected]>

* fix: remove comments for imports (cosmos#385)

* feat: Add handshake logic to ics29 (cosmos#307)

* do handshake logic, create test file

* do cap logic and fix build

* open handshake implementation and tests

* remove prints

* Update modules/apps/29-fee/module.go

Co-authored-by: Sean King <[email protected]>

* debugging progress

* fee enabled flag

* cleanup handshake logic

* fix tests

* much cleaner simapp

* split module.go file

* cleanup and docs

* assert IBC interfaces are fulfilled in middleware

* Update modules/apps/transfer/module.go

Co-authored-by: colin axnér <[email protected]>

* Apply suggestions from code review

Co-authored-by: colin axnér <[email protected]>

* fix unnecessary crossing hello logic

* fix version negotiation bugs and improve tests

* cleanup tests

* Apply suggestions from code review

Co-authored-by: colin axnér <[email protected]>

* Apply suggestions from code review

Co-authored-by: colin axnér <[email protected]>

* address rest of colin comments

Co-authored-by: Sean King <[email protected]>
Co-authored-by: colin axnér <[email protected]>

* Fee Middleware: Escrow logic (cosmos#465)

* fix: adding second endpoint for async pay fee + renaming types

* feat: adding escrow logic

* feat: updating proto types & escrow logic

* fix: stub fn & proto comment

* feat: adding PayFee & PayFeeTimeout & escrow_test

* test: adding happy path for EscrowPacketFee

* fix: comments, error handling

* fix: comments & grammar

* test: adding unhappy path for escrow

* tests(escrow): adding hasBalance check for module acc

* test(PayFee): adding happy path for PayFee tests

* tests(PayFee, PayFeeTimeout): adding tests

* fix: adding relayers back to IdentifiedPacket

* fix: removing refund acc from key

* fix: storing IdentifiedPacketFee in state instead of Fee

* feat: adding msg_server test for registerCPAddr, wiring for codec + stubs for sdk.Msg interface

* test: adding msg_server test for PayPacketFee

* test: adding PayPacketFeeAsync msg_server test

* chore: updating PayFee -> DistributeFee & minor nits

* nit: removing unnecessary nil check

* refactor: add portId to store key & use packetId as param

* fix: add DeleteFeeInEscrow & remove fee on successful distribution

* tests: adding validation & signer tests for PayFee/Async & updating proto to use Signer sdk standard

* chore: adding NewIdentifiedPacketFee fn

* fix: getter/setter for counterparty address + fix NewIdentifiedPacketFee

* fix: updating EscrowPacketFee with correct usage of coins api

* test: adding balance check for refund acc after escrow

* fix: remove unncessary errors

* test: updating escrow tests + miscellaneous fixes

* nit: updating var names

* docs: godoc

* refactor: IdentifiedPacketFee & Fee no longer pointers

* fixes: small fixes

* Update modules/apps/29-fee/keeper/escrow.go

Co-authored-by: Aditya <[email protected]>

* Update modules/apps/29-fee/keeper/escrow.go

Co-authored-by: Aditya <[email protected]>

* Update modules/apps/29-fee/keeper/keeper.go

Co-authored-by: Aditya <[email protected]>

* Update modules/apps/29-fee/keeper/msg_server.go

Co-authored-by: Aditya <[email protected]>

* Update modules/apps/29-fee/keeper/msg_server.go

Co-authored-by: Aditya <[email protected]>

* Update modules/apps/29-fee/types/msgs.go

Co-authored-by: Aditya <[email protected]>

* nit: proto doc & error fix

* fix: escrow test

* test: updating distribute fee tests

* test: adding validation check for fee and updating tests

* test: allow counterparty address to be arbitrary string

* fix: message validation should pass if one fee is valid

* Update modules/apps/29-fee/keeper/escrow.go

Co-authored-by: colin axnér <[email protected]>

* Update modules/apps/29-fee/keeper/escrow.go

Co-authored-by: colin axnér <[email protected]>

* fix: nits

* Update modules/apps/29-fee/keeper/escrow.go

Co-authored-by: colin axnér <[email protected]>

* test: adding isZero check for msgs

Co-authored-by: Aditya <[email protected]>
Co-authored-by: colin axnér <[email protected]>

* feat: update protos, grpc queries (cosmos#488)

* store refund address in IdentifiedPacketFee (cosmos#546)

* 29-Fee: Genesis (cosmos#557)

* proto: adding genesis state

* feat: add GetAllIdentifiedPacketFees

* feat: adding genesis.go & updating proto + app.go

* fix: removing PortId from genesis

* feat: adding GetAll for relayer addr/fee enabled chan + update genesis

* test: TestExportGenesis

* feat: update type + hook up to module.go

* fix: remove PortKey

* fix: imports + remove scoped keeper

* nit: using NewPacketId helper and updating helper def to have correct params

* feat: adding genesis validation + tests (cosmos#561)

* feat: adding genesis validation + tests

* fix: imports

* Update modules/apps/29-fee/types/genesis.go

* fix: nit

* Update modules/apps/29-fee/types/genesis_test.go

Co-authored-by: Aditya <[email protected]>

* nit: imporve default gen val test

* chore: move packetId + val to channeltypes and use validate fn

Co-authored-by: Aditya <[email protected]>

* feat: add incentivised ack proto (cosmos#564)

* proto file

* incentivized ack proto

* Fee Closing Handshake (cosmos#551)

* add iterate logic

* add closing logic with tests

* add comments for panic

* change invariant breaking recovery to disabling middleware rather than panicing

* docs, tests, minor refactor

* Fee Middleware: Add ICS4 wrapper (cosmos#562)

* chore: add ICS4 wrapper

* fix: remove channelKeeper sender packet

* chore: add WriteAck

* feat: ics 29 packet callbacks (cosmos#357)

* update imports to v3

* regenerate proto files

* fix build

* fix: event caching for fee distribution (cosmos#661)

* proto file

* initial impl

* apply self review suggestions

Deduplicate fee distribution code.
Rename DistributeFee to DistributePacketFees.
Rename DistributeFeeTimeout to DistributePacketFeesOnTimeout

* fixup tests

rename validCoins.
DistributePacketFeesOnTimeout no longer has a valid error case
Add test case for invalid forward relayer address on DistributePacketFees.

* partially fix tests

timeout fee is still being distributed depsite WriteFn() not being called

* fix tests

* address code nit

Co-authored-by: Colin Axnér <[email protected]>

* ics4 callbacks fee middleware (cosmos#580)

* feat: adding WriteAcknowledgement

* updating genesis & relayer prefix

* fix: comment

* fix: comments

* Update modules/apps/29-fee/keeper/relay.go

Co-authored-by: colin axnér <[email protected]>

* feat: add DeleteForwardRelayerAddr helper + use Set in ack

* fix: SetForwardAddr

* chore: add panic

* fix: remove fmt

* test: add WriteAcknowledgement test

* Update modules/apps/29-fee/ibc_module.go

Co-authored-by: Aditya <[email protected]>

* fix: remove print

* fix: WriteAck

* fix: use constructor

* Update modules/apps/29-fee/keeper/keeper.go

Co-authored-by: colin axnér <[email protected]>

* fix: nits

* fix: remove found var not used

* test: adding check that forward relayer address is successfully deleted if set

* fix: merge issues

Co-authored-by: colin axnér <[email protected]>
Co-authored-by: Aditya <[email protected]>

* chore: making PacketId non nullable (cosmos#737)

* nits: proto spacing + naming (cosmos#739)

* nits: proto spacing + naming

* nit: update comment

* fix: go.mod

* nit: option above import proto

* fix: spacing

* sean/fix-proto-identified-fee-not-null (cosmos#746)

* nits: more ics29 nits (cosmos#741)

* nits: remove capital from error + add godoc

* nit: add Wrapf

* nit: use strings.TrimSpace

* nit: add err type for MsgPayPacketFee

* refactor: app version + add comment (cosmos#750)

* chore: remove error

* test: add test for whitespaced empty string

* nit: update err syntax (cosmos#747)

* nit: update err syntax

* nit: more

* nit: err syntax

* feat: adding Route, Type, GetSignBytes for all messages (cosmos#743)

* feat: adding Route, Type, GetSignBytes for all messages

* tests: adding tests for Route/Type/GetSignBytes

* hygiene: add validate fn for Fee (cosmos#748)

* hygiene: add validate fn for Fee

* Update modules/apps/29-fee/types/msgs.go

Co-authored-by: Damian Nolan <[email protected]>

* fix: error message

* test: move Validate to fee.go & abstract out test

* chore: remove test cases

Co-authored-by: Damian Nolan <[email protected]>

* fix: app.go (cosmos#789)

* refactor: ics29 json encoded version metadata (cosmos#883)

* adding metadata type to ics29 protos

* updating ics29 handshake handlers to support json encoded metadata

* updating tests to support json encoded metadata

* Update modules/apps/29-fee/ibc_module.go

Co-authored-by: colin axnér <[email protected]>

* Update modules/apps/29-fee/ibc_module.go

Co-authored-by: colin axnér <[email protected]>

* renaming metadata version to fee_version

Co-authored-by: colin axnér <[email protected]>

* fix: return nil on OnRecvPacket for async pay (cosmos#911)

* nit: ics29 comments (cosmos#910)

* fix: comments

* Update modules/apps/29-fee/keeper/escrow.go

Co-authored-by: Aditya <[email protected]>

* chore: Add transfer test for ics29 (cosmos#901)

* begin writing transfer test for ics29

* finish writing transfer test

* refactor: ics29 OnChanOpenInit callback tests now use mock module (cosmos#924)

* refactor: OnChanOpenInit callback tests now use mock module

* Update modules/apps/29-fee/fee_test.go

* feat: allow multiple addrs to incentivize packets (cosmos#915)

* [WIP] allow multiple addresses to incentivize a packet

* distribute multiple fees, fix broken tests

* use NewIdentifiedPacketFees in EscrowPacketFee

* cleanup var naming

* removing commented out code and adding test case

* Update modules/apps/29-fee/ibc_module.go

Co-authored-by: Aditya <[email protected]>

* fix: refund RecvFee if ForwardAddr is invalid

* test: update tests to distribute multiple identified fees

* refactor: clean up DistrPacketFees

* refactor: using .Empty() helper func for code hygiene

Co-authored-by: Aditya <[email protected]>
Co-authored-by: Sean King <[email protected]>
Co-authored-by: Sean King <[email protected]>

* chore: remove spec directory from ics29 (cosmos#934)

* refactor: use mock module for ics29 closing handshakes (cosmos#926)

* refactor: use mock module for closing handshakes in ics29

* self-review fix

* refactor: use mock module for ics29 grpc_query_test.go (cosmos#933)

* refactor: readjust keeper_test.go to use mock module (cosmos#930)

* fix: fields for genesis should be non nullable (cosmos#938)

* refactor: use mock module for ics29 escrow_test.go (cosmos#932)

* refactor: use mock module for ics29 genesis_test.go (cosmos#931)

* ics29:feat: emit event escrow (cosmos#914)

* feat: emit EventTypeSendIncentivizedPacket event on EscrowPacket

* fix: string conversion

* refactor: add helper fn for emit event

* chore: godoc

* nit: use .String())

* refactor: OnRecvPacket to use mock module (cosmos#927)

Co-authored-by: Sean King <[email protected]>

* refactor: ics29 OnChanOpenTry/Ack use mock module for testing instead of ics20 (cosmos#925)

Co-authored-by: Sean King <[email protected]>

* refactor: use mock module for OnAcknowledgePacket callback testing (cosmos#929)

Co-authored-by: Sean King <[email protected]>

* refactor: OnTimeoutPacket to use mock module (cosmos#928)

Co-authored-by: Sean King <[email protected]>

* chore: add packet id arg to EscrowPacketFee (cosmos#951)

* adding packet id arg to EscrowPacketFee

* updating tests

* review adaptations

* chore: remove legacy testing functions (cosmos#954)

* fix:ics29: WriteAck update + adding success bool to IncentivizedAck (cosmos#952)

* fix: updating WriteAck & adding Success boolean to IncentivizedAcknowledgement

* feat: adding check of is fee enabled

* nit: change successful to underlying_application_success

* test: adding seperate test for fee disabled write async

* Update modules/apps/29-fee/ibc_module_test.go

Co-authored-by: Aditya <[email protected]>

* test: adding check to compare hash of acks

* fix: var name

Co-authored-by: Aditya <[email protected]>

* chore: add cli cmd to incentivize existing packet (async) (cosmos#965)

* chore: add cli to incentivize existing packets

* Update modules/apps/29-fee/client/cli/cli.go

* Update modules/apps/29-fee/client/cli/cli.go

Co-authored-by: Aditya <[email protected]>

* chore: update cli example

Co-authored-by: Aditya <[email protected]>

* ics29:fix: counterparty addr must contain channelID (cosmos#937)

* fix: counterparty address must chain channelID

* nit: updating var name

* test: adding validation check for channelID

* nit: fn names

* chore: fix err msg (cosmos#971)

* ics29:fix: store source address for query later on WriteAck (cosmos#912)

* fix: for async WriteAck store source address for query later

* ics29:fix: update genesis type (cosmos#913)

* fix: adding ForwardRelayerAddresses to genesis

* fix: trimspace on string check

* nit: err + trimspace error case

* refactor: updating WriteAck + keeper fn name

* Update modules/apps/29-fee/keeper/relay.go

Co-authored-by: Damian Nolan <[email protected]>

* chore: remove legacy testing functions (cosmos#954)

* fix:ics29: WriteAck update + adding success bool to IncentivizedAck (cosmos#952)

* fix: updating WriteAck & adding Success boolean to IncentivizedAcknowledgement

* feat: adding check of is fee enabled

* nit: change successful to underlying_application_success

* test: adding seperate test for fee disabled write async

* Update modules/apps/29-fee/ibc_module_test.go

Co-authored-by: Aditya <[email protected]>

* test: adding check to compare hash of acks

* fix: var name

Co-authored-by: Aditya <[email protected]>

Co-authored-by: Damian Nolan <[email protected]>
Co-authored-by: colin axnér <[email protected]>
Co-authored-by: Aditya <[email protected]>

* refactor: make fee storage more efficient (cosmos#956)

* adding new proto types and codegen

* refactoring ics29 fees for more efficient storage

* updating tests

* fixing typo in protodoc comments

* chore: update ics29 genesis state to support multiple packet fees (cosmos#957)

* adding new proto types and codegen

* refactoring ics29 fees for more efficient storage

* updating tests

* updating genesis protos to use IdentifiedPacketFees

* updating init/export genesis state functionality and tests

* chore: update MsgPayPacketFeeAsync fields (cosmos#979)

* adding new proto types and codegen

* refactoring ics29 fees for more efficient storage

* updating tests

* fixing typo in protodoc comments

* updating protos and codegen

* updating MsgPayPacketFeeAsync handler and tests

* chore: add ParseKeyFeesInEscrow helper function (cosmos#998)

* chore: update grpc queries to handle multiple fees (cosmos#967)

* adding new proto types and codegen

* refactoring ics29 fees for more efficient storage

* updating tests

* updating protos and existing queries

* updating grpc queries and refactoring tests

* format error correct in favour of proto string() method

* leveraging ParseKeyFeesInEscrow to obtain  packet id in query

* feat: CLI cmd for MsgRegisterCounterpartyAddress (cosmos#987)

* feat: CLI cmd for MsgRegisterCounterpartyAddress

* fix: examples

* Update modules/apps/29-fee/client/cli/tx.go

Co-authored-by: colin axnér <[email protected]>

* Update modules/apps/29-fee/client/cli/tx.go

Co-authored-by: colin axnér <[email protected]>

* chore: remove print

* nit: update address for counterparty

Co-authored-by: colin axnér <[email protected]>

* fix: ics29: switch source with destintion for chan/port IDs (cosmos#961)

* fix: switch source with destintion for chan/port IDs

* fix: blunder

* test: adding tests in case of incorrect channel/port id

* test: moving check to WriteAcknowledgement

* add test case for Get/Set counterparty address

* nit: path name

* Update modules/apps/29-fee/keeper/msg_server_test.go

* test: cleanup 29-fee/types tests (cosmos#1006)

* feat: grpc query total recv packet fees (cosmos#1015)

* adding query for total packet recv fees to proto query server

* adding total packet recv fee query impl and tests

* updating doc comments

* chore: switch code ordering (cosmos#1025)

* feat: Add ParseKeyFeeEnabled and rename FeeEnabledKey -> KeyFeeEnabled (cosmos#1023)

* chore: add ParseKeyFeesInEscrow helper function

* feat: add ParseKeyFeeEnabled function and rename FeeEnabledKey to KeyFeeEnabled

* feat: ics29 cli for query total recv fees (cosmos#1035)

* feat: grpc query total ack fees (cosmos#1032)

* adding query for total packet recv fees to proto query server

* adding total packet recv fee query impl and tests

* updating doc comments

* adding protos and codegen

* adding total ack fees query and tests

* fixing protodoc comment

* feat: grpc query total timeout fees (cosmos#1033)

* adding query for total packet recv fees to proto query server

* adding total packet recv fee query impl and tests

* updating doc comments

* adding protos and codegen

* adding total ack fees query and tests

* adding protos and codegen

* adding query total timeout fees and tests

* fixing protodoc comment

* fixing protodoc comment

* feat: adding clis for total ack and timeout queries (cosmos#1043)

* add ParseKeyForwardRelayerAddress function + test (cosmos#1046)

* chore: remove unused ics29 keeper funcs (cosmos#1044)

* removing keys, adding additional test, moving event attribute keys

* removing unused code and updating tests

* removing unused IdentifiedPacketFee type

* chore: add gRPC for querying incentivized packets for a specific channel (cosmos#983)

* generate proto files

* feat: add gRPC for querying incentivized packets for a specific channel

* test: add gRPC test for incentivized packets for channel query

* fix build

* partially fix tests

* chore: fix tests

* deduplicate code

* chore: code cleanup

* fix build

* remove changes from merge conflict

* nit: rename c to goCtx

* add function EscrowAccountHasBalance (cosmos#1042)

* add function EscrowAccountHasBalance

* change API to use sdk.Coins

* feat: ParseKeyCounterpartyRelayer function (cosmos#1047)

* chore: adding queries to cmd builder (cosmos#1057)

* chore: update ics29 protodocs (cosmos#1055)

* updating protodocs comments and regen code/docs

* Update proto/ibc/applications/fee/v1/tx.proto

Co-authored-by: colin axnér <[email protected]>

* updating incentivized ack doc

Co-authored-by: colin axnér <[email protected]>

* add counter party channel ID to argument list of on channel open ack (cosmos#1159)

Co-authored-by: Carlos Rodriguez <[email protected]>

* ADR 004: Fee module locking in the presence of severe bugs (cosmos#1060)

* add adr 004

* add to README

* Update docs/architecture/adr-004-ics29-lock-fee-module.md

Co-authored-by: Aditya <[email protected]>

* Update docs/architecture/adr-004-ics29-lock-fee-module.md

Co-authored-by: Aditya <[email protected]>

Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: Aditya <[email protected]>

* nit: packetID var name (cosmos#1214)

* ics29: update with changes from main (cosmos#1221)

* add banner image (cosmos#1158)

Co-authored-by: Carlos Rodriguez <[email protected]>

* Add alpha, beta, and rc release definitions (cosmos#1151)

## Description

The proposed definitions for each phase of our release cycle. Please feel free to adjust my wording

closes: cosmos#881 


---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [ ] Re-reviewed `Files changed` in the Github PR explorer
- [ ] Review `Codecov Report` in the comment section below once CI passes

* build(deps): bump google.golang.org/protobuf from 1.27.1 to 1.28.0 (cosmos#1164)

Bumps [google.golang.org/protobuf](https://github.com/protocolbuffers/protobuf-go) from 1.27.1 to 1.28.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/protocolbuffers/protobuf-go/releases">google.golang.org/protobuf's releases</a>.</em></p>
<blockquote>
<h2>v1.28.0</h2>
<ul>
<li><a href="https://github.com/protocolbuffers/protobuf-go/blob/HEAD/#v1.28-overview">Overview</a></li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/blob/HEAD/#v1.28-notable-changes">Notable changes</a>
<ul>
<li><a href="https://github.com/protocolbuffers/protobuf-go/blob/HEAD/#v1.28-recursion-limit">UnmarshalOption RecursionLimit</a></li>
</ul>
</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/blob/HEAD/#v1.28-breaking-changes">Upcoming breakage changes</a></li>
</ul>
<h2>Overview </h2>
<p>The release provides a new unmarshal option for limiting the recursion depth when unmarshalling nested messages to prevent stack overflows. (<a href="https://pkg.go.dev/google.golang.org/protobuf/proto#UnmarshalOptions.RecursionLimit"><code>UnmarshalOptions.RecursionLimit</code></a>).</p>
<h2>Notable changes </h2>
<p><strong>New features:</strong></p>
<ul>
<li><a href="https://go.dev/cl/340489">CL/340489</a>: testing/protocmp: add Message.Unwrap</li>
</ul>
<p><strong>Documentation improvements:</strong></p>
<ul>
<li><a href="https://go.dev/cl/339569">CL/339569</a>: reflect/protoreflect: add more docs on Value aliasing</li>
</ul>
<p><strong>Updated supported versions:</strong></p>
<ul>
<li><a href="https://go.dev/cl/370055">CL/370055</a>: all: update supported versions</li>
</ul>
<h3>UnmarshalOption RecursionLimit </h3>
<ul>
<li><a href="https://golang.org/cl/385854">CL/385854</a>: all: implement depth limit for unmarshalling</li>
</ul>
<p>The new <a href="https://pkg.go.dev/google.golang.org/protobuf/proto#UnmarshalOptions.RecursionLimit"><code>UnmarshalOptions.RecursionLimit</code></a> limits the maximum recursion depth when unmarshalling messages. The limit is applied for nested messages. When messages are nested deeper than the specified limit the unmarshalling will fail. If unspecified, a default limit of 10,000 is applied.</p>
<p>In addition to the configurable limit for message nesting a non-configurable recursion limit for <a href="https://developers.google.com/protocol-buffers/docs/proto#groups">group</a> nesting of 10,000 was introduced.</p>
<h2>Upcoming breakage changes </h2>
<p>The default recursion limit of 10,000 introduced in the release is subject to change. We want to align this limit with implementations for other languages in the long term. C++ and Java use a limit of 100 which is also the target for the Go implementation.</p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/32051b4f86e54c2142c7c05362c6e96ae3454a1c"><code>32051b4</code></a> all: release v1.28.0</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/3992ea83a23c00882339f33511074d251e19822c"><code>3992ea8</code></a> all: implement depth limit for unmarshaling</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/e5db2960ed1380681b571cdf4648230beefaf58b"><code>e5db296</code></a> all: update supported versions</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/3a9e1dc314e2cb57d6cb054df513f17586295fc7"><code>3a9e1dc</code></a> all: gofmt all</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/26e8bcb3c743193558d1a0ff540c9e05f999267d"><code>26e8bcb</code></a> all: remove unnecessary string([]byte) conversion in fmt.Sprintf with %s</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/5aec41b4809b9822a34e17acd06ae9ae9f41c13d"><code>5aec41b</code></a> testing/protocmp: add Message.Unwrap</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/05be61fde35dcaa3502f4430edee444a294d41c3"><code>05be61f</code></a> reflect/protoreflect: add more docs on Value aliasing</li>
<li><a href="https://github.com/protocolbuffers/protobuf-go/commit/b03064a95cacfede187231741d9918a75653057d"><code>b03064a</code></a> all: start v1.27.1-devel</li>
<li>See full diff in <a href="https://github.com/protocolbuffers/protobuf-go/compare/v1.27.1...v1.28.0">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=google.golang.org/protobuf&package-manager=go_modules&previous-version=1.27.1&new-version=1.28.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

* fix typos in the controller params (cosmos#1172)

## Description



closes: #XXXX

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

- [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [x] Re-reviewed `Files changed` in the Github PR explorer
- [ ] Review `Codecov Report` in the comment section below once CI passes

* add versions for new releases (cosmos#1175)

## Description



closes: #XXXX

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

- [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [x] Re-reviewed `Files changed` in the Github PR explorer
- [ ] Review `Codecov Report` in the comment section below once CI passes

* fix: link checker reporting broken milestone link (cosmos#1200)

* update roadmap for q2 2022 and deleted history roadmap (don't think we'll need it)

* requirements document for ICA (cosmos#1173)

* add requirements document for interchain accounts

* fix branch

* added number in tittle.

* apply suggestions from review

Co-authored-by: Aditya <[email protected]>

* review comment

Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: Aditya <[email protected]>

* imp: improve Logger performance (cosmos#1160)

* fix: Logger marshal errors

* changelog

* update

Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: colin axnér <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Damian Nolan <[email protected]>
Co-authored-by: Aditya <[email protected]>
Co-authored-by: Federico Kunze Küllmer <[email protected]>

Co-authored-by: colin axnér <[email protected]>
Co-authored-by: Sean King <[email protected]>
Co-authored-by: Charly <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: Luke Rhoads <[email protected]>
Co-authored-by: Damian Nolan <[email protected]>
Co-authored-by: Dev Ojha <[email protected]>
Co-authored-by: Jack Zampolin <[email protected]>
Co-authored-by: Federico Kunze Küllmer <[email protected]>
Co-authored-by: Leo Pang <[email protected]>
Co-authored-by: Barrie Byron <[email protected]>
Co-authored-by: Tyler <[email protected]>
Co-authored-by: technicallyty <[email protected]>
Co-authored-by: Barrie Byron <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: Marko Baricevic <[email protected]>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
Co-authored-by: nir1218 <[email protected]>
Co-authored-by: Carlos Rodriguez <[email protected]>
Co-authored-by: Assaf Morami <[email protected]>
Co-authored-by: Dan McCandless <[email protected]>
Co-authored-by: Ramiro Carlucho <[email protected]>
Co-authored-by: frog power 4000 <[email protected]>
Co-authored-by: Sean King <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mpoke mpoke mpoke approved these changes

@jtremback jtremback jtremback approved these changes

@sainoe sainoe Awaiting requested review from sainoe

@danwt danwt Awaiting requested review from danwt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shaspitz @danwt @jtremback @mpoke