Skip to content

get_peers_info -> get_directly_connected_peers #324

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
gcharang merged 3 commits into from
Oct 31, 2024
Merged

get_peers_info -> get_directly_connected_peers #324

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
cae82c5
`get_peers_info` -> `get_directly_connected_peers`
smk762 Sep 10, 2024
333f5c9
Merge branch 'dev' into kdf/rename-method
smk762 Oct 17, 2024
52b79cd
sync dev
gcharang Oct 31, 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
14 changes: 6 additions & 8 deletions filepathSlugs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2325,6 +2325,12 @@
"response-error-active-swap-is-using-the-coin",
"response-error-the-order-is-matched-at-the-moment-but-another-order-is-cancelled"
],
"src/pages/komodo-defi-framework/api/legacy/get_directly_connected_peers/index.mdx": [
"get-directly-connected-peers",
"arguments",
"response",
"example"
],
"src/pages/komodo-defi-framework/api/legacy/get_enabled_coins/index.mdx": [
"get-enabled-coins",
"arguments",
Expand Down Expand Up @@ -2365,14 +2371,6 @@
"command",
"response-success"
],
"src/pages/komodo-defi-framework/api/legacy/get_peers_info/index.mdx": [
"get-peers-info",
"arguments",
"response",
"examples",
"command",
"response-success"
],
"src/pages/komodo-defi-framework/api/legacy/get_relay_mesh/index.mdx": [
"get-relay-mesh",
"arguments",
Expand Down
4 changes: 2 additions & 2 deletions src/data/sidebar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,8 +731,8 @@
"href": "/komodo-defi-framework/api/legacy/get_my_peer_id/"
},
{
"title": "get_peers_info",
"href": "/komodo-defi-framework/api/legacy/get_peers_info/"
"title": "get_directly_connected_peers",
"href": "/komodo-defi-framework/api/legacy/get_directly_connected_peers/"
},
{
"title": "get_relay_mesh",
Expand Down
18 changes: 6 additions & 12 deletions ...ework/api/legacy/get_peers_info/index.mdx → ...cy/get_directly_connected_peers/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
export const title = "Komodo DeFi Framework Method: Get Peers Info";
export const description = "The get_peers_info method all connected peers with their multiaddresses.";
export const description = "The get_directly_connected_peers method returns an array of peers (with their multiaddresses) currently connected to the requesting node.";

# get\_peers\_info
# get\_directly\_connected\_peers

**get\_peers\_info**

The `get_peers_info` method all connected peers with their multiaddresses. See [https://docs.libp2p.io/concepts/addressing/](https://docs.libp2p.io/concepts/addressing/) for more information.
The `get_directly_connected_peers` method all connected peers with their multiaddresses. See [https://docs.libp2p.io/concepts/addressing/](https://docs.libp2p.io/concepts/addressing/) for more information.

## Arguments

Expand All @@ -19,22 +17,18 @@ The `get_peers_info` method all connected peers with their multiaddresses. See [
| --------------------- | ----- | ---------------------------------------------- |
| PeerID-Multiaddresses | Array | All connected peers with their multiaddresses. |

#### 📌 Examples

#### Command
#### 📌 Example

<CodeGroup title="" tag="POST" label="get_peers_info" mm2MethodDecorate="true">
<CodeGroup title="" tag="POST" label="get_directly_connected_peers" mm2MethodDecorate="true">
```json
{
"userpass": "RPC_UserP@SSW0RD",
"method": "get_peers_info"
"method": "get_directly_connected_peers"
}
```
</CodeGroup>

<CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
#### Response (success)

```json
{
"result": {
Expand Down