Add the owned safes endpoint; add e2e tests; parse error message (#15)

* Add the owned safes endpoint; add e2e tests; parse error message

* Run prettier

* Replace reviewdog

* Update the error handling and tests

* Bump version

Author: katspaugh

.github/workflows/lint.yml

@@ -6,4 +6,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: reviewdog/action-eslint@master
+      - uses: gnosis/safe-react-eslint-plus-action@main

.github/workflows/test.yml

@@ -7,10 +7,11 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - run: npm install
-      - run: npm test
-      - uses: mattallty/jest-github-action@master
+
+      - name: Run tests
+        uses: mattallty/jest-github-action@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CI: true
         with:
-          test-command: 'echo done'
+          test-command: 'npm run test:ci -- --outputFile=/home/runner/work/_actions/mattallty/jest-github-action/v1/dist/jest.results.json'
+          coverage-comment: false

.prettierrc

@@ -4,4 +4,4 @@
   "trailingComma": "all",
   "singleQuote": true,
   "semi": false
-}
+}

README.md

@@ -14,12 +14,12 @@ This will create a folder called `openapi` with an OpenAPI JSON and the correspo
 
 ## Adding an endpoint
 
-Endpoints are defined in `src/types/gateway.ts` and `src/index.ts. Each endpoint consists of:
+Endpoints are defined in `src/types/gateway.ts` and `src/index.ts`. Each endpoint consists of:
 
-* a path definition
-* operation definition (params and response types)
-* response definition
-* a function that fetches the endpoint
+- a path definition
+- operation definition (params and response types)
+- response definition
+- a function that fetches the endpoint
 
 To add a new endpoint, follow the pattern set by the existing endpoints.
 
@@ -33,8 +33,8 @@ yarn eslint:fix
 
 ## Tests
 
-To run the tests:
+To run the tests locally:
 
 ```
-jest test --watch
+yarn test
 ```

babel.config.js

@@ -1,6 +1,3 @@
 module.exports = {
-  presets: [
-    ['@babel/preset-env', { targets: { node: 'current' } }],
-    '@babel/preset-typescript',
-  ],
-};
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+}

e2e/config.ts

@@ -0,0 +1,5 @@
+const config = {
+  baseUrl: 'https://safe-client.staging.gnosisdev.com/v1',
+}
+
+export default config

e2e/get-owned-safes.test.ts

@@ -0,0 +1,22 @@
+import { getOwnedSafes } from '../src'
+import config from './config'
+
+describe('getOwnedSages tests', () => {
+  it('should get owned safes on rinkeby', async () => {
+    const data = await getOwnedSafes(config.baseUrl, '4', '0x661E1CF4aAAf6a95C89EA8c81D120E6c62adDFf9')
+
+    expect(data).toEqual({
+      safes: ['0x9B5dc27B104356516B05b02F6166a54F6D74e40B', '0xb3b83bf204C458B461de9B0CD2739DB152b4fa5A'],
+    })
+  })
+
+  it('should return an empty array if no owned safes', async () => {
+    const data = await getOwnedSafes(config.baseUrl, '1', '0x661E1CF4aAAf6a95C89EA8c81D120E6c62adDFf9')
+    expect(data).toEqual({ safes: [] })
+  })
+
+  it('should throw for bad addresses', async () => {
+    const req = getOwnedSafes(config.baseUrl, '4', '0x661E1CF4aAAf6a95C89EA8c81D120E6c62adDfF9')
+    await expect(req).rejects.toThrow('1: Checksum address validation failed')
+  })
+})

e2e/propose-transaction.test.ts

@@ -0,0 +1,25 @@
+import { proposeTransaction } from '../src'
+import config from './config'
+
+describe('proposeTransaction tests', () => {
+  it('should propose a transaction and fail', async () => {
+    const req = proposeTransaction(config.baseUrl, '4', '0x4f9BD57BCC68Bf7770429F137922B3afD23d83E7', {
+      to: '0x49d4450977E2c95362C13D3a31a09311E0Ea26A6',
+      value: '0',
+      data: '0xe8dde2320000000000000000000000000000000000000000000000000000000000000000',
+      operation: 0,
+      nonce: '1',
+      safeTxGas: '39557',
+      baseGas: '0',
+      gasPrice: '0',
+      gasToken: '0x0000000000000000000000000000000000000000',
+      refundReceiver: '0x0000000000000000000000000000000000000000',
+      safeTxHash: '0x98798b6d9400b25397e85eb79c444a06f93d153555c1d7fd026176f02055a824',
+      sender: '0x474e5Ded6b5D078163BFB8F6dBa355C3aA5478C8',
+      origin: null,
+    })
+    await expect(req).rejects.toThrow(
+      '1337: {"nonFieldErrors":["Tx with safe-tx-hash=0x98798b6d9400b25397e85eb79c444a06f93d153555c1d7fd026176f02055a824 for safe=0x4f9BD57BCC68Bf7770429F137922B3afD23d83E7 was already executed in tx-hash=0x1baa941b8696ff3b0a8831f11da243a02f028122b6298ee61e3a1c0d5eeb171a"]}',
+    )
+  })
+})

e2e/safes-read.test.ts

@@ -0,0 +1,29 @@
+import { getSafeInfo } from '../src'
+import config from './config'
+
+describe('getSafeInfo tests', () => {
+  it('should get safe info on rinkeby', async () => {
+    const address = '0x9B5dc27B104356516B05b02F6166a54F6D74e40B'
+    const data = await getSafeInfo(config.baseUrl, '4', address)
+
+    expect(data.address.value).toBe(address)
+    expect(data.guard).toBe(null)
+    expect(data.nonce).toBe(3)
+    expect(data.owners).toEqual([
+      {
+        value: '0x21D62C6894741DE97944D7844ED44D7782C66ABC',
+      },
+      {
+        value: '0x661E1CF4aAAf6a95C89EA8c81D120E6c62adDFf9',
+      },
+      {
+        value: '0x8814db983b821D65647C565fBf7c1092fC32437D',
+      },
+      {
+        value: '0x474e5Ded6b5D078163BFB8F6dBa355C3aA5478C8',
+      },
+    ])
+    expect(data.threshold).toBe(1)
+    expect(data.version).toBe('1.1.1')
+  })
+})

jest.config.js

@@ -191,4 +191,4 @@ module.exports = {
 
   // Whether to use watchman for file crawling
   // watchman: true,
-};
+}