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

CKB RPC Method Deprecation Process #2247

Closed
doitian opened this issue Aug 26, 2020 · 0 comments · Fixed by #2251
Closed

CKB RPC Method Deprecation Process #2247

doitian opened this issue Aug 26, 2020 · 0 comments · Fixed by #2251
Labels
t:enhancement Type: Feature, refactoring.

Comments

@doitian
Copy link
Member

doitian commented Aug 26, 2020

The project is under active development. Some RPC methods no longer make sense in the new version. We need a way to deprecate the RPC methods and finally remove them.

CKB RPC Method Deprecation Process

A CKB RPC method is deprecated in three steps.

First the method is marked as deprecated in the CKB release notes and RPC document. However, the RPC method is still available. The RPC document will have the suggestion of the alternative solutions.

The CKB dev team will disable any deprecated RPC methods starting from the next minor version release. Users can enable the methods via the command line argument --enable-deprecated-rpc or the config file option enable_deprecated_rpc.

Once a deprecated method is disabled, the CKB dev team will remove it in a future minor version release.

For example, a method is marked as deprecated in 0.35.0, it can be disabled in 0.36.0 and removed in 0.37.0. The minor versions are released monthly, so there's at least two month buffer for a deprecated RPC method.
@doitian doitian added the t:enhancement Type: Feature, refactoring. label Aug 26, 2020
@quake quake mentioned this issue Aug 27, 2020
Merged
bors bot added a commit that referenced this issue Sep 3, 2020
@bors @quake
Merge #2251
285f752 
2251: feat: deprecated rpc method by adding `deprecated.` prefix to the rpc name r=doitian,yangby-cryptape a=quake

resolve #2247, rpc method can be deprecated by adding `deprecated.` prefix to the rpc name:
```diff
+    #[rpc(name = "deprecated.get_cells_by_lock_hash")]
-    #[rpc(name = "get_cells_by_lock_hash")]
    fn get_cells_by_lock_hash
```

Co-authored-by: quake <quake.wang@gmail.com>
@bors bors bot closed this as completed in a2378b5 Sep 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
t:enhancement Type: Feature, refactoring.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: deprecated rpc method by adding deprecated. prefix to the rpc name nervosnetwork/ckb
1 participant
@doitian