Feat: add getDeletegates (#124)

* Feat: add getDeletegates

* Update the lint action

* Upgrade minor versions

Author: katspaugh

.github/workflows/lint.yml

@@ -1,19 +1,17 @@
 name: 'Lint'
 on: [pull_request]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   eslint:
     runs-on: ubuntu-latest
     steps:
-      - name: Cancel previous runs
-        uses: styfle/[email protected]
-        with:
-          access_token: ${{ github.token }}
-
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Yarn install
-        run: yarn install --immutable
+      - run: npm install
 
       - uses: Maggi64/eslint-plus-action@master
         with:

.github/workflows/test.yml

@@ -1,11 +1,15 @@
 name: 'Unit tests'
 on: [pull_request]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: npm install
 
       - name: Run tests

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/safe-gateway-typescript-sdk",
-  "version": "3.7.3",
+  "version": "3.8.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

src/index.ts

@@ -22,6 +22,7 @@ import type { MasterCopyReponse } from './types/master-copies'
 import type { DecodedDataResponse } from './types/decoded-data'
 import type { SafeMessage, SafeMessageListPage } from './types/safe-messages'
 import { DEFAULT_BASE_URL } from './config'
+import type { DelegateResponse, DelegatesRequest } from './types/delegates'
 
 export * from './types/safe-info'
 export * from './types/safe-apps'
@@ -343,4 +344,14 @@ export function confirmSafeMessage(
   })
 }
 
+/**
+ * Returns a list of delegates
+ */
+export function getDelegates(chainId: string, query: DelegatesRequest = {}): Promise<DelegateResponse> {
+  return getEndpoint(baseUrl, '/v1/chains/{chainId}/delegates', {
+    path: { chainId },
+    query,
+  })
+}
+
 /* eslint-enable @typescript-eslint/explicit-module-boundary-types */

src/types/api.ts

@@ -26,6 +26,7 @@ import type {
   SafeMessage,
   SafeMessageListPage,
 } from './safe-messages'
+import type { DelegateResponse, DelegatesRequest } from './delegates'
 
 export type Primitive = string | number | boolean | null
 
@@ -260,6 +261,15 @@ export interface paths extends PathRegistry {
       }
     }
   }
+  '/v1/chains/{chainId}/delegates': {
+    get: operations['get_delegates']
+    parameters: {
+      path: {
+        chainId: string
+      }
+      query: DelegatesRequest
+    }
+  }
 }
 
 export interface operations {
@@ -666,4 +676,17 @@ export interface operations {
       }
     }
   }
+  get_delegates: {
+    parameters: {
+      path: {
+        chainId: string
+      }
+      query: DelegatesRequest
+    }
+    responses: {
+      200: {
+        schema: DelegateResponse
+      }
+    }
+  }
 }

src/types/delegates.ts

@@ -0,0 +1,37 @@
+import type { Page } from './common'
+
+export type Delegate = {
+  safe?: string
+  delegate: string
+  delegator: string
+  label: string
+}
+
+export type DelegateResponse = Page<Delegate>
+
+export type DelegatesRequest = {
+  safe?: string
+  delegate?: string
+  delegator?: string
+  label?: string
+}
+
+export type AddDelegateRequest = {
+  safe?: string
+  delegate: string
+  delegator: string
+  signature: string
+  label: string
+}
+
+export type DeleteDelegateRequest = {
+  delegate: string
+  delegator: string
+  signature: string
+}
+
+export type DeleteSafeDelegateRequest = {
+  safe: string
+  delegate: string
+  signature: string
+}