Add Canton EA to read from Canton participant node (#4103)

* add canton ea endpoint and transport

* add changeset

* update contract query and input params

* remove unsued functions and refactor code

* update integration tests for new changes

* refactor adapter settings and tests

* add custom return handler with tests

* refactor canton to be extensible and added tests

* update dependencies lock

* remove outdated snapshots

* update external adapter framework version

* remove useless read me

* Add canton-functions path to tsconfig

* add README for canton EA

* upgrade EA version

* update yarn

---------

Co-authored-by: app-token-issuer-data-feeds[bot] <134377064+app-token-issuer-data-feeds[bot]@users.noreply.github.com>
Co-authored-by: Michael Fletcher <michael.fletcher@smartcontract.com>

Author: 3 people

.changeset/fair-geese-beam.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/canton-functions-adapter': major
+---
+
+This EA enables us to read data from Canton participant nodes via the Ledger API

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

.pnp.cjs

@@ -0,0 +1,56 @@
+# CANTON_FUNCTIONS
+
+![1.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/canton-functions/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
+
+This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info.
+
+## Environment Variables
+
+| Required? |         Name          |                                        Description                                        |  Type  | Options | Default |
+| :-------: | :-------------------: | :---------------------------------------------------------------------------------------: | :----: | :-----: | :-----: |
+|    ✅     |      AUTH_TOKEN       |                       JWT token for Canton JSON API authentication                        | string |         |         |
+|           | BACKGROUND_EXECUTE_MS | The amount of time the background execute should sleep before performing the next request | number |         | `1000`  |
+|    ✅     |          URL          |                                  The Canton JSON API URL                                  | string |         |         |
+|    ✅     |      TEMPLATE_ID      |        The template ID to query contracts for (format: packageId:Module:Template)         | string |         |         |
+|    ✅     |        CHOICE         |                   The non-consuming choice to exercise on the contract                    | string |         |         |
+|           |       ARGUMENT        |                         The argument for the choice (JSON string)                         | string |         |         |
+|           |    CONTRACT_FILTER    |          Filter to query contracts when contractId is not provided (JSON string)          | string |         |         |
+
+---
+
+## Data Provider Rate Limits
+
+There are no rate limits for this adapter.
+
+---
+
+## Input Parameters
+
+| Required? |   Name   |     Description     |  Type  |               Options                |    Default    |
+| :-------: | :------: | :-----------------: | :----: | :----------------------------------: | :-----------: |
+|           | endpoint | The endpoint to use | string | [canton-data](#canton-data-endpoint) | `canton-data` |
+
+## Canton-data Endpoint
+
+`canton-data` is the only supported name for this endpoint.
+
+### Input Params
+
+| Required? |    Name    | Aliases |              Description              |  Type  | Options | Default | Depends On | Not Valid With |
+| :-------: | :--------: | :-----: | :-----------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
+|           | contractId |         | The contract ID to exercise choice on | string |         |         |            |                |
+
+### Example
+
+Request:
+
+```json
+{
+  "data": {
+    "endpoint": "canton-data",
+    "contractId": "00e1f5c6d8b9a7f4e3c2d1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c0"
+  }
+}
+```
+
+---

packages/sources/canton-functions/CHANGELOG.md

@@ -0,0 +1,42 @@
+{
+  "name": "@chainlink/canton-functions-adapter",
+  "version": "1.0.0",
+  "description": "Chainlink canton-functions adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "canton-functions"
+  ],
+  "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": {
+    "@sinonjs/fake-timers": "9.1.2",
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.14.1",
+    "@types/sinonjs__fake-timers": "8.1.5",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.11.5",
+    "tslib": "2.4.1"
+  }
+}

packages/sources/canton-functions/README.md

@@ -0,0 +1,41 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  AUTH_TOKEN: {
+    description: 'JWT token for Canton JSON API authentication',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+  BACKGROUND_EXECUTE_MS: {
+    description:
+      'The amount of time the background execute should sleep before performing the next request',
+    type: 'number',
+    default: 1_000,
+  },
+  URL: {
+    description: 'The Canton JSON API URL',
+    type: 'string',
+    required: true,
+  },
+  TEMPLATE_ID: {
+    description: 'The template ID to query contracts for (format: packageId:Module:Template)',
+    type: 'string',
+    required: true,
+  },
+  CHOICE: {
+    description: 'The non-consuming choice to exercise on the contract',
+    type: 'string',
+    required: true,
+  },
+  ARGUMENT: {
+    description: 'The argument for the choice (JSON string)',
+    type: 'string',
+    required: false,
+  },
+  CONTRACT_FILTER: {
+    description: 'Filter to query contracts when contractId is not provided (JSON string)',
+    type: 'string',
+    required: false,
+  },
+})

packages/sources/canton-functions/package.json

@@ -0,0 +1,39 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import { cantonDataTransport } from '../transport/canton-data'
+
+export const inputParameters = new InputParameters(
+  {
+    contractId: {
+      description: 'The contract ID to exercise choice on',
+      type: 'string',
+      required: false,
+    },
+  },
+  [
+    {
+      contractId: '00e1f5c6d8b9a7f4e3c2d1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c0',
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Data: {
+      result: string
+      exerciseResult: any
+      contract?: any
+    }
+    Result: string
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'canton-data',
+  aliases: [],
+  transport: cantonDataTransport,
+  inputParameters,
+})

packages/sources/canton-functions/src/config/index.ts

@@ -0,0 +1 @@
+export { endpoint as cantonData } from './canton-data'