Skip to content
This repository has been archived by the owner on Nov 28, 2022. It is now read-only.

All sidechain related wallet RPC commands should be prefixed with sc_ #160

Open
cronicc opened this issue Jul 26, 2021 · 0 comments · Fixed by #186
Open

All sidechain related wallet RPC commands should be prefixed with sc_ #160

cronicc opened this issue Jul 26, 2021 · 0 comments · Fixed by #186
Labels
API freeze before mainnet Defining the final sidechain related API changes before mainnet release RPC Related to RPC/zen-cli commands

Comments

@cronicc
Copy link
Member

cronicc commented Jul 26, 2021

We have a clear distinction between transparent address RPC commands (no prefix) and shielded address RPC commands (z_ prefix).

For some of the sidechain related RPC commands, the sc_ prefix was chosen, but not for all of them.

Wallet commands with sc_ prefix:

sc_create withdrawalEpochLength [{"address":... ,"amount":...,"wCertVk":...,"customData":...,"constant":...,...},...]
sc_send "address" amount "scid"                                                                                      
sc_sendmany [{"address":... ,"amount":...,"scid":,...},...]                                                          

Wallet commands without sc_ prefix:

create_sidechain {"withdrawalEpochLength":... , "fromaddress":..., "toaddress":... ,"amount":... ,"minconf":..., "fee":..., "wCertVk":..., "customData":..., "constant":...}
request_transfer_from_sidechain {TODO}           
send_certificate scid epochNumber quality endEpochCumScTxCommTreeRoot scProof [{"pubkeyhash":... ,"amount":...},...] (subtractfeefromamount) (fee)
send_to_sidechain {...}                                                                                                                           

The sc_ prefix should be added to all sidechain related wallet RPC commands to easily distinguish them. This should be done before the first official release of zend_oo, after the first release changing the API would be problematic.

Prefixing non-wallet related sidechain RPC commands with sc_ could also make sense, but I don't see it as important as for wallet section commands (discuss?).

@cronicc cronicc added RPC Related to RPC/zen-cli commands API freeze before mainnet Defining the final sidechain related API changes before mainnet release labels Jul 26, 2021
@ptagl ptagl linked a pull request Sep 8, 2021 that will close this issue
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
API freeze before mainnet Defining the final sidechain related API changes before mainnet release RPC Related to RPC/zen-cli commands
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant