Merge branch 'main' into main

Author: mxiao-cll

.changeset/thirty-ducks-wait.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/liveart-adapter': major
+---
+
+LiveArt EA initial release

.pnp.cjs

@@ -0,0 +1,40 @@
+{
+  "name": "@chainlink/liveart-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink liveart adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "liveart"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "url": "https://github.com/smartcontractkit/external-adapters-js",
+    "type": "git"
+  },
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist && rm -f tsconfig.tsbuildinfo",
+    "prepack": "yarn build",
+    "build": "tsc -b",
+    "server": "node -e 'require(\"./index.js\").server()'",
+    "server:dist": "node -e 'require(\"./dist/index.js\").server()'",
+    "start": "yarn server:dist"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.14.1",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.11.0",
+    "tslib": "2.4.1"
+  }
+}

packages/sources/liveart/package.json

@@ -0,0 +1,10 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config: AdapterConfig = new AdapterConfig({
+  API_BASE_URL: {
+    description: 'The API URL for the LiveArt data provider',
+    type: 'string',
+    required: true,
+    default: 'https://artwork-price-oracle-api-ms.liveart.ai',
+  },
+})

packages/sources/liveart/src/config/index.ts

@@ -0,0 +1 @@
+export { endpoint as nav } from './nav'

packages/sources/liveart/src/endpoint/index.ts

@@ -0,0 +1,25 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+
+import { httpTransport } from '../transport/nav'
+
+export const inputParameters = new InputParameters(
+  {
+    assetId: {
+      required: true,
+      type: 'string',
+      description: 'The ID of the artwork asset to fetch',
+    },
+  },
+  [
+    {
+      assetId: 'KUSPUM',
+    },
+  ],
+)
+
+export const endpoint = new AdapterEndpoint({
+  name: 'nav',
+  transport: httpTransport,
+  inputParameters,
+})

packages/sources/liveart/src/endpoint/nav.ts

@@ -0,0 +1,22 @@
+import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
+import { Adapter } from '@chainlink/external-adapter-framework/adapter'
+
+import { config } from './config'
+import { nav } from './endpoint'
+
+export const adapter = new Adapter({
+  defaultEndpoint: nav.name,
+  name: 'LIVE_ART',
+  config,
+  endpoints: [nav],
+  rateLimiting: {
+    tiers: {
+      default: {
+        rateLimit1s: 1,
+        note: 'Setting reasonable default limits',
+      },
+    },
+  },
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

packages/sources/liveart/src/index.ts

@@ -0,0 +1,85 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports/http'
+import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
+import { config } from '../config'
+import { inputParameters } from '../endpoint/nav'
+
+export interface ResponseSchema {
+  asset_id: string
+  asset_info_category: string
+  asset_info_creator: string
+  asset_info_title: string
+  asset_info_year_created: string
+  asset_info_description: string
+  asset_info_url: string
+  current_estimated_nav_usd: string
+  current_estimated_nav_updated_at: string
+  token_total_shares: number
+  token_current_estimated_nav_per_share_usd: string
+  offering_price_usd: string
+  success: boolean
+  message: string
+  response_timestamp: string
+}
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: SingleNumberResultResponse
+  Settings: typeof config.settings
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+export const httpTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, adapterSettings) => {
+    return params.map((param) => {
+      return {
+        params: [param],
+        request: {
+          baseURL: adapterSettings.API_BASE_URL,
+          url: `/asset/${param.assetId}`,
+        },
+      }
+    })
+  },
+  parseResponse: (params, response) => {
+    return params.map((param) => {
+      if (param.assetId !== response.data.asset_id) {
+        return {
+          params: param,
+          response: {
+            errorMessage: `Mismatched asset_id in response. Expected ${param.assetId}, got ${response.data.asset_id}`,
+            statusCode: 502,
+          },
+        }
+      }
+      const responseData = response.data
+
+      if (!responseData.success)
+        return {
+          params: param,
+          response: {
+            errorMessage: responseData.message,
+            statusCode: 502,
+          },
+        }
+
+      const navString = responseData.token_current_estimated_nav_per_share_usd
+      const result = parseFloat(navString)
+
+      return {
+        params: param,
+        response: {
+          result,
+          data: {
+            result,
+          },
+        },
+      }
+    })
+  },
+})

packages/sources/liveart/src/transport/nav.ts

