view function Aptos (#3704)

Author: mxiao-cll

.changeset/chatty-sheep-swim.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/view-function-multi-chain-adapter': minor
+---
+
+Aptos

packages/scripts/src/schema-flatten/lib.ts

@@ -124,7 +124,7 @@ function createChainlinkLabsResolver() {
 
   const resolver: $RefParser.ResolverOptions = {
     order: 1,
-    canRead: /^https:\/\/external-adapters\.chainlinklabs\.com$/i,
+    canRead: /^https:\/\/external-adapters\.chainlinklabs\.com\//i,
     read: (file, callback) => {
       if (!callback) {
         console.error('[resolver] No callback found')

packages/sources/view-function-multi-chain/src/config/index.ts

@@ -1,6 +1,13 @@
 import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
 
 export const config = new AdapterConfig({
+  APTOS_URL: {
+    description: 'Aptos rest api url',
+    type: 'string',
+    required: false,
+    default: '',
+  },
+
   BACKGROUND_EXECUTE_MS: {
     description:
       'The amount of time the background execute should sleep before performing the next request',

packages/sources/view-function-multi-chain/src/endpoint/aptos.ts

@@ -0,0 +1,55 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+import { config } from '../config'
+import { aptosTransport } from '../transport/aptos'
+
+export const inputParameters = new InputParameters({
+  signature: {
+    type: 'string',
+    aliases: ['function'],
+    required: true,
+    description: 'Function signature. Format: {address}::{module name}::{function name}',
+  },
+  arguments: {
+    array: true,
+    description: 'Arguments of the function',
+    type: 'string',
+  },
+  type: {
+    array: true,
+    description: 'Type arguments of the function',
+    type: 'string',
+  },
+  index: {
+    description: 'Which item in the function output array to return',
+    type: 'number',
+    default: 0,
+  },
+})
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Data: {
+      result: string
+    }
+    Result: string
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'aptos',
+  transport: aptosTransport,
+  inputParameters,
+  customInputValidation: (_, adapterSettings): AdapterInputError | undefined => {
+    if (!adapterSettings['APTOS_URL']) {
+      throw new AdapterInputError({
+        statusCode: 400,
+        message: `Error: missing environment variable APTOS_URL`,
+      })
+    }
+    return
+  },
+})

packages/sources/view-function-multi-chain/src/endpoint/index.ts

@@ -1 +1,2 @@
 export { endpoint as functionEndpoint } from './function'
+export { endpoint as aptosEndpoint } from './aptos'

packages/sources/view-function-multi-chain/src/index.ts

@@ -1,13 +1,21 @@
 import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
 import { Adapter } from '@chainlink/external-adapter-framework/adapter'
 import { config } from './config'
-import { functionEndpoint } from './endpoint'
+import { functionEndpoint, aptosEndpoint } from './endpoint'
 
 export const adapter = new Adapter({
   defaultEndpoint: functionEndpoint.name,
   name: 'VIEW_FUNCTION_MULTI_CHAIN',
   config,
-  endpoints: [functionEndpoint],
+  endpoints: [functionEndpoint, aptosEndpoint],
+  rateLimiting: {
+    tiers: {
+      default: {
+        rateLimit1s: 1,
+        note: 'Reasonable limits',
+      },
+    },
+  },
 })
 
 export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

packages/sources/view-function-multi-chain/src/transport/aptos.ts

@@ -0,0 +1,76 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/aptos'
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: { function: string; type_arguments: string[]; arguments: string[] }
+    ResponseBody:
+      | any[]
+      | {
+          message: string
+          error_code: string
+          vm_error_code: number
+        }
+  }
+}
+export const aptosTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, config) => {
+    return params.map((param) => {
+      return {
+        params: [param],
+        request: {
+          baseURL: config.APTOS_URL,
+          url: '/view',
+          method: 'POST',
+          headers: {
+            'Content-Type': 'application/json',
+          },
+          data: {
+            function: param.signature,
+            type_arguments: param.type,
+            arguments: param.arguments,
+          },
+        },
+      }
+    })
+  },
+  parseResponse: (params, response) => {
+    if (response.data instanceof Array) {
+      if (params[0].index >= response.data.length) {
+        return [
+          {
+            params: params[0],
+            response: {
+              errorMessage: `index ${
+                params[0].index
+              } is more than result array length ${JSON.stringify(response.data)}`,
+              statusCode: 502,
+            },
+          },
+        ]
+      }
+      return response.data.map((elem, i) => ({
+        params: {
+          ...params[0],
+          index: i,
+        },
+        response: {
+          result: elem,
+          data: {
+            result: elem,
+          },
+        },
+      }))
+    } else {
+      return [
+        {
+          params: params[0],
+          response: {
+            errorMessage: JSON.stringify(response.data),
+            statusCode: 502,
+          },
+        },
+      ]
+    }
+  },
+})

packages/sources/view-function-multi-chain/test/integration/__snapshots__/adapter.test.ts.snap

@@ -1,8 +1,22 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`execute aptos endpoint should return success 1`] = `
+{
+  "data": {
+    "result": 1,
+  },
+  "result": 1,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
 exports[`execute function endpoint should return error for invalid input 1`] = `
 {
-  "errorMessage": "no matching function (argument="key", value="symbol() view returns (string)", code=INVALID_ARGUMENT, version=6.13.4)",
+  "errorMessage": "no matching function (argument="key", value="symbol() view returns (string)", code=INVALID_ARGUMENT, version=6.13.5)",
   "statusCode": 502,
   "timestamps": {
     "providerDataReceivedUnixMs": 0,

packages/sources/view-function-multi-chain/test/integration/adapter.test.ts

@@ -6,6 +6,7 @@ import * as nock from 'nock'
 import {
   mockETHGoerliContractCallResponseSuccess,
   mockETHMainnetContractCallResponseSuccess,
+  mockAptosSuccess,
 } from './fixtures'
 import * as process from 'process'
 
@@ -23,10 +24,12 @@ describe('execute', () => {
       process.env.ETHEREUM_GOERLI_RPC_URL ?? 'http://localhost:8554'
     process.env.ETHEREUM_GOERLI_CHAIN_ID = process.env.ETHEREUM_GOERLI_CHAIN_ID ?? '5'
     process.env.BACKGROUND_EXECUTE_MS = '0'
+    process.env.APTOS_URL = process.env.APTOS_URL ?? 'http://fake-aptos'
     const mockDate = new Date('2001-01-01T11:11:11.111Z')
     spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
 
     const adapter = (await import('./../../src')).adapter
+    adapter.rateLimiting = undefined
     testAdapter = await TestAdapter.startWithMockedCache(adapter, {
       testAdapter: {} as TestAdapter<never>,
     })
@@ -110,4 +113,16 @@ describe('execute', () => {
       expect(response.json()).toMatchSnapshot()
     })
   })
+
+  describe('aptos endpoint', () => {
+    it('should return success', async () => {
+      mockAptosSuccess()
+      const response = await testAdapter.request({
+        endpoint: 'aptos',
+        signature: '0x1::chain_id::get',
+      })
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
 })

packages/sources/view-function-multi-chain/test/integration/fixtures.ts

@@ -118,3 +118,21 @@ export const mockETHGoerliContractCallResponseSuccess = (): nock.Scope =>
       ],
     )
     .persist()
+
+export const mockAptosSuccess = (): nock.Scope =>
+  nock('http://fake-aptos', {
+    encodedQueryParams: true,
+  })
+    .persist()
+    .post('/view')
+    .reply(200, () => [1], [
+      'Content-Type',
+      'application/json',
+      'Connection',
+      'close',
+      'Vary',
+      'Accept-Encoding',
+      'Vary',
+      'Origin',
+    ])
+    .persist()