Secure Mint EA (#3902)

* Secure Mint EA

* Add tests

* Fix test

* Rename latestRelevantBlocks

Author: mxiao-cll

.changeset/cold-boats-sniff.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/secure-mint-adapter': major
+---
+
+First release

.pnp.cjs

@@ -0,0 +1,3 @@
+# Chainlink External Adapter for secure-mint
+
+This README will be generated automatically when code is merged to `main`. If you would like to generate a preview of the README, please run `yarn generate:readme secure-mint`.

.yarn/cache/ethers-npm-6.14.3-629d34af0f-ce68b962f1.zip

@@ -0,0 +1,41 @@
+{
+  "name": "@chainlink/secure-mint-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink secure-mint adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "secure-mint"
+  ],
+  "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",
+    "ethers": "^6.14.3",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.6.0",
+    "tslib": "2.4.1"
+  }
+}

packages/composites/secure-mint/CHANGELOG.md

@@ -0,0 +1,35 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig(
+  {
+    SECURE_MINT_INDEXER_URL: {
+      description: 'Url to secure-mint-indexer',
+      type: 'string',
+      required: true,
+    },
+    BITGO_RESERVES_EA_URL: {
+      description: 'Url to Bitgo Reserves EA',
+      type: 'string',
+      default: '',
+    },
+
+    BACKGROUND_EXECUTE_MS: {
+      description:
+        'The amount of time the background execute should sleep before performing the next request',
+      type: 'number',
+      default: 1_000,
+    },
+  },
+  {
+    // Unlike regular EA where input is fixed for a specifc feed, this EA,
+    // input is dynamic for a feed. Hence we would want to have
+    // - a small subscription set (as old request will not be used once we've moved on)
+    // - a small TTL on subscriptions
+    // - a small cache on result
+    envDefaultOverrides: {
+      SUBSCRIPTION_SET_MAX_ITEMS: 1000,
+      WARMUP_SUBSCRIPTION_TTL: 60_000,
+      CACHE_MAX_AGE: 60_000,
+    },
+  },
+)

packages/composites/secure-mint/README.md

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

packages/composites/secure-mint/package.json

@@ -0,0 +1,89 @@
+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 { mintableTransport } from '../transport/mintable'
+import { IndexerResponse } from '../transport/supply'
+
+export const inputParameters = new InputParameters(
+  {
+    token: {
+      required: true,
+      type: 'string',
+      description: 'Name of the token',
+    },
+    reserves: {
+      required: true,
+      type: 'string',
+      description: 'Name of the reserve data provider',
+      options: ['Bitgo'],
+    },
+    supplyChains: {
+      required: true,
+      type: 'string',
+      array: true,
+      description: 'List of chains the token is on',
+    },
+    supplyChainBlocks: {
+      required: true,
+      type: 'number',
+      array: true,
+      description: 'The target block correspond to each chain in supplyChains',
+    },
+  },
+  [
+    {
+      token: 'token1',
+      reserves: 'Bitgo',
+      supplyChains: ['1', '56'],
+      supplyChainBlocks: [100, 400],
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Result: number
+    Data: {
+      overmint: boolean
+      mintables: {
+        [key: string]: {
+          mintable: string
+          block: number
+        }
+      }
+      reserveInfo: {
+        reserveAmount: string
+        timestamp: number
+      }
+      latestBlocks: {
+        [key: string]: number
+      }
+      supplyDetails: IndexerResponse
+    }
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'mintable',
+  transport: mintableTransport,
+  inputParameters,
+  customInputValidation: (req, adapterSettings): AdapterInputError | undefined => {
+    const { reserves, supplyChains, supplyChainBlocks } = req.requestContext.data
+    if (supplyChains.length !== supplyChainBlocks.length) {
+      throw new AdapterInputError({
+        statusCode: 400,
+        message: `supplyChains and supplyChainBlocks do not have the same length`,
+      })
+    }
+    if (reserves === 'Bitgo' && adapterSettings.BITGO_RESERVES_EA_URL.length === 0) {
+      throw new AdapterInputError({
+        statusCode: 400,
+        message: `Error: missing environment variable BITGO_RESERVES_EA_URL`,
+      })
+    }
+    return
+  },
+})

packages/composites/secure-mint/src/config/index.ts

@@ -0,0 +1,13 @@
+import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
+import { Adapter } from '@chainlink/external-adapter-framework/adapter'
+import { config } from './config'
+import { mintable } from './endpoint'
+
+export const adapter = new Adapter({
+  defaultEndpoint: mintable.name,
+  name: 'SECURE_MINT',
+  config,
+  endpoints: [mintable],
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)