@@ -0,0 +1,48 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`LiveArt NAV endpoints nav framework should handle API 422 bad response 1`] = `
+{
+  "errorMessage": "Provider request failed with status 422: {"detail":[{"type":"enum","loc":["path","asset_id"],"msg":"Input should be 'KUSPUM', 'ROLSUB', 'KOODOG', 'BANGIR', 'MURFLO', 'HOCPOOL' or 'HARPLA'","input":"abcd","ctx":{"expected":"'KUSPUM', 'ROLSUB', 'KOODOG', 'BANGIR', 'MURFLO', 'HOCPOOL' or 'HARPLA'"}}]}",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`LiveArt NAV endpoints nav should handle upstream bad response for unsuccessful request 1`] = `
+{
+  "errorMessage": "Asset ID 'AssetId.ROLSUB' not found",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`LiveArt NAV endpoints nav should return error for invalid assetId 1`] = `
+{
+  "errorMessage": "Mismatched asset_id in response. Expected invalid-asset-id, got KUSPUM",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`LiveArt NAV endpoints nav should return success for valid assetId 1`] = `
+{
+  "data": {
+    "result": 0.09630117,
+  },
+  "result": 0.09630117,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;

packages/sources/liveart/test/integration/__snapshots__/adapter.test.ts.snap

@@ -0,0 +1,105 @@
+import {
+  TestAdapter,
+  setEnvVariables,
+} from '@chainlink/external-adapter-framework/util/testing-utils'
+import * as nock from 'nock'
+
+import {
+  mockHappyPathResponseSuccessAsset,
+  mockResponseApiFailureAsset,
+  mockResponseFailureAsset,
+} from './utils/fixtures'
+import { TEST_FAILURE_ASSET_ID, TEST_SUCCESS_ASSET_ID, TEST_URL } from './utils/testConfig'
+import { clearTestCache } from './utils/utilFunctions'
+
+describe('LiveArt NAV', () => {
+  let testAdapter: TestAdapter
+  let spy: jest.SpyInstance
+  let oldEnv: NodeJS.ProcessEnv
+
+  beforeAll(async () => {
+    oldEnv = JSON.parse(JSON.stringify(process.env))
+    // Mock time for request's timestamp
+    const mockDate = new Date('2001-01-01T11:11:11.111Z')
+    spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
+    // Set environment variables
+    process.env.API_BASE_URL = TEST_URL
+    process.env.BACKGROUND_EXECUTE_MS = '0'
+
+    // Create adapter instance only once
+    const adapter = (await import('../../src')).adapter
+    adapter.rateLimiting = undefined
+    testAdapter = await TestAdapter.startWithMockedCache(adapter, {
+      testAdapter: {} as TestAdapter<never>,
+    })
+  })
+
+  afterAll(async () => {
+    clearTestCache(testAdapter)
+    await testAdapter.api.close()
+    spy.mockRestore()
+    setEnvVariables(oldEnv)
+    nock.restore()
+    nock.cleanAll()
+  })
+
+  describe('endpoints', () => {
+    describe('nav', () => {
+      it('should return success for valid assetId', async () => {
+        const dataInput = {
+          assetId: TEST_SUCCESS_ASSET_ID,
+          endpoint: 'nav',
+        }
+
+        mockHappyPathResponseSuccessAsset(dataInput.assetId)
+        const response = await testAdapter.request(dataInput)
+
+        expect(response.statusCode).toBe(200)
+        expect(response.json()).toMatchSnapshot()
+      })
+
+      it('should return error for invalid assetId', async () => {
+        const data = {
+          assetId: 'invalid-asset-id',
+          endpoint: 'nav',
+        }
+
+        // Mock for other assetId
+        mockHappyPathResponseSuccessAsset(data.assetId)
+
+        const response = await testAdapter.request(data)
+        expect(response.statusCode).toBe(502)
+        expect(response.json()).toMatchSnapshot()
+      })
+
+      it('should handle upstream bad response for unsuccessful request', async () => {
+        const data = {
+          assetId: TEST_FAILURE_ASSET_ID,
+          endpoint: 'nav',
+        }
+
+        mockResponseFailureAsset(data.assetId)
+
+        const response = await testAdapter.request(data)
+        expect(response.statusCode).toBe(502)
+        expect(response.json()).toMatchSnapshot()
+      })
+
+      it('framework should handle API 422 bad response', async () => {
+        const data = {
+          assetId: 'abcd',
+          endpoint: 'nav',
+        }
+
+        // prep cache
+        await testAdapter.request(data)
+
+        mockResponseApiFailureAsset()
+
+        const response = await testAdapter.request(data)
+        expect(response.statusCode).toBe(502)
+        expect(response.json()).toMatchSnapshot()
+      })
+    })
+  })
+})