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.

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

doc: update funding readme with redemption restrictions #3914

Merged
merged 6 commits into from Sep 5, 2023

Conversation

dandanlen
Copy link
Collaborator

Pull Request

Closes: PRO-428

@linear
Copy link

linear bot commented Aug 29, 2023

PRO-428 Documentation for vesting address changes

See PRO-238 and PRO-403

The new behaviour for restricted and bound redemption addresses needs to be documented in the gitbook.

@codecov
Copy link

codecov bot commented Aug 29, 2023

Codecov Report

Merging #3914 (afa6be2) into main (cbcc213) will decrease coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main   #3914   +/-   ##
=====================================
- Coverage     72%     72%   -0%     
=====================================
  Files        366     366           
  Lines      56783   56783           
  Branches   56783   56783           
=====================================
- Hits       40950   40944    -6     
- Misses     13748   13750    +2     
- Partials    2085    2089    +4     

see 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@@ -30,16 +30,50 @@ The user then needs to execute the redemption on the `StateChainGateway` contrac

A validator can have at most one open redemption at any given time. They must either execute the redemption, or wait for expiry until initiating a new redemption.

Choose a reason for hiding this comment

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

what's the expiration time? if you make a mistake then you're blocked that long

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

On perseverance I believe it's a couple of hours. On mainnet it will likely be longer. We need to find a balance between giving enough time to execute, but not so long that it becomes annoying. In general, i don't expect many mistakes to be made, it's not that complicated.

We also don't want people to abuse it - for example by creating redemption requests "just in case" and allowing most of them to expire.

- `Witnesser`. See the [Witness](../cf-witnesser) pallet for an implementation.
- `Funding`. See the [Flip](../cf-flip) pallet for an implementation.
- `EpochInfo`. See the [Validator](../cf-validator) pallet for an implementation.
Funds are bonded when a validator wins an authority slot in the auction. A validator may withdraw an FLIP in excess of the bond.

Choose a reason for hiding this comment

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

didnt get the last sentence 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

any*

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oops yep

state-chain/pallets/cf-funding/README.md Outdated Show resolved Hide resolved
state-chain/pallets/cf-funding/README.md Outdated Show resolved Hide resolved
state-chain/pallets/cf-funding/README.md Outdated Show resolved Hide resolved
dandanlen and others added 3 commits September 5, 2023 12:32
Co-authored-by: Jamie Ford <jamie@chainflip.io>
Co-authored-by: Jamie Ford <jamie@chainflip.io>
Co-authored-by: Jamie Ford <jamie@chainflip.io>
@dandanlen
Copy link
Collaborator Author

Thanks for the proof-reading @j4m1ef0rd

@dandanlen dandanlen enabled auto-merge (squash) September 5, 2023 10:33
@dandanlen dandanlen merged commit ffe6687 into main Sep 5, 2023
42 checks passed
@dandanlen dandanlen deleted the doc/redemption-restrictions branch September 5, 2023 11:11
dandanlen added a commit that referenced this pull request Sep 6, 2023
Co-authored-by: Jamie Ford <jamie@chainflip.io>
dandanlen added a commit that referenced this pull request Sep 6, 2023
Co-authored-by: Jamie Ford <jamie@chainflip.io>
syan095 added a commit that referenced this pull request Sep 8, 2023
…on-integration

* origin/main:
  fix: scale encoding skip phantom data (#3967)
  chore: make platform team code owner of CI settings.toml and localnet (#3957)
  fix: prefer finalize_signed_extrinsic in engine (#3956)
  fix: CanonicalAssetPair encoding issue (#3958)
  chore(bouncer): Update sdk to 0.0.40 (#3945)
  fix: tweak cli generate-keys output (#3943)
  chore: add `preinst` script unit tests 🧪 (#3942)
  Better LP/Broker API RPC Errors (#3931)
  fix: update substrate ref to use Kademlia fix (#3941)
  doc: update funding readme with redemption restrictions (#3914)
  feat: PRO-474 broadcast safe mode (#3902)
  feat: more forgiving dot address parsing (#3938)
  fix: duplicate logging (#3939)
  feat: new lp interface (#3886)

# Conflicts:
#	Cargo.lock
#	state-chain/cf-integration-tests/Cargo.toml
#	state-chain/cf-integration-tests/src/authorities.rs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants