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

chore!(gateway): add deprecation notices #2360

Merged
merged 4 commits into from
Jun 14, 2023

Conversation

distractedm1nd
Copy link
Collaborator

  • Adds a warn log on startup if --gateway is passed
  • Deprecated endpoints are now disabled by default. This includes:
    • /balance
    • /submit_pfd
    • /query_delegation
    • /query_unbonding
    • /query_redelegations
  • Deprecated endpoints can be activated by passing --gateway.deprecated-endpoints
  • When using deprecated endpoints, the node will log a warning, giving the alternative RPC method to call in the future.

The ugly config change/flag will be removed when fully deprecating the endpoints

@distractedm1nd distractedm1nd added kind:break! Attached to breaking PRs area:api Related to celestia-node API labels Jun 13, 2023
@distractedm1nd distractedm1nd self-assigned this Jun 13, 2023
Copy link
Member

@Wondertan Wondertan left a comment

Choose a reason for hiding this comment

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

Lovely way of deprecating things! J
ust one suggestion

nodebuilder/gateway/module.go Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Jun 13, 2023

Codecov Report

Merging #2360 (c751639) into main (c41738a) will increase coverage by 0.01%.
The diff coverage is 13.79%.

@@            Coverage Diff             @@
##             main    #2360      +/-   ##
==========================================
+ Coverage   50.84%   50.85%   +0.01%     
==========================================
  Files         154      154              
  Lines        9746     9757      +11     
==========================================
+ Hits         4955     4962       +7     
- Misses       4355     4359       +4     
  Partials      436      436              
Impacted Files Coverage Δ
api/gateway/das.go 0.00% <0.00%> (ø)
api/gateway/endpoints.go 0.00% <0.00%> (ø)
api/gateway/state.go 9.54% <50.00%> (+1.69%) ⬆️

... and 4 files with indirect coverage changes

Copy link
Member

@renaynay renaynay left a comment

Choose a reason for hiding this comment

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

I'm okay with this. Can you please make an issue to remove all this code on next release please? @distractedm1nd

@distractedm1nd distractedm1nd merged commit d77d0f2 into main Jun 14, 2023
@distractedm1nd distractedm1nd deleted the gateway-deprecation-notice branch June 14, 2023 08:18
jcstein added a commit to celestiaorg/docs that referenced this pull request Jun 29, 2023
jcstein added a commit to celestiaorg/docs that referenced this pull request Jul 5, 2023
jcstein added a commit to celestiaorg/docs that referenced this pull request Jul 5, 2023
* fix: update mocha-2 from mocha in consensus-full-node.md

* deps: bump to mocha-3

* docs: add sov labs/dymension and alphabetize rollup menu (#789)

* docs: add Sovereign SDK to sidebar on docs

* alphabetize rollup category

* docs: add dymension

* rearrange order

* Update taro-testnet.md

* Update taro-testnet.md

* docs: resolve #803

* Update rpc-tutorial.mdx

* docs: update to RPC CLI only

* cleanup

* fix: broken links

* edit for '"gm"'

* docs: edit upgrade binary section

* add scaffold-eth and thirdweb

* hide scaffold for now

* Apply suggestions from code review

* fix: delete redundant subheadings (#815)

* style: collapse OP section

* docs: resolve #820

* docs: add network upgrade channel

resolves #812

* docs: add node api page for category

resolves #810

* fix: linting

* docs: improve node tut

* fix: nsid length to match #825

* docs: add demos page (#828)

* docs: add version tags for every network & add mocha chain id variable (#832)

* docs: add version tags for every network & add mocha chain id variable

resolves #813
resolves #831

* fix: linting from md to mdx

* add links from @rootulp's suggestion

* fix: start commands for *current* version of arabica (#834)

* Update taro-testnet.md (#836)

fixed some grammatical things that bugged me

* Update light-node.mdx (#837)

The current command to start the light node in the docs "https://docs.celestia.org/nodes/light-node/" is provided with an incomplete RPC endpoint. A minor correction to -> "consensus-full-arabica-8.celestia-arabica.com" solves this.

* docs: update node tutorial to resolve #807 and #811 (#825)

* docs: add back balanceForAddress to RPC tut (#829)

Resolves #806

* docs: match celestia-app repo (#844)

* docs: match celestia-app repo

* fix: build

* Update latest_tags.yml (#846)

* docs: update full consensus node graphic (#852)

* docs: fix link to github instead of dead demo

* [automated GH action] update latest release tags & commit sha (arabica)

* deps: add gateway deprecated flag

in alignment with celestiaorg/celestia-node#2360

* docs: upgrade to arabica-9

* docs: bump to arabica-9 in versions/constants.js

* [automated GH action] update latest release tags & commit sha (arabica) (#858)

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

* sidebar-update (#856)

Made sidebar totally collapsible

* [automated GH action] update latest release tags & commit sha (mocha) (#859)

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

* mocha-3

---------

Co-authored-by: Yaz Khoury <[email protected]>
Co-authored-by: Christian Holman <[email protected]>
Co-authored-by: Hachiman <[email protected]>
Co-authored-by: Matthew Sevey <[email protected]>
Co-authored-by: jcstein <[email protected]>
Co-authored-by: Yaz Khoury <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: YazzyYaz <[email protected]>
Co-authored-by: Wholesomebruh <[email protected]>
jcstein added a commit to celestiaorg/docs that referenced this pull request Sep 21, 2023
jcstein added a commit to celestiaorg/docs that referenced this pull request Sep 21, 2023
* fix: update mocha-2 from mocha in consensus-full-node.md

* deps: bump to mocha-3

* docs: add sov labs/dymension and alphabetize rollup menu (#789)

* docs: add Sovereign SDK to sidebar on docs

* alphabetize rollup category

* docs: add dymension

* rearrange order

* Update taro-testnet.md

* Update taro-testnet.md

* docs: resolve #803

* Update rpc-tutorial.mdx

* docs: update to RPC CLI only

* cleanup

* fix: broken links

* edit for '"gm"'

* docs: edit upgrade binary section

* add scaffold-eth and thirdweb

* hide scaffold for now

* Apply suggestions from code review

* fix: delete redundant subheadings (#815)

* style: collapse OP section

* docs: resolve #820

* docs: add network upgrade channel

resolves #812

* docs: add node api page for category

resolves #810

* fix: linting

* docs: improve node tut

* fix: nsid length to match #825

* docs: add demos page (#828)

* docs: add version tags for every network & add mocha chain id variable (#832)

* docs: add version tags for every network & add mocha chain id variable

resolves #813
resolves #831

* fix: linting from md to mdx

* add links from @rootulp's suggestion

* fix: start commands for *current* version of arabica (#834)

* Update taro-testnet.md (#836)

fixed some grammatical things that bugged me

* Update light-node.mdx (#837)

The current command to start the light node in the docs "https://docs.celestia.org/nodes/light-node/" is provided with an incomplete RPC endpoint. A minor correction to -> "consensus-full-arabica-8.celestia-arabica.com" solves this.

* docs: update node tutorial to resolve #807 and #811 (#825)

* docs: add back balanceForAddress to RPC tut (#829)

Resolves #806

* docs: match celestia-app repo (#844)

* docs: match celestia-app repo

* fix: build

* Update latest_tags.yml (#846)

* docs: update full consensus node graphic (#852)

* docs: fix link to github instead of dead demo

* [automated GH action] update latest release tags & commit sha (arabica)

* deps: add gateway deprecated flag

in alignment with celestiaorg/celestia-node#2360

* docs: upgrade to arabica-9

* docs: bump to arabica-9 in versions/constants.js

* [automated GH action] update latest release tags & commit sha (arabica) (#858)

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

* sidebar-update (#856)

Made sidebar totally collapsible

* [automated GH action] update latest release tags & commit sha (mocha) (#859)

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

* mocha-3

---------

Co-authored-by: Yaz Khoury <[email protected]>
Co-authored-by: Christian Holman <[email protected]>
Co-authored-by: Hachiman <[email protected]>
Co-authored-by: Matthew Sevey <[email protected]>
Co-authored-by: jcstein <[email protected]>
Co-authored-by: Yaz Khoury <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: YazzyYaz <[email protected]>
Co-authored-by: Wholesomebruh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Related to celestia-node API kind:break! Attached to breaking PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants