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

feat(rpc): Add a stop rpc method #8839

Merged
merged 5 commits into from
Sep 9, 2024
Merged

feat(rpc): Add a stop rpc method #8839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d9fca01
add a `stop` rpc method
oxarbitrage Sep 4, 2024
30fb3c7
add todo comment
oxarbitrage Sep 5, 2024
87a0405
add a ticket number to the TODO
oxarbitrage Sep 5, 2024
db5d169
Merge branch 'main' into stop-rpc
mpguerra Sep 6, 2024
35d0edc
Merge branch 'main' into stop-rpc
oxarbitrage Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 59 additions & 26 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ paths:
default: getinfo
id:
type: string
default: VuJXrxLSw8
default: QWlDS9bxlK
params:
type: array
items: {}
Expand Down Expand Up @@ -61,7 +61,7 @@ paths:
default: getblockchaininfo
id:
type: string
default: HDVqYXM9m6
default: XSg3wvZykA
params:
type: array
items: {}
Expand Down Expand Up @@ -99,7 +99,7 @@ paths:
default: getaddressbalance
id:
type: string
default: Xw5TDBKXGl
default: GEd1QJWprH
params:
type: array
items: {}
Expand Down Expand Up @@ -147,7 +147,7 @@ paths:
default: sendrawtransaction
id:
type: string
default: QaJv2bXyZu
default: nhQi7D6Oru
params:
type: array
items: {}
Expand Down Expand Up @@ -196,7 +196,7 @@ paths:
default: getblock
id:
type: string
default: k0DACJrgZs
default: qIEYMzgbJZ
params:
type: array
items: {}
Expand Down Expand Up @@ -239,7 +239,7 @@ paths:
default: getbestblockhash
id:
type: string
default: rIFaLhZwHF
default: P9UBS8IXXU
params:
type: array
items: {}
Expand Down Expand Up @@ -272,7 +272,7 @@ paths:
default: getbestblockheightandhash
id:
type: string
default: oxrhh1swvh
default: gQNhsomx7N
params:
type: array
items: {}
Expand Down Expand Up @@ -305,7 +305,7 @@ paths:
default: getrawmempool
id:
type: string
default: E7oUD34jk2
default: c2ScL31PtX
params:
type: array
items: {}
Expand Down Expand Up @@ -343,7 +343,7 @@ paths:
default: z_gettreestate
id:
type: string
default: Hp22XK728i
default: JQ0mENKbdm
params:
type: array
items: {}
Expand Down Expand Up @@ -393,7 +393,7 @@ paths:
default: z_getsubtreesbyindex
id:
type: string
default: Cs69hg68pl
default: bZUCv4t0f4
params:
type: array
items: {}
Expand Down Expand Up @@ -432,7 +432,7 @@ paths:
default: getrawtransaction
id:
type: string
default: iu395PEErc
default: I0FAejAi4r
params:
type: array
items: {}
Expand Down Expand Up @@ -480,7 +480,7 @@ paths:
default: getaddresstxids
id:
type: string
default: z3lOKfsQdp
default: '3fMzDHOglf'
params:
type: array
items: {}
Expand Down Expand Up @@ -528,7 +528,7 @@ paths:
default: getaddressutxos
id:
type: string
default: '7U4Q4dSxej'
default: LE2AR8Tr6X
params:
type: array
items: {}
Expand All @@ -554,6 +554,39 @@ paths:
error:
type: string
default: Invalid parameters
/stop:
post:
tags:
- control
description: Stop the running zebrad process.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
method:
type: string
default: stop
id:
type: string
default: PbxxqB0ZpF
params:
type: array
items: {}
default: '[]'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
result:
type: object
default: 'null'
/getblockcount:
post:
tags:
Expand All @@ -571,7 +604,7 @@ paths:
default: getblockcount
id:
type: string
default: '8yw3EX7Cwi'
default: WO6BAIKSCg
params:
type: array
items: {}
Expand Down Expand Up @@ -609,7 +642,7 @@ paths:
default: getblockhash
id:
type: string
default: ndDYksCl9E
default: vHpKNIQRLF
params:
type: array
items: {}
Expand Down Expand Up @@ -657,7 +690,7 @@ paths:
default: getblocktemplate
id:
type: string
default: lJi2hfxty1
default: L04jp5F2QW
params:
type: array
items: {}
Expand Down Expand Up @@ -695,7 +728,7 @@ paths:
default: submitblock
id:
type: string
default: '9fEFOdTQle'
default: Izn7vhiMaA
params:
type: array
items: {}
Expand Down Expand Up @@ -728,7 +761,7 @@ paths:
default: getmininginfo
id:
type: string
default: Dytpq4f3lF
default: SgyuBQbMik
params:
type: array
items: {}
Expand Down Expand Up @@ -761,7 +794,7 @@ paths:
default: getnetworksolps
id:
type: string
default: yX3woRnOaN
default: FXg2iH3eaX
params:
type: array
items: {}
Expand Down Expand Up @@ -794,7 +827,7 @@ paths:
default: getnetworkhashps
id:
type: string
default: AyAZMtbezv
default: '2PWjf8QqfI'
params:
type: array
items: {}
Expand Down Expand Up @@ -827,7 +860,7 @@ paths:
default: getpeerinfo
id:
type: string
default: nNcrsu3ZAR
default: OE9s5wkP0w
params:
type: array
items: {}
Expand Down Expand Up @@ -865,7 +898,7 @@ paths:
default: validateaddress
id:
type: string
default: LGyfO7zTjW
default: '6FS4iGA4Ht'
params:
type: array
items: {}
Expand Down Expand Up @@ -903,7 +936,7 @@ paths:
default: z_validateaddress
id:
type: string
default: '2Q09a2Nh4N'
default: utp8tN61yU
params:
type: array
items: {}
Expand Down Expand Up @@ -941,7 +974,7 @@ paths:
default: getblocksubsidy
id:
type: string
default: nv6lOWCRso
default: dgNZGo7lNa
params:
type: array
items: {}
Expand Down Expand Up @@ -984,7 +1017,7 @@ paths:
default: getdifficulty
id:
type: string
default: '2O3A0PF1SS'
default: KEJv30D2MI
params:
type: array
items: {}
Expand Down Expand Up @@ -1022,7 +1055,7 @@ paths:
default: z_listunifiedreceivers
id:
type: string
default: XYgGcDIx2X
default: lfBqvYghGm
params:
type: array
items: {}
Expand Down
25 changes: 25 additions & 0 deletions zebra-rpc/src/methods.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,18 @@ pub trait Rpc {
&self,
address_strings: AddressStrings,
) -> BoxFuture<Result<Vec<GetAddressUtxos>>>;

