feat: add address book client methods (#589)

* feat: add address book client methods

* refactor: use addresstype for type param

* fix: package version

Author: MCarlomagno

e2e/src/address-book.test.ts

@@ -0,0 +1,30 @@
+require('dotenv').config();
+import { Defender } from '@openzeppelin/defender-sdk';
+
+// Default timeout is not enough, using 15s timeout instead.
+jest.setTimeout(15 * 1000);
+
+describe('address-book', () => {
+  const addressBookClient = new Defender({
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+  }).addressBook;
+
+  it('should list addresses', async () => {
+    const result = await addressBookClient.list();
+    expect(result).toBeDefined();
+  });
+
+  it('should create and delete an address', async () => {
+    const result = await addressBookClient.create({
+      address: '0x1234567890123456789012345678901234567890',
+      network: 'mainnet',
+      type: 'EOA',
+      alias: 'My Address',
+    });
+    expect(result.addressBookId).toBe('mainnet|0x1234567890123456789012345678901234567890');
+
+    const deleteResult = await addressBookClient.delete(result.addressBookId);
+    expect(deleteResult.message).toBe('mainnet|0x1234567890123456789012345678901234567890 deleted');
+  });
+});

examples/address-book-actions/index.js

@@ -0,0 +1,29 @@
+require('dotenv').config();
+
+const { Defender } = require('@openzeppelin/defender-sdk');
+
+async function main() {
+  const client = new Defender({
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+  });
+
+  const addresses = await client.addressBook.list();
+  console.log('addresses:', addresses);
+
+  const created = await client.addressBook.create({
+    address: '0x1A8943463a20f55B8BC7a318dB77C4AEDBC3fae6',
+    name: 'My EOA Address',
+    network: 'sepolia',
+    type: 'EOA',
+    alias: 'Deployer EOA address',
+  });
+  console.log('created address:', created);
+
+  const deleteRes = await client.addressBook.delete(created.addressBookId);
+  console.log(deleteRes);
+}
+
+if (require.main === module) {
+  main().catch(console.error);
+}

examples/address-book-actions/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@openzeppelin/defender-sdk-example-address-book-actions",
+  "version": "1.14.4",
+  "private": true,
+  "main": "index.js",
+  "author": "OpenZeppelin Defender <defender@openzeppelin.com>",
+  "license": "MIT",
+  "scripts": {
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "@openzeppelin/defender-sdk": "1.15.0",
+    "dotenv": "^16.3.1"
+  }
+}

packages/address-book/README.md

@@ -0,0 +1,5 @@
+# Defender SDK Address Book Client
+
+The OpenZeppelin Defender provides a security operations (SecOps) platform for Ethereum with built-in best practices. Development teams implement Defender to ship faster and minimize security risks.
+
+This library provides methods related to address book. See Examples for usage.

packages/address-book/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../jest.config');

packages/address-book/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@openzeppelin/defender-sdk-address-book-client",
+  "version": "1.15.0",
+  "description": "",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "rm -rf lib && tsc",
+    "test": "npm run test:unit",
+    "test:unit": "jest --verbose --passWithNoTests --forceExit",
+    "watch": "tsc -w"
+  },
+  "files": [
+    "lib",
+    "!*.test.js",
+    "!*.test.js.map",
+    "!*.test.d.ts",
+    "!*__mocks__"
+  ],
+  "author": "OpenZeppelin Defender <defender@openzeppelin.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@openzeppelin/defender-sdk-base-client": "^1.15.0",
+    "lodash": "^4.17.21",
+    "dotenv": "^16.3.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/address-book/src/api/index.ts

@@ -0,0 +1,31 @@
+import { BaseApiClient } from '@openzeppelin/defender-sdk-base-client';
+import { AddressBookResponse, CreateAddressBookRequest } from '../models/address-book';
+
+const PATH = '/address-book';
+
+export class AddressBookClient extends BaseApiClient {
+  protected getPoolId(): string {
+    return process.env.DEFENDER_POOL_ID ?? 'us-west-2_94f3puJWv';
+  }
+
+  protected getPoolClientId(): string {
+    return process.env.DEFENDER_POOL_CLIENT_ID ?? '40e58hbc7pktmnp9i26hh5nsav';
+  }
+
+  protected getApiUrl(): string {
+    return process.env.DEFENDER_API_URL ?? 'https://defender-api.openzeppelin.com/';
+  }
+
+  public async list(): Promise<AddressBookResponse[]> {
+    return this.apiCall(async (api) => api.get(`${PATH}`));
+  }
+
+  public async create(address: CreateAddressBookRequest): Promise<AddressBookResponse> {
+    return this.apiCall(async (api) => api.post(`${PATH}`, address));
+  }
+
+  public async delete(addressBookId: string): Promise<{ message: string }> {
+    const encodedId = encodeURIComponent(addressBookId);
+    return this.apiCall(async (api) => api.delete(`${PATH}/${encodedId}`));
+  }
+}

packages/address-book/src/index.ts

@@ -0,0 +1,5 @@
+export { AddressBookClient } from './api';
+export { AddressBookResponse } from './models/address-book';
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+export const VERSION = require('../package.json').version;

packages/address-book/src/models/address-book.ts

@@ -0,0 +1,30 @@
+export type AddressType =
+  | 'EOA'
+  | 'Contract'
+  | 'Multisig'
+  | 'Gnosis Safe'
+  | 'Safe'
+  | 'Gnosis Multisig'
+  | 'Relayer'
+  | 'Unknown'
+  | 'Timelock Controller'
+  | 'ERC20'
+  | 'Governor'
+  | 'Fireblocks';
+
+export type AddressBookResponse = {
+  addressBookId: string;
+  address: string;
+  network: string;
+  type: AddressType;
+  alias: string;
+};
+
+export type CreateAddressBookRequest = {
+  address: string;
+  network: string;
+  type: AddressType;
+  alias?: string;
+  symbol?: string;
+  decimals?: number;
+};

packages/address-book/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "code-style/tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "./lib",
+    "skipLibCheck": true,
+    "sourceMap": false
+  },
+  "include": ["./src"],
+  "exclude": ["**/*.test.ts", "**/__mocks__/*"]
+}