Add some client examples to docs

bindings/nodejs/examples/how_tos/client/get-health.ts

@@ -0,0 +1,31 @@
+// Copyright 2021-2023 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import { Client, initLogger } from '@iota/sdk';
+require('dotenv').config({ path: '.env' });
+
+// Run with command:
+// yarn run-example ./how_tos/client/get-health.ts
+
+// In this example we will get the node health
+async function run() {
+    initLogger();
+    if (!process.env.NODE_URL) {
+        throw new Error('.env NODE_URL is undefined, see .env.example');
+    }
+
+    const client = new Client({
+        // Insert your node URL in the .env.
+        nodes: [process.env.NODE_URL],
+        localPow: true,
+    });
+
+    try {
+        const isHealthy = await client.getHealth(process.env.NODE_URL);
+        console.log('Healthy: ', isHealthy);
+    } catch (error) {
+        console.error('Error: ', error);
+    }
+}
+
+run().then(() => process.exit());

bindings/nodejs/examples/how_tos/client/get-info.ts

@@ -0,0 +1,31 @@
+// Copyright 2021-2023 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import { Client, initLogger } from '@iota/sdk';
+require('dotenv').config({ path: '.env' });
+
+// Run with command:
+// yarn run-example ./how_tos/client/get-info.ts
+
+// In this example we will get information about the node
+async function run() {
+    initLogger();
+    if (!process.env.NODE_URL) {
+        throw new Error('.env NODE_URL is undefined, see .env.example');
+    }
+
+    const client = new Client({
+        // Insert your node URL in the .env.
+        nodes: [process.env.NODE_URL],
+        localPow: true,
+    });
+
+    try {
+        const nodeInfo = (await client.getInfo()).nodeInfo;
+        console.log(nodeInfo);
+    } catch (error) {
+        console.error('Error: ', error);
+    }
+}
+
+run().then(() => process.exit());

bindings/nodejs/examples/client/03-get-address-outputs.ts → bindings/nodejs/examples/how_tos/client/get-outputs.ts

@@ -5,7 +5,7 @@ import { Client, initLogger } from '@iota/sdk';
 require('dotenv').config({ path: '.env' });
 
 // Run with command:
-// yarn run-example ./client/03-get-address-outputs.ts
+// yarn run-example ./how_tos/client/get-outputs.ts
 
 // In this example we will get the outputs of a known address
 async function run() {
@@ -30,10 +30,11 @@ async function run() {
             { hasTimelock: false },
             { hasStorageDepositReturn: false },
         ]);
-        console.log('Output ids: ', outputIdsResponse, '\n');
+        console.log('First output of query:');
+        console.log('ID: ', outputIdsResponse.items[0]);
 
-        const addressOutputs = await client.getOutputs(outputIdsResponse.items);
-        console.log('Address outputs: ', addressOutputs);
+        const outputs = await client.getOutputs(outputIdsResponse.items);
+        console.log(outputs[0]);
     } catch (error) {
         console.error('Error: ', error);
     }

bindings/python/examples/how_tos/client/get_health.py

@@ -0,0 +1,15 @@
+from iota_sdk import Client
+from dotenv import load_dotenv
+import json
+import os
+
+load_dotenv()
+
+node_url = os.environ.get('NODE_URL', 'https://api.testnet.shimmer.network')
+
+# Create a Client instance
+client = Client(nodes=[node_url])
+
+# Get the node health
+is_healthy = client.get_health(node_url)
+print(f'Healthy: {is_healthy}')

bindings/python/examples/client/00_get_info.py → bindings/python/examples/how_tos/client/get_info.py

@@ -1,5 +1,6 @@
 from iota_sdk import Client
 from dotenv import load_dotenv
+import json
 import os
 
 load_dotenv()
@@ -10,5 +11,5 @@
 client = Client(nodes=[node_url])
 
 # Get the node info
-node_info = client.get_info()
-print(f'{node_info}')
+node_info = client.get_info()["nodeInfo"]
+print(f'{json.dumps(node_info, indent=4)}')

bindings/python/examples/client/03_get_address_outputs.py → bindings/python/examples/how_tos/client/get_outputs.py

@@ -1,5 +1,6 @@
 from iota_sdk import Client, NodeIndexerAPI
 from dotenv import load_dotenv
+import json
 import os
 
 load_dotenv()
@@ -18,8 +19,9 @@
 
 # Get output ids of basic outputs that can be controlled by this address without further unlock constraints
 output_ids_response = client.basic_output_ids(query_parameters)
-print(f'{output_ids_response}')
+print('First output of query:')
+print(f'ID: {output_ids_response.items[0]}')
 
 # Get the outputs by their id
 outputs = client.get_outputs(output_ids_response.items)
-print(f'{outputs}')
+print(f'{json.dumps(outputs[0], indent=4)}')

documentation/sdk/docs/_admonitions/_account-client.md

@@ -0,0 +1,5 @@
+:::tip Client in Wallet
+
+If you are using a wallet you can always get the client by calling the `client()`/`getClient()`/`get_client()` method
+
+:::

documentation/sdk/docs/how-tos/client/get-health.md

@@ -0,0 +1,57 @@
+---
+title: Get Node Health
+description: 'Check any nodes health.'
+image: /img/logo/iota_mark_light.png
+keywords:
+- how to
+- client
+- load balancer
+- node health
+- nodejs
+- python
+- rust
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import NodejsCode from '!!raw-loader!../../../../../bindings/nodejs/examples/how_tos/client/get-health.ts';
+import PythonCode from '!!raw-loader!../../../../../bindings/python/examples/how_tos/client/get_health.py';
+import RustCode from '!!raw-loader!../../../../../sdk/examples/how_tos/client/get_health.rs';
+import AccountClient from '../../_admonitions/_account-client.md'
+
+You can check the health of any node.
+
+<AccountClient/>
+
+The following code example will:
+
+1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network).
+2. Use the created client to get the health of the specified url.
+3. Print the information to the console.
+
+## Code Example
+
+<Tabs groupId="language">
+    <TabItem value="rust" label="Rust">
+        <CodeBlock className="language-rust">
+            {RustCode}
+        </CodeBlock>
+    </TabItem>
+    <TabItem value="nodejs" label="Nodejs">
+        <CodeBlock className="language-typescript">
+            {NodejsCode}
+        </CodeBlock>
+    </TabItem>
+    <TabItem value="python" label="Python">
+        <CodeBlock className="language-python">
+            {PythonCode}
+        </CodeBlock>
+    </TabItem>
+</Tabs>
+
+## Expected Output
+
+```bash
+Healthy: true
+```