#[rpc(name = "stop")]
/// Stop the running zebrad process.
///
/// # Notes
///
/// Only works if the network of the running zebrad process is `Regtest`.
///
/// zcashd reference: [`stop`](https://zcash.github.io/rpc/stop.html)
/// method: post
/// tags: control
fn stop(&self) -> Result<()>;
}

/// RPC method implementations.
Expand Down Expand Up @@ -1344,6 +1356,19 @@ where
}
.boxed()
}

fn stop(&self) -> Result<()> {
if self.network.is_regtest() {
// TODO: Use graceful termination in `stop` RPC (#8850)
std::process::exit(0);
upbqdn marked this conversation as resolved.
Show resolved Hide resolved
} else {
Err(Error {
code: ErrorCode::MethodNotFound,
message: "stop is only available on regtest networks".to_string(),
data: None,
})
}
}
}

/// Returns the best chain tip height of `latest_chain_tip`,
Expand Down
1 change: 1 addition & 0 deletions zebra-utils/src/bin/openapi-generator/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,7 @@ fn get_default_properties(method_name: &str) -> Result<IndexMap<String, Property
)?,
// control
"getinfo" => default_property(type_, items.clone(), GetInfo::default())?,
"stop" => default_property(type_, items.clone(), ())?,
// transaction
"sendrawtransaction" => {
default_property(type_, items.clone(), SentTransactionHash::default())?
Expand Down
Loading