Skip to content

Commit 357c02b

Browse files
NullSoldierhughy
andauthored
Add documentation for chain/isValidPublicAddress (#762)
* Add documentation for chain/isValidPublicAddress * Update content/documentation/rpc/chain/is_valid_public_address.mdx Co-authored-by: Hugh Cunningham <[email protected]> --------- Co-authored-by: Hugh Cunningham <[email protected]>
1 parent c8f8521 commit 357c02b

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: chain/isValidPublicAddress
3+
description: RPC Chain | Iron Fish Documentation
4+
---
5+
6+
Checks whether a given public address is valid
7+
8+
A valid public address is one that is well formed, not one that is guaranteed to belong to a wallet.
9+
10+
#### Request
11+
12+
```ts
13+
{
14+
address: string
15+
}
16+
```
17+
18+
#### Response
19+
20+
```ts
21+
{
22+
valid: boolean;
23+
}
24+
```
25+
26+
###### [View on Github](https://github.com/iron-fish/ironfish/blob/master/ironfish/src/rpc/routes/chain/isValidPublicAddress.ts)

content/documentation/sidebar.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,10 @@ export const sidebar: SidebarDefinition = [
307307
id: "rpc/chain/show_chain",
308308
label: "showChain",
309309
},
310+
{
311+
id: "rpc/chain/is_valid_public_address",
312+
label: "isValidPublicAddress",
313+
},
310314
],
311315
},
312316
{

0 commit comments

Comments
 (0)