Skip to content

Added plugins_reloadPluginConfig #184

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

Merged
MadelineMurray merged 3 commits into from
Feb 21, 2020
Merged

Added plugins_reloadPluginConfig #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c841633
Added plugins_reloadPluginConfig
MadelineAu Feb 18, 2020
6da3508
Added reload plugin config method
MadelineAu Feb 20, 2020
1e4afde
Merge branch 'master' into reloadAPINew
MadelineMurray Feb 21, 2020
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
3 changes: 2 additions & 1 deletion docs/HowTo/Interact/APIs/Using-JSON-RPC-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ curl -v 'http://localhost:8545/liveness'
The `ETH`, `NET`, and `WEB3` API methods are enabled by default.

Use the [`--rpc-http-api`](../../../Reference/CLI/CLI-Syntax.md#rpc-http-api) or [`--rpc-ws-api`](../../../Reference/CLI/CLI-Syntax.md#rpc-ws-api)
options to enable the `ADMIN`, `CLIQUE`, `DEBUG`, `EEA`, `IBFT`, `MINER`, `PERM`, and `TXPOOL` API methods.
options to enable the `ADMIN`, `CLIQUE`, `DEBUG`, `EEA`, `IBFT`, `MINER`, `PERM`, `PLUGINS`, `PRIV`,
and `TXPOOL` API methods.

## Block Parameter

Expand Down
35 changes: 35 additions & 0 deletions docs/Reference/API-Methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4535,6 +4535,41 @@ Returns information about the private transaction after the transaction was mine
}
}
```

## Plugins Methods

!!! note
The `PLUGINS` API methods are not enabled by default for JSON-RPC. Use the [`--rpc-http-api`](CLI/CLI-Syntax.md#rpc-http-api)
or [`--rpc-ws-api`](CLI/CLI-Syntax.md#rpc-ws-api) options to enable the `PLUGINS` API methods.

### plugins_reloadPluginConfig

Reloads specified plugin configuration.

**Parameters**

`string` - Plugin

**Returns**

`string` - `Success`

!!! example
```bash tab="curl HTTP request"
curl -X POST --data '{"jsonrpc":"2.0","method":"plugins_reloadPluginConfig","params":["tech.pegasys.plus.plugin.kafka.KafkaPlugin"],"id":1}' http://127.0.0.1:8545
```

```bash tab="wscat WS request"
{"jsonrpc":"2.0","method":"plugins_reloadPluginConfig","params":["tech.pegasys.plus.plugin.kafka.KafkaPlugin"],"id":1}
```

```json tab="JSON result"
{
"jsonrpc": "2.0",
"id": 1,
"result": "Success"
}
```

## Miscellaneous Methods

Expand Down
6 changes: 4 additions & 2 deletions docs/Reference/CLI/CLI-Syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1362,7 +1362,8 @@ rpc-http-api=["ETH","NET","WEB3"]

Comma-separated APIs to enable on the HTTP JSON-RPC channel.
When you use this option, the `--rpc-http-enabled` option must also be specified.
The available API options are: `ADMIN`, `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `PERM`, `DEBUG`, `MINER`, `EEA`, `PRIV`, and `TXPOOL`.
The available API options are: `ADMIN`, `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `PERM`, `DEBUG`,
`MINER`, `EEA`, `PRIV`, `PLUGINS`, and `TXPOOL`.
The default is: `ETH`, `NET`, `WEB3`.

!!!tip
Expand Down Expand Up @@ -1561,7 +1562,8 @@ rpc-ws-api=["ETH","NET","WEB3"]

Comma-separated APIs to enable on WebSockets channel.
When you use this option, the `--rpc-ws-enabled` option must also be specified.
The available API options are: `ADMIN`,`ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `PERM`, `DEBUG`, `MINER`, `EEA`, `PRIV`, and `TXPOOL`.
The available API options are: `ADMIN`,`ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `PERM`, `DEBUG`,
`MINER`, `EEA`, `PRIV`, `PLUGINS`, and `TXPOOL`.
The default is: `ETH`, `NET`, `WEB3`.

!!!tip
Expand Down