Expose network list endpoint (#292)

* Add list network endpoint to sentinels * Add example project * change network type * change param to object param
OpenZeppelin · Jul 28, 2023 · 196ac18 · 196ac18
1 parent 12d67c5
commit 196ac18
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 0 deletions.
diff --git a/examples/list-networks/index.js b/examples/list-networks/index.js
@@ -0,0 +1,14 @@
+require('dotenv').config();
+
+const { SentinelClient } = require('@openzeppelin/defender-sentinel-client');
+
+async function main() {
+  const creds = { apiKey: process.env.ADMIN_API_KEY, apiSecret: process.env.ADMIN_API_SECRET };
+  const client = new SentinelClient(creds);
+  const networks = await client.listNetworks({ networkType: 'production' });
+  console.log(networks);
+}
+
+if (require.main === module) {
+  main().catch(console.error);
+}
diff --git a/examples/list-networks/package.json b/examples/list-networks/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "list-networks",
+  "version": "1.47.0",
+  "private": true,
+  "main": "index.js",
+  "author": "Nami Shah <[email protected]>",
+  "license": "MIT",
+  "scripts": {
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "@openzeppelin/defender-sentinel-client": "1.47.0",
+    "dotenv": "^8.2.0"
+  }
+}
diff --git a/packages/sentinel/README.md b/packages/sentinel/README.md
@@ -373,6 +373,16 @@ await client.pause('8181d9e0-88ce-4db0-802a-2b56e2e6a7b1');
 await client.unpause('8181d9e0-88ce-4db0-802a-2b56e2e6a7b1');
 ```
 
+### List Networks
+
+To list tenant enabled networks, you can call the `listNetworks` function on the client, which returns a `Network[]` object:
+
+```js
+await client.listNetworks(); // lists all networks
+await client.listNetworks({ networkType: 'production' }); // lists only production networks
+await client.listNetworks({ networkType: 'test' }); // lists only test networks
+```
+
 ### Failed Requests
 
 Failed requests might return the following example response object:

diff --git a/packages/sentinel/src/api/index.ts b/packages/sentinel/src/api/index.ts
@@ -28,6 +28,7 @@ import {
   NotificationCategory as NotificationCategoryResponse,
   UpdateNotificationCategoryRequest,
 } from '../models/category';
+import { ListNetworkRequestOptions } from '../models/networks';
 
 export class SentinelClient extends BaseApiClient {
   protected getPoolId(): string {
@@ -42,6 +43,12 @@ export class SentinelClient extends BaseApiClient {
     return process.env.DEFENDER_SENTINEL_API_URL || 'https://defender-api.openzeppelin.com/sentinel/';
   }
 
+  public async listNetworks(opts?: ListNetworkRequestOptions): Promise<Network[]> {
+    return this.apiCall(async (api) => {
+      return await api.get(opts && opts.networkType ? `/networks?type=${opts.networkType}` : `/networks`);
+    });
+  }
+
   public async list(): Promise<ListSentinelResponse> {
     return this.apiCall(async (api) => {
       return await api.get(`/subscribers`);

diff --git a/packages/sentinel/src/models/networks.ts b/packages/sentinel/src/models/networks.ts
@@ -0,0 +1,5 @@
+export type NetworkType = 'production' | 'test';
+
+export interface ListNetworkRequestOptions {
+  networkType?: NetworkType;
+}