From f75ba115a5a4402a03cf02f8e848972739af08a7 Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Fri, 13 Nov 2026 18:32:57 +0200 Subject: [PATCH 01/11] add isPSConfigured flag, add node owner info in status request --- .env.example | 1 + docs/API.md | 5 +++ docs/env.md | 1 + src/@types/OceanNode.ts | 7 ++++ src/OceanNode.ts | 2 + src/components/core/utils/statusHandler.ts | 11 ++++++ src/test/unit/maintenanceMode.test.ts | 44 ++++++++++++++++++++++ src/utils/config.ts | 15 ++++++++ src/utils/constants.ts | 5 +++ 9 files changed, 91 insertions(+) diff --git a/.env.example b/.env.example index dc975f4a7..dda7eb784 100644 --- a/.env.example +++ b/.env.example @@ -43,6 +43,7 @@ export LOG_LEVEL= export HTTP_API_PORT= export VALIDATE_UNSIGNED_DDO= export JWT_SECRET= +export NODE_OWNER_INFO= export UNSAFE_URLS= export ALLOWED_PRIVATE_URL_RANGES= diff --git a/docs/API.md b/docs/API.md index 08f9249f1..ba723766c 100644 --- a/docs/API.md +++ b/docs/API.md @@ -951,6 +951,11 @@ returns status of node "version": "123", "http": true, "p2p": true, + "isPSConfigured": false, + "ownerInfo": { + "imprint": { "legalName": "Acme Ltd", "email": "legal@acme.com" }, + "termsAndConditions": { "url": "https://acme.com/terms" } + }, "provider": [], "indexer": [], "supportedStorage": { diff --git a/docs/env.md b/docs/env.md index dcbed34d4..2eb097d79 100644 --- a/docs/env.md +++ b/docs/env.md @@ -36,6 +36,7 @@ Environmental variables are also tracked in `ENVIRONMENT_VARIABLES` within `src/ - `AUTHORIZED_PUBLISHERS_LIST`: AccessList contract addresses (per chain). If present, Node will only index assets published by the accounts present on the given access lists. Example: `"{ \"8996\": [\"0x967da4048cD07aB37855c090aAF366e4ce1b9F48\",\"0x388C818CA8B9251b393131C08a736A67ccB19297\"] }"` - `VALIDATE_UNSIGNED_DDO`: If set to `false`, the node will not validate unsigned DDOs and will request a signed message with the publisher address, nonce and signature. Default is `true`. Example: `false` - `JWT_SECRET`: Secret used to sign JWT tokens. Default is `ocean-node-secret`. Example: `"my-secret-jwt-token"` +- `NODE_OWNER_INFO`: Optional JSON object with the node owner's legal/contact info, returned as `ownerInfo` by the `status` command (HTTP and P2P). Free-form; omitted from status when unset or not a JSON object. Example: `'{"imprint":{"legalName":"Acme Ltd","email":"legal@acme.com","url":"https://acme.com","address":"1 Main St"},"termsAndConditions":{"url":"https://acme.com/terms"},"privacyPolicy":{"url":"https://acme.com/privacy"}}'` - `PERSISTENT_STORAGE`: Persistent storage config. See [persistent storage](persistentStorage.md). - `UNSAFE_URLS`: JSON array of regular expressions. A caller-supplied URL (the `url` / `ftp` file objects used by fileInfo, download, encrypt, compute inputs and compute-output upload) matching any of them is rejected. The entries are **added to** the built-in defaults (the cloud metadata endpoints such as `169.254.169.254` and `metadata.google.internal`, and `127.0.0.1`), so setting this variable never drops the defaults. Example: `["^https?://internal\\.example\\.com"]` - `ALLOWED_PRIVATE_URL_RANGES`: By default the node refuses to contact URLs whose host is, or resolves to, a private, loopback, link-local, CGNAT, multicast or otherwise reserved address, IPv4 or IPv6. This applies to caller-supplied file URLs (`url`, `ftp` and `s3` file objects used by fileInfo / download / compute), on-chain `decryptorURL` fields (the Indexer posts decrypt requests to them), and all outbound requests made during Docker manifest checks for compute images (the initial manifest fetch, the token-endpoint fetch from the `www-authenticate` realm, and the authenticated re-fetch). The check fires at connect time on every connection and every redirect, closing DNS-rebinding and redirect-chain vectors. **Localhost Docker registries** (`localhost:5000/myalgo`, etc.) are also blocked by this default and require listing `127.0.0.1/8` and/or `::1/128` here. This JSON array of CIDRs or single IPs lists exceptions, for example an object store, a private decryptor node, or a localhost registry on the node's LAN. Default is `[]`. Example: `["10.0.5.20/32","192.168.10.0/24","127.0.0.1/8"]` diff --git a/src/@types/OceanNode.ts b/src/@types/OceanNode.ts index e96bdd0b7..e34515483 100644 --- a/src/@types/OceanNode.ts +++ b/src/@types/OceanNode.ts @@ -221,6 +221,8 @@ export interface OceanNodeConfig { httpCertPath?: string httpKeyPath?: string enableBenchmark?: boolean + // derived, not read from config: whether POLICY_SERVER_URL is set (refreshed by getConfig()) + isPSConfigured: boolean persistentStorage?: PersistentStorageConfig } @@ -291,6 +293,11 @@ export interface OceanNodeStatus { version: string http: boolean p2p: boolean + // whether a Policy Server is configured (POLICY_SERVER_URL); clients use it to decide + // whether to run the credential (SSI) flow before download/compute + isPSConfigured: boolean + // node owner/legal info from NODE_OWNER_INFO (free-form JSON object); absent when unset/invalid + ownerInfo?: Record /** Present only when the P2P interface is enabled and running. */ p2pStatus?: OceanNodeP2PStatus provider: OceanNodeProvider[] diff --git a/src/OceanNode.ts b/src/OceanNode.ts index 5bdb0f4d0..d06111621 100644 --- a/src/OceanNode.ts +++ b/src/OceanNode.ts @@ -23,6 +23,7 @@ import { createPersistentStorage } from './components/persistentStorage/createPe import { PersistentStorageFactory } from './components/persistentStorage/PersistentStorageFactory.js' import { isAddress, FallbackProvider, ethers } from 'ethers' import { create256Hash } from './utils/crypt.js' +import { isPolicyServerConfigured } from './utils/config.js' import { MAINTENANCE_MODE_CONFIG_KEY, SUPPORTED_PROTOCOL_COMMANDS @@ -298,6 +299,7 @@ export class OceanNode { } public getConfig(): OceanNodeConfig { + this.config.isPSConfigured = isPolicyServerConfigured() return this.config } diff --git a/src/components/core/utils/statusHandler.ts b/src/components/core/utils/statusHandler.ts index 90c5c989b..faeba8023 100644 --- a/src/components/core/utils/statusHandler.ts +++ b/src/components/core/utils/statusHandler.ts @@ -12,6 +12,7 @@ import { typesenseSchemas } from '../../database/TypesenseSchemas.js' import { SupportedNetwork } from '../../../@types/blockchain.js' import { humanizeHex } from '../../../utils/humanHash.js' import { getPackageVersion } from '../../../utils/version.js' +import { getNodeOwnerInfo } from '../../../utils/config.js' function getSupportedStorageTypes(config: OceanNodeConfig): StorageTypes { return { @@ -121,6 +122,7 @@ export async function status( version: getPackageVersion(), http: config.hasHttp, p2p: config.hasP2P, + isPSConfigured: config.isPSConfigured, provider: [], indexer: [], escrowAddress: {}, @@ -148,6 +150,15 @@ export async function status( nodeStatus.subsidyProviderFilter = config.subsidyProviderFilter ?? false // Per-subsidy-address docker image allowlist; empty map when unset (no gating). nodeStatus.subsidyProviderAllowedImages = config.subsidyProviderAllowedImages ?? {} + // getConfig() refreshes it from POLICY_SERVER_URL, so the cached status never goes stale. + nodeStatus.isPSConfigured = config.isPSConfigured + // Re-read on every request so the cached status follows NODE_OWNER_INFO changes. + const ownerInfo = getNodeOwnerInfo() + if (ownerInfo) { + nodeStatus.ownerInfo = ownerInfo + } else { + delete nodeStatus.ownerInfo + } // Whether the P2P interface is usable, not just enabled. Re-read on every request rather // than cached with the block above: the routing table fills after startup, so a value // captured once would report a node as permanently not-ready. diff --git a/src/test/unit/maintenanceMode.test.ts b/src/test/unit/maintenanceMode.test.ts index 97d3d5a65..4bcdbb132 100644 --- a/src/test/unit/maintenanceMode.test.ts +++ b/src/test/unit/maintenanceMode.test.ts @@ -231,6 +231,50 @@ describe('Maintenance mode', () => { } }) + it('status reports isPSConfigured from POLICY_SERVER_URL on every request', async () => { + const saved = process.env.POLICY_SERVER_URL + const getStatus = async () => + streamBody( + await new DetailedStatusHandler(oceanNode).handle({ + command: PROTOCOL_COMMANDS.DETAILED_STATUS + } as any) + ) + try { + delete process.env.POLICY_SERVER_URL + expect((await getStatus()).isPSConfigured).to.equal(false) + process.env.POLICY_SERVER_URL = 'http://localhost:8000' + expect((await getStatus()).isPSConfigured).to.equal(true) + } finally { + if (saved === undefined) delete process.env.POLICY_SERVER_URL + else process.env.POLICY_SERVER_URL = saved + } + }) + + it('status reports ownerInfo from NODE_OWNER_INFO on every request', async () => { + const saved = process.env.NODE_OWNER_INFO + const getStatus = async () => + streamBody( + await new DetailedStatusHandler(oceanNode).handle({ + command: PROTOCOL_COMMANDS.DETAILED_STATUS + } as any) + ) + const ownerInfo = { imprint: { legalName: 'Acme Ltd' } } + try { + process.env.NODE_OWNER_INFO = JSON.stringify(ownerInfo) + expect((await getStatus()).ownerInfo).to.deep.equal(ownerInfo) + // invalid JSON or a non-object drops the field instead of keeping the stale value + process.env.NODE_OWNER_INFO = 'not-json' + expect((await getStatus()).ownerInfo).to.equal(undefined) + process.env.NODE_OWNER_INFO = '["a"]' + expect((await getStatus()).ownerInfo).to.equal(undefined) + delete process.env.NODE_OWNER_INFO + expect((await getStatus()).ownerInfo).to.equal(undefined) + } finally { + if (saved === undefined) delete process.env.NODE_OWNER_INFO + else process.env.NODE_OWNER_INFO = saved + } + }) + it('loadMaintenanceMode ignores an invalid MAINTENANCE_MODE env value', async () => { await oceanNode.setMaintenanceMode(true) process.env.MAINTENANCE_MODE = 'definitely-not-a-bool' diff --git a/src/utils/config.ts b/src/utils/config.ts index 81f2c7d64..1555a7f97 100644 --- a/src/utils/config.ts +++ b/src/utils/config.ts @@ -5,3 +5,18 @@ export * from './config/index.js' export function isPolicyServerConfigured(): boolean { return isDefined(process.env.POLICY_SERVER_URL) } + +// Free-form owner/legal info (imprint, terms, privacy policy, ...) from NODE_OWNER_INFO. +// Returns null when unset or not a JSON object. +export function getNodeOwnerInfo(): Record | null { + const raw = process.env.NODE_OWNER_INFO + if (!raw) return null + try { + const parsed = JSON.parse(raw) + return typeof parsed === 'object' && parsed !== null && !Array.isArray(parsed) + ? parsed + : null + } catch { + return null + } +} diff --git a/src/utils/constants.ts b/src/utils/constants.ts index c8966d496..4a38bb5cd 100644 --- a/src/utils/constants.ts +++ b/src/utils/constants.ts @@ -794,6 +794,11 @@ export const ENVIRONMENT_VARIABLES: Record = { value: process.env.POLICY_SERVER_URL, required: false }, + NODE_OWNER_INFO: { + name: 'NODE_OWNER_INFO', + value: process.env.NODE_OWNER_INFO, + required: false + }, VALIDATE_UNSIGNED_DDO: { name: 'VALIDATE_UNSIGNED_DDO', value: process.env.VALIDATE_UNSIGNED_DDO, From 544bfd7e2ef2e149376147ab09fca11aa205dd52 Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 12:16:00 +0200 Subject: [PATCH 02/11] use ddo.js 1.1.0-next.0 service getters, isOrderable and getCredentialAddresses; remove AssetUtils; fix download order check by service index, handle malformed credential rules, set isPSConfigured in config --- package-lock.json | 35 ++++++--- package.json | 2 +- src/components/c2d/compute_engine_docker.ts | 7 +- src/components/core/compute/initialize.ts | 9 +-- src/components/core/compute/startCompute.ts | 20 +++-- .../core/handler/downloadHandler.ts | 28 ++++--- src/test/unit/credentials.test.ts | 73 +++++++++++++++++++ src/test/unit/download.test.ts | 10 ++- src/test/utils/assets.ts | 10 ++- src/utils/asset.ts | 31 -------- src/utils/config/builder.ts | 2 + src/utils/credentials.ts | 30 +++++--- src/utils/file.ts | 5 +- 13 files changed, 171 insertions(+), 91 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7b31c467d..ade48c408 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34,7 +34,7 @@ "@libp2p/websockets": "^10.1.21", "@multiformats/multiaddr": "^13.0.3", "@oceanprotocol/contracts": "^3.2.0", - "@oceanprotocol/ddo-js": "^1.0.0", + "@oceanprotocol/ddo-js": "^1.1.0-next.0", "@opentelemetry/api": "^1.9.1", "@opentelemetry/exporter-metrics-otlp-http": "^0.221.0", "@opentelemetry/exporter-trace-otlp-http": "^0.221.0", @@ -193,6 +193,7 @@ "resolved": "https://registry.npmjs.org/@aws-sdk/client-s3/-/client-s3-3.1161.0.tgz", "integrity": "sha512-iRZGMsJnYRrI98O+U6o5fHeLPQTP+Dc/w0mWLcBLQcEQ10DA06+XQj0WmdRiCM7vIso7QEtN1fsj9Vzo5/R3LQ==", "license": "Apache-2.0", + "peer": true, "dependencies": { "@aws-sdk/checksums": "^3.1002.1", "@aws-sdk/core": "^3.979.1", @@ -531,6 +532,7 @@ "integrity": "sha512-RgHBCvtjbOK2gXSNBNIkNoEc9qoVEtau3hj8gEqKQuL3HZAibKarWFEI3Lfm6EYKkLalOh8eSrj9b+ch9H/VBA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.29.7", "@babel/generator": "^7.29.7", @@ -3152,14 +3154,14 @@ "license": "Apache-2.0" }, "node_modules/@oceanprotocol/ddo-js": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@oceanprotocol/ddo-js/-/ddo-js-1.0.0.tgz", - "integrity": "sha512-FSw3rDimhf/aHARzQVN7Ve4xGkgK4cRRr8AJtc3XRH0Knc7WK8ga+TJkx9LvS1KjH7hVePSD9Q7400oJQe0Iqg==", + "version": "1.1.0-next.0", + "resolved": "https://registry.npmjs.org/@oceanprotocol/ddo-js/-/ddo-js-1.1.0-next.0.tgz", + "integrity": "sha512-hfyOmD6CaucXv4srVP/KZtfrGXqutXGlvrUfQyjaFsDcLFq64XG5kbqO878NbpybM2wxuDK0kwxyQKd/XnVtPQ==", "license": "Apache-2.0", "dependencies": { "ethers": "^6.17.0", "jsonld": "^9.0.0", - "n3": "^2.2.0", + "n3": "^2.13.12", "rdf-literal": "^2.0.0", "rdf-validate-shacl": "^0.6.5" } @@ -3180,6 +3182,7 @@ "integrity": "sha512-DcB0M3KFgr9ECI328lhBMVsyFT2DnmNucSBTqEN3exyNKUzkkpUSCHmTRcunF41Eou2TIQKW4seewri8ON9bSA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@octokit/auth-token": "^6.0.0", "@octokit/graphql": "^9.0.4", @@ -3370,6 +3373,7 @@ "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.1.tgz", "integrity": "sha512-gLyJlPHPZYdAk1JENA9LeHejZe1Ti77/pTeFm/nMXmQH/HFZlcS/O2XJB+L8fkbrNSqhdtlvjBVjxwUYanNH5Q==", "license": "Apache-2.0", + "peer": true, "engines": { "node": ">=8.0.0" } @@ -4524,6 +4528,7 @@ "resolved": "https://registry.npmjs.org/@rdfjs/types/-/types-2.0.1.tgz", "integrity": "sha512-uyAzpugX7KekAXAHq26m3JlUIZJOC0uSBhpnefGV5i15bevDyyejoB7I+9MKeUrzXD8OOUI3+4FeV1wwQr5ihA==", "license": "MIT", + "peer": true, "dependencies": { "@types/node": "*" } @@ -5130,6 +5135,7 @@ "integrity": "sha512-CG4nPk1f2zc8yw4pALqHsFYH2hdo+h1T9daSp21+Hnxi9LOE3GT9hAfTKJCBXVNM2GmYs1eMEP615wPoeOgk3A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "8.71.0", "@typescript-eslint/types": "8.71.0", @@ -5471,6 +5477,7 @@ "integrity": "sha512-lGq+9yr1/GuAWaVYIHRjvvySG5/4VfKIvC8EWxStPdcDh/Ka7FG3twP6v4d5BkravUilhIAsG4Qj83t02LWUPQ==", "dev": true, "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -5770,6 +5777,7 @@ "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.9.1.tgz", "integrity": "sha512-Z0oHEHAFDZkffN8Qc39zNZjQlMDkPJRyyyZieU1VH7u8c5S+qHZ2S8ixdKIAxEjfHO7FJxXmJWgteOghVanIsg==", "license": "Apache-2.0", + "peer": true, "peerDependencies": { "bare-abort-controller": "*" }, @@ -6017,6 +6025,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "baseline-browser-mapping": "^2.11.12", "caniuse-lite": "^1.0.30001809", @@ -7021,6 +7030,7 @@ "resolved": "https://registry.npmjs.org/@noble/ciphers/-/ciphers-1.3.0.tgz", "integrity": "sha512-2I0gnIVPtfnMw9ee9h1dJG7tp81+8Ob3OJb3Mv37rx5L40/b0i7djjCVvGOVqc9AEIQyvyu1i6ypKdFw8R8gQw==", "license": "MIT", + "peer": true, "engines": { "node": "^14.21.3 || >=16" }, @@ -7212,6 +7222,7 @@ "integrity": "sha512-T0pNsxkb9IKmtQjhpK3d7nWOpFv+YHuMbTJnSVMoQblF0onvXfErrtp4V1jHtsQPan7dKaGVD0q1WCXnzMF31A==", "dev": true, "license": "MIT", + "peer": true, "workspaces": [ "packages/*" ], @@ -7271,6 +7282,7 @@ "integrity": "sha512-82GZUjRS0p/jganf6q1rEO25VSoHH0hKPCTrgillPjdI/3bgBhAE1QzHrHTizjpRvy6pGAvKjDJtk2pF9NDq8w==", "dev": true, "license": "MIT", + "peer": true, "bin": { "eslint-config-prettier": "bin/cli.js" }, @@ -9477,6 +9489,7 @@ "integrity": "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@keyv/serialize": "^1.1.1" } @@ -10096,9 +10109,9 @@ } }, "node_modules/n3": { - "version": "2.2.5", - "resolved": "https://registry.npmjs.org/n3/-/n3-2.2.5.tgz", - "integrity": "sha512-lR/0N7zVayC6N0uWqrMkPpJn8Up4+qBsjWiBnoOWWEi/ldTcygs2Dw1iAgozzDXLW/fcxXFfbMzpGHlc/1MBLQ==", + "version": "2.13.12", + "resolved": "https://registry.npmjs.org/n3/-/n3-2.13.12.tgz", + "integrity": "sha512-z944NsyJi58WXcYevtNkUL2JhVr0KP6nvED9AgymQq5V35TDaNn1N8kO+OWJk/kj4PR0L/ilWB3d7/bWceg1CQ==", "license": "MIT", "dependencies": { "buffer": "^6.0.3", @@ -11101,6 +11114,7 @@ "integrity": "sha512-RvwwcruNjI1ncT5xRakeyS9Lf8lcItv34KD+aif+VH9kduAyfYBipGh12274xtenIPZ119/R9BdTBa8gAwSh0A==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -11218,6 +11232,7 @@ "integrity": "sha512-skGHTH1Yb9QvaTC4hWnRTzEYtCpApF0UMBPz+t/0ZPzP8ihefo/btKd+QA7pUE0fEwA1SbS/NmhyEcstdXOIdA==", "dev": true, "license": "MIT", + "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -11522,7 +11537,8 @@ "resolved": "https://registry.npmjs.org/quickjs-wasi/-/quickjs-wasi-2.2.0.tgz", "integrity": "sha512-zQxXmQMrEoD3S+jQdYsloq4qAuaxKFHZj6hHqOYGwB2iQZH+q9e/lf5zQPXCKOk0WJuAjzRFbO4KwHIp2D05Iw==", "dev": true, - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/race-event": { "version": "1.6.1", @@ -12929,6 +12945,7 @@ "integrity": "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw==", "dev": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" diff --git a/package.json b/package.json index 95619b521..d5eb5a512 100644 --- a/package.json +++ b/package.json @@ -76,7 +76,7 @@ "@libp2p/websockets": "^10.1.21", "@multiformats/multiaddr": "^13.0.3", "@oceanprotocol/contracts": "^3.2.0", - "@oceanprotocol/ddo-js": "^1.0.0", + "@oceanprotocol/ddo-js": "^1.1.0-next.0", "@opentelemetry/api": "^1.9.1", "@opentelemetry/exporter-metrics-otlp-http": "^0.221.0", "@opentelemetry/exporter-trace-otlp-http": "^0.221.0", diff --git a/src/components/c2d/compute_engine_docker.ts b/src/components/c2d/compute_engine_docker.ts index bddae5de3..bb6694f44 100755 --- a/src/components/c2d/compute_engine_docker.ts +++ b/src/components/c2d/compute_engine_docker.ts @@ -61,7 +61,6 @@ import { checkUrlHost, getSafeDispatcher } from '../../utils/safeUrl.js' import { fetchHeadersTimeout } from '../../utils/http.js' import { errorSummary, safeStringify } from '../../utils/logging/redact.js' import { ENVIRONMENT_VARIABLES, JobType } from '../../utils/constants.js' -import { AssetUtils } from '../../utils/asset.js' import { FindDdoHandler } from '../core/handler/ddoHandler.js' import { OceanNode } from '../../OceanNode.js' import { KeyManager } from '../KeyManager/index.js' @@ -71,7 +70,7 @@ import { validateJobMetadataSize } from './index.js' import { ValidateParams } from '../httpRoutes/validateCommands.js' -import { Service } from '@oceanprotocol/ddo-js' +import { DDOManager, Service } from '@oceanprotocol/ddo-js' import { getOceanTokenAddressForChain } from '../../utils/address.js' import { includesAddress, sameAddress } from '../../utils/evmAddress.js' import { dockerRegistryAuth, OceanNodeConfig } from '../../@types/OceanNode.js' @@ -7124,7 +7123,7 @@ export class C2DEngineDocker extends C2DEngine { OceanNode.getInstance() ).findAndFormatDdo(documentId) // 2. Get the service - const service: Service = AssetUtils.getServiceById(ddo, serviceId) + const service = DDOManager.getDDOClass(ddo).getService(serviceId) as Service // 3. Decrypt the url let decryptedFileObject = await decryptFilesObject(service.files) // persistent storage assets are bind-mounted during ConfiguringVolumes @@ -7590,7 +7589,7 @@ export async function resolveComputeFileObject( if (!ddo) { return null } - const service: Service = AssetUtils.getServiceById(ddo, serviceId) + const service = DDOManager.getDDOClass(ddo).getService(serviceId) as Service if (!service) { return null } diff --git a/src/components/core/compute/initialize.ts b/src/components/core/compute/initialize.ts index c8fa85c0f..c78e611a7 100644 --- a/src/components/core/compute/initialize.ts +++ b/src/components/core/compute/initialize.ts @@ -7,7 +7,6 @@ import { CommandHandler } from '../handler/handler.js' import { ComputeInitializeCommand } from '../../../@types/commands.js' import { ProviderComputeInitializeResults } from '../../../@types/Fees.js' import { - AssetUtils, getFilesObjectFromConfidentialEVM, isConfidentialChainDDO, isDataTokenTemplate4, @@ -35,7 +34,7 @@ import { resolveComputeFileObject } from '../../c2d/compute_engine_docker.js' -import { Credentials, DDOManager } from '@oceanprotocol/ddo-js' +import { Credentials, DDOManager, Service } from '@oceanprotocol/ddo-js' import { checkCredentials } from '../../../utils/credentials.js' import { PolicyServer } from '../../policyServer/index.js' import { @@ -416,7 +415,7 @@ export class ComputeInitializeHandler extends CommandHandler { } } } - const service = AssetUtils.getServiceById(ddo, elem.serviceId) + const service = ddoInstance.getService(elem.serviceId) as Service if (!service) { const error = `Cannot find service ${elem.serviceId} in DDO ${elem.documentId}` return { @@ -544,7 +543,7 @@ export class ComputeInitializeHandler extends CommandHandler { task.datasets[0].documentId + (await getNonceAsNumber(task.consumerAddress)) // call smart contract to decrypt - const serviceIndex = AssetUtils.getServiceIndexById(ddo, service.id) + const serviceIndex = ddoInstance.getServiceIndex(service.id) const filesObject = await getFilesObjectFromConfidentialEVM( serviceIndex, service.datatokenAddress, @@ -602,7 +601,7 @@ export class ComputeInitializeHandler extends CommandHandler { provider, nftAddress, service.datatokenAddress, - AssetUtils.getServiceIndexById(ddo, service.id), + ddoInstance.getServiceIndex(service.id), service.timeout, await blockchain.getSigner(), task.consumerAddress diff --git a/src/components/core/compute/startCompute.ts b/src/components/core/compute/startCompute.ts index c6c350e19..24cf7d9a0 100644 --- a/src/components/core/compute/startCompute.ts +++ b/src/components/core/compute/startCompute.ts @@ -23,7 +23,6 @@ import { } from '../../httpRoutes/validateCommands.js' import { isAddress } from 'ethers' import { - AssetUtils, getFilesObjectFromConfidentialEVM, isConfidentialChainDDO, isDataTokenTemplate4, @@ -43,7 +42,7 @@ import { sanitizeServiceFiles } from '../../../utils/util.js' import { FindDdoHandler } from '../handler/ddoHandler.js' // import { ProviderFeeValidation } from '../../../@types/Fees.js' import { isOrderingAllowedForAsset } from '../handler/downloadHandler.js' -import { Credentials, DDOManager } from '@oceanprotocol/ddo-js' +import { Credentials, DDOManager, Service } from '@oceanprotocol/ddo-js' import { getNonceAsNumber } from '../utils/nonceHandler.js' import { PolicyServer } from '../../policyServer/index.js' import { checkCredentials } from '../../../utils/credentials.js' @@ -445,7 +444,7 @@ export class CommonComputeHandler extends CommandHandler { ) } } - const service = AssetUtils.getServiceById(ddo, elem.serviceId) + const service = ddoInstance.getService(elem.serviceId) as Service if (!service) { return buildComputeError( 500, @@ -510,7 +509,7 @@ export class CommonComputeHandler extends CommandHandler { task.datasets[0].documentId + (await getNonceAsNumber(task.consumerAddress)) // call smart contract to decrypt - const serviceIndex = AssetUtils.getServiceIndexById(ddo, service.id) + const serviceIndex = ddoInstance.getServiceIndex(service.id) const filesObject = await getFilesObjectFromConfidentialEVM( serviceIndex, service.datatokenAddress, @@ -708,6 +707,7 @@ export class PaidComputeStartHandler extends CommonComputeHandler { authorizeAsset: async ({ elem, ddo, + ddoInstance, ddoChainId, nftAddress, service, @@ -732,7 +732,7 @@ export class PaidComputeStartHandler extends CommonComputeHandler { provider, nftAddress, service.datatokenAddress, - AssetUtils.getServiceIndexById(ddo, service.id), + ddoInstance.getServiceIndex(service.id), service.timeout, await blockchain.getSigner(), task.consumerAddress @@ -1044,7 +1044,13 @@ export class FreeComputeStartHandler extends CommonComputeHandler { // Free compute may reference a paid asset. Omitting transferTxId runs it free // without an order (intended, allowed) - skip. If a transferTxId IS supplied it is // validated with Option B (env-AND) so a reused/foreign order is rejected here too. - authorizeAsset: async ({ elem, ddo, nftAddress, service, blockchain }) => { + authorizeAsset: async ({ + elem, + ddoInstance, + nftAddress, + service, + blockchain + }) => { if (!('transferTxId' in elem) || !elem.transferTxId) { return null } @@ -1055,7 +1061,7 @@ export class FreeComputeStartHandler extends CommonComputeHandler { provider, nftAddress, service.datatokenAddress, - AssetUtils.getServiceIndexById(ddo, service.id), + ddoInstance.getServiceIndex(service.id), service.timeout, await blockchain.getSigner(), task.consumerAddress diff --git a/src/components/core/handler/downloadHandler.ts b/src/components/core/handler/downloadHandler.ts index b54ec8f71..ead609331 100644 --- a/src/components/core/handler/downloadHandler.ts +++ b/src/components/core/handler/downloadHandler.ts @@ -1,12 +1,11 @@ import { CommandHandler } from './handler.js' -import { MetadataStates, PROTOCOL_COMMANDS } from '../../../utils/constants.js' +import { PROTOCOL_COMMANDS } from '../../../utils/constants.js' import { P2PCommandResponse } from '../../../@types/OceanNode.js' import { ProviderFees } from '../utils/feesHandler.js' import { FindDdoHandler } from './ddoHandler.js' import crypto from 'crypto' import { validateOrderTransaction } from '../utils/validateOrders.js' import { - AssetUtils, getFilesObjectFromConfidentialEVM, isConfidentialChainDDO, isDataTokenTemplate4, @@ -37,12 +36,14 @@ export function isOrderingAllowedForAsset(asset: Asset): OrdableAssetResponse { isOrdable: false, reason: `Asset provided is either null, either undefined ${asset}` } - } else if ( - !asset.indexedMetadata?.nft || - ![MetadataStates.ACTIVE, MetadataStates.UNLISTED].includes( - asset.indexedMetadata.nft.state - ) - ) { + } + let isOrderable: boolean + try { + isOrderable = DDOManager.getDDOClass(asset).isOrderable() + } catch (error) { + return { isOrdable: false, reason: `Unsupported asset: ${error.message}` } + } + if (!isOrderable) { return { isOrdable: false, reason: @@ -332,9 +333,13 @@ export class DownloadHandler extends CommandHandler { } } - let service = AssetUtils.getServiceById(ddo, task.serviceId) - if (!service) service = AssetUtils.getServiceByIndex(ddo, Number(task.serviceId)) + let service = ddoInstance.getService(task.serviceId) as Service + if (!service) { + service = ddoInstance.getServiceByIndex(Number(task.serviceId)) as Service + } if (!service) throw new Error('Cannot find service') + // The service may have been found by index, so look its index up by the resolved id + const serviceIndex = ddoInstance.getServiceIndex(service.id) // check credentials on service level // if using a policy server and we are here it means that access was granted (they are merged/assessed together) @@ -432,7 +437,7 @@ export class DownloadHandler extends CommandHandler { provider, ddo.nftAddress, service.datatokenAddress, - AssetUtils.getServiceIndexById(ddo, task.serviceId), + serviceIndex, service.timeout, await blockchain.getSigner() ) @@ -480,7 +485,6 @@ export class DownloadHandler extends CommandHandler { 'Downloading from Confidential EVM, try get filesObject from Smart Contract' ) - const serviceIndex = AssetUtils.getServiceIndexById(ddo, task.serviceId) const consumerMessage = String(ddo.id + task.nonce) filesObject = await getFilesObjectFromConfidentialEVM( serviceIndex, diff --git a/src/test/unit/credentials.test.ts b/src/test/unit/credentials.test.ts index 3fa2e7664..519ca0ac1 100644 --- a/src/test/unit/credentials.test.ts +++ b/src/test/unit/credentials.test.ts @@ -201,6 +201,79 @@ describe('credentials', () => { expect(accessGranted).to.equal(true) }) + // The Ocean Enterprise market writes address entries as { address } objects (DDO v5 shape; + // the v4 Credentials type only allows strings, hence the casts) + it('should allow access with address in allow list as { address } object', async () => { + const credentials = { + allow: [ + { + type: CREDENTIALS_TYPES.ADDRESS, + values: [{ address: '0xABC' }] + } + ] + } as unknown as Credentials + const accessGranted = await checkCredentials('0xabc', credentials, signer) + expect(accessGranted).to.equal(true) + }) + + it('should deny access with address in deny list as { address } object', async () => { + const credentials = { + deny: [ + { + type: CREDENTIALS_TYPES.ADDRESS, + values: [{ address: '0x123' }] + } + ] + } as unknown as Credentials + const accessGranted = await checkCredentials('0x123', credentials, signer) + expect(accessGranted).to.equal(false) + }) + + it('should read lists mixing plain strings and { address } objects', async () => { + const credentials = { + allow: [ + { + type: CREDENTIALS_TYPES.ADDRESS, + values: ['0x456', { address: '0x123' }] + } + ], + deny: [ + { + type: CREDENTIALS_TYPES.ADDRESS, + values: [{ address: '0x789' }, '0x999'] + } + ] + } as unknown as Credentials + expect(await checkCredentials('0x123', credentials, signer)).to.equal(true) + expect(await checkCredentials('0x456', credentials, signer)).to.equal(true) + expect(await checkCredentials('0x789', credentials, signer)).to.equal(false) + expect(await checkCredentials('0x999', credentials, signer)).to.equal(false) + }) + + it('should treat malformed rules (null or missing type) as unknown, not crash', async () => { + // allow + match_allow 'all': an unknown rule denies + const allowAll = { + allow: [{ type: CREDENTIALS_TYPES.ADDRESS, values: ['0x123'] }, null] + } as unknown as Credentials + expect(await checkCredentials('0x123', allowAll, signer)).to.equal(false) + + // allow + match_allow 'any': the unknown rule is skipped, the valid one still matches + const allowAny = { + match_allow: 'any', + allow: [ + { values: ['0x123'] }, + { type: CREDENTIALS_TYPES.ADDRESS, values: ['0x123'] } + ] + } as unknown as Credentials + expect(await checkCredentials('0x123', allowAny, signer)).to.equal(true) + + // deny: unknown rules are ignored, as for any other unknown type + const deny = { + deny: [{ values: ['0x123'] }, null] + } as unknown as Credentials + expect(await checkCredentials('0x123', deny, signer)).to.equal(true) + }) + after(async () => { await tearDownEnvironment(envOverrides) }) diff --git a/src/test/unit/download.test.ts b/src/test/unit/download.test.ts index 9e088233a..425c7af65 100644 --- a/src/test/unit/download.test.ts +++ b/src/test/unit/download.test.ts @@ -19,9 +19,9 @@ import { handleDownloadUrlCommand, validateFilesStructure } from '../../components/core/handler/downloadHandler.js' -import { AssetUtils, isConfidentialChainDDO } from '../../utils/asset.js' +import { isConfidentialChainDDO } from '../../utils/asset.js' import { DEVELOPMENT_CHAIN_ID, KNOWN_CONFIDENTIAL_EVMS } from '../../utils/address.js' -import { DDO } from '@oceanprotocol/ddo-js' +import { DDO, DDOManager, Service } from '@oceanprotocol/ddo-js' import { Wallet } from 'ethers' import { createHashForSignature, safeSign } from '../utils/signature.js' import { KeyManager } from '../../components/KeyManager/index.js' @@ -145,7 +145,7 @@ describe('Should validate files structure for download', () => { const decriptedFileObject: any = decryptedFileArray.files expect(decriptedFileObject[0]).to.be.deep.equal(assetURL.files[0]) // validate the structure of the files object - const service = AssetUtils.getServiceByIndex(ddoObj, 0) + const service = DDOManager.getDDOClass(ddoObj).getServiceByIndex(0) as Service expect(validateFilesStructure(ddoObj, service, decryptedFileArray)).to.be.equal(true) }) @@ -158,7 +158,9 @@ describe('Should validate files structure for download', () => { otherDDOSameFiles.nftAddress = otherNFTAddress otherDDOSameFiles.services[0].datatokenAddress = otherDatatokenAddress - const service = AssetUtils.getServiceByIndex(otherDDOSameFiles, 0) + const service = DDOManager.getDDOClass(otherDDOSameFiles).getServiceByIndex( + 0 + ) as Service // its the same service files structure (same encrypted data), // but its not the same ddo so there is no matching expect( diff --git a/src/test/utils/assets.ts b/src/test/utils/assets.ts index 75d9a888d..2d31903b3 100644 --- a/src/test/utils/assets.ts +++ b/src/test/utils/assets.ts @@ -20,7 +20,7 @@ import { import ERC20Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC20TemplateEnterprise.sol/ERC20TemplateEnterprise.json' with { type: 'json' } import { getEventFromTx, streamToObject } from '../../utils/util.js' -import { AssetUtils } from '../../utils/asset.js' +import { DDOManager, Service } from '@oceanprotocol/ddo-js' import { DDO_IDENTIFIER_PREFIX, PROTOCOL_COMMANDS } from '../../utils/index.js' import { FeesHandler } from '../../components/core/handler/feesHandler.js' @@ -141,7 +141,9 @@ export async function orderAsset( const consumeMarketFeeAddress = ZeroAddress const consumeMarketFeeAmount = 0 const consumeMarketFeeToken = ZeroAddress - const service = AssetUtils.getServiceByIndex(genericAsset, serviceIndex) + const service = DDOManager.getDDOClass(genericAsset).getServiceByIndex( + serviceIndex + ) as Service let orderTxReceipt = null const dataTokenContract = new Contract( @@ -228,7 +230,9 @@ export async function reOrderAsset( const consumeMarketFeeAddress = ZeroAddress const consumeMarketFeeAmount = 0 const consumeMarketFeeToken = ZeroAddress - const service = AssetUtils.getServiceByIndex(genericAsset, serviceIndex) + const service = DDOManager.getDDOClass(genericAsset).getServiceByIndex( + serviceIndex + ) as Service const dataTokenContract = new Contract( service.datatokenAddress, ERC20Template.abi, diff --git a/src/utils/asset.ts b/src/utils/asset.ts index 1efa3113f..f024c49f6 100644 --- a/src/utils/asset.ts +++ b/src/utils/asset.ts @@ -13,37 +13,6 @@ import { getContractAddress, getNFTFactory } from '../components/Indexer/utils.j import { HeadersObject } from '../@types/fileObject.js' import { fetchHeadersTimeout } from './http.js' -// Notes: -// Asset as per asset.py on provider, is a class there, while on ocean.Js we only have a type -// this is an utility to extract information from the Asset services -export const AssetUtils = { - getServiceIndexById(asset: DDO, id: string): number | null { - const ddoInstance = DDOManager.getDDOClass(asset) - const { services } = ddoInstance.getDDOFields() - - for (let c = 0; c < services.length; c++) if (services[c].id === id) return c - return null - }, - getServiceByIndex(asset: DDO, index: number) { - const ddoInstance = DDOManager.getDDOClass(asset) - const { services } = ddoInstance.getDDOFields() - - if (index >= 0 && index < services.length) { - return services[index] as Service - } - return null - }, - - getServiceById(asset: DDO, id: string) { - const ddoInstance = DDOManager.getDDOClass(asset) - const { services } = ddoInstance.getDDOFields() as any - - const filteredServices = services.filter((service: any) => service.id === id) - - return filteredServices.length ? filteredServices[0] : null - } -} - /** * undici wraps connector failures as TypeError('fetch failed', { cause }); walk the chain * and return a plain Error with the SSRF guard's message when that is what failed. diff --git a/src/utils/config/builder.ts b/src/utils/config/builder.ts index e475ceaa8..1d0fe02c8 100644 --- a/src/utils/config/builder.ts +++ b/src/utils/config/builder.ts @@ -21,6 +21,7 @@ import { redactUrls, safeStringify } from '../logging/redact.js' import { OceanNodeConfigSchema } from './schemas.js' import { booleanFromString } from './transforms.js' import { ENV_TO_CONFIG_MAPPING } from './constants.js' +import { isPolicyServerConfigured } from '../config.js' import { registerP2PBudgetConfig } from '../../components/P2P/timeouts.js' import { fileURLToPath } from 'url' import lodash from 'lodash' @@ -277,6 +278,7 @@ export function buildMergedConfig(): OceanNodeConfig { config.c2dClusters = buildC2DClusters( config.dockerComputeEnvironments as C2DDockerConfig[] ) + config.isPSConfigured = isPolicyServerConfigured() // Let the P2P budget getters fall back to values set only in config.json (env still wins). // Runs on every (re)build, so a forced reload re-registers the fresh p2pConfig. diff --git a/src/utils/credentials.ts b/src/utils/credentials.ts index 780f25c3e..c73eca5b4 100644 --- a/src/utils/credentials.ts +++ b/src/utils/credentials.ts @@ -2,7 +2,12 @@ import { Signer } from 'ethers' import { AccessListContract } from '../@types/OceanNode.js' import { CORE_LOGGER } from './logging/common.js' import { errorSummary } from './logging/redact.js' -import { Credential, Credentials, MATCH_RULES } from '@oceanprotocol/ddo-js' +import { + Credential, + Credentials, + MATCH_RULES, + getCredentialAddresses +} from '@oceanprotocol/ddo-js' import { CREDENTIALS_TYPES } from '../@types/DDO/Credentials.js' import { checkAddressOnAccessListWithSigner } from './accessList.js' import { isDefined } from './util.js' @@ -102,7 +107,7 @@ async function evaluateCredentialList( if (listType === 'allow' && matchRule === 'all') { // Unknown type in allow list with match_all='all' -> DENY CORE_LOGGER.debug( - `Unknown credential type '${credential.type}' in allow list with match_allow='all'. Access denied.` + `Unknown credential type '${credential?.type}' in allow list with match_allow='all'. Access denied.` ) return { shouldAllow: false, shouldDeny: false } } @@ -164,30 +169,31 @@ export async function checkSingleCredential( consumerAddress: string, signer: Signer | null ): Promise { + // A malformed rule (null, or no string type) is treated as an unknown type, not a crash + if (!credential || typeof credential.type !== 'string') { + return null + } const credentialType = credential.type.toLowerCase() // ======================================== // Handle ADDRESS-based credentials // ======================================== if (credentialType === CREDENTIALS_TYPES.ADDRESS.toLowerCase()) { - // Type assertion since we know it's address type - const addressCredential = credential as any - - if (!isDefined(addressCredential.values) || addressCredential.values.length === 0) { + // Entries may be plain strings or { address } objects; ddo.js reads both formats + const addresses = getCredentialAddresses(credential as any).map((a) => + a.toLowerCase() + ) + if (addresses.length === 0) { return false } // Check for wildcard (*) - const hasWildcard = addressCredential.values.some( - (value: string) => value.toLowerCase() === '*' - ) - if (hasWildcard) { + if (addresses.includes('*')) { return true } // Check if address is in the list - const normalizedValues = addressCredential.values.map((v: string) => v.toLowerCase()) - return normalizedValues.includes(consumerAddress.toLowerCase()) + return addresses.includes(consumerAddress.toLowerCase()) } // ======================================== diff --git a/src/utils/file.ts b/src/utils/file.ts index 300b55b40..612fcdd2c 100644 --- a/src/utils/file.ts +++ b/src/utils/file.ts @@ -1,12 +1,11 @@ import { StorageObject, EncryptMethod } from '../@types/fileObject.js' import { OceanNode } from '../OceanNode.js' import { FindDdoHandler } from '../components/core/handler/ddoHandler.js' -import { AssetUtils } from './asset.js' import { CORE_LOGGER } from './logging/common.js' import { errorSummary } from './logging/redact.js' import { sanitizeServiceFiles } from './util.js' import { isOrderingAllowedForAsset } from '../components/core/handler/downloadHandler.js' -import { DDO, Service } from '@oceanprotocol/ddo-js' +import { DDO, DDOManager, Service } from '@oceanprotocol/ddo-js' export async function getFile( didOrDdo: string | DDO, @@ -26,7 +25,7 @@ export async function getFile( } // 2. Get the service - const service: Service = AssetUtils.getServiceById(ddo, serviceId) + const service = DDOManager.getDDOClass(ddo).getService(serviceId) as Service if (!service) { throw new Error(`Service with id ${serviceId} not found`) } From d4eacfde2ca01a6b789ee779ddb29f95a83bbe9c Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 12:39:19 +0200 Subject: [PATCH 03/11] use ddo.js evaluateCredentials for credential checks; node only resolves accessList rules malformed credentials (non-object, or null/non-array allow/deny lists) now deny access --- src/test/unit/credentials.test.ts | 19 +++ src/utils/credentials.ts | 195 +++++++----------------------- 2 files changed, 60 insertions(+), 154 deletions(-) diff --git a/src/test/unit/credentials.test.ts b/src/test/unit/credentials.test.ts index 519ca0ac1..1b525ac43 100644 --- a/src/test/unit/credentials.test.ts +++ b/src/test/unit/credentials.test.ts @@ -274,6 +274,25 @@ describe('credentials', () => { expect(await checkCredentials('0x123', deny, signer)).to.equal(true) }) + it('should deny malformed credentials instead of allowing them', async () => { + // credentials that are not a plain object cannot carry allow/deny lists + const asArray = [ + { type: CREDENTIALS_TYPES.ADDRESS, values: ['0x123'] } + ] as unknown as Credentials + expect(await checkCredentials('0x123', asArray, signer)).to.equal(false) + + // an allow or deny list that is set but is not an array + const nullAllow = { allow: null } as unknown as Credentials + expect(await checkCredentials('0x123', nullAllow, signer)).to.equal(false) + const objectDeny = { + deny: { type: CREDENTIALS_TYPES.ADDRESS, values: ['0x456'] } + } as unknown as Credentials + expect(await checkCredentials('0x123', objectDeny, signer)).to.equal(false) + + // absent lists are still no restriction + expect(await checkCredentials('0x123', {} as Credentials, signer)).to.equal(true) + }) + after(async () => { await tearDownEnvironment(envOverrides) }) diff --git a/src/utils/credentials.ts b/src/utils/credentials.ts index c73eca5b4..98d4985e9 100644 --- a/src/utils/credentials.ts +++ b/src/utils/credentials.ts @@ -3,198 +3,86 @@ import { AccessListContract } from '../@types/OceanNode.js' import { CORE_LOGGER } from './logging/common.js' import { errorSummary } from './logging/redact.js' import { - Credential, - Credentials, - MATCH_RULES, - getCredentialAddresses + CredentialResolver, + CredentialRule, + CredentialRules, + evaluateCredential, + evaluateCredentials } from '@oceanprotocol/ddo-js' import { CREDENTIALS_TYPES } from '../@types/DDO/Credentials.js' import { checkAddressOnAccessListWithSigner } from './accessList.js' import { isDefined } from './util.js' /** - * Main credential checking function with blockchain support for accessList checks + * Main credential checking function with blockchain support for accessList checks. + * The allow/deny rules are evaluated by ddo.js `evaluateCredentials`; the node only + * resolves rule types that need a chain call (see `resolveCredential`). * * @param consumerAddress The consumer address to check * @param credentials The credentials object containing allow/deny rules - * @param blockchain Blockchain instance to get signer for on-chain checks + * @param signer Signer for on-chain accessList checks * @returns Promise - true if access is granted, false otherwise * * Logic: - * 1. If credentials are undefined/empty, allow access + * 1. If credentials are undefined/null, allow access * 2. Check DENY list first with match_deny strategy (default 'any'): * - If match_deny='any' and ANY rule matches, DENY access * - If match_deny='all' and ALL rules match, DENY access - * - Unknown types with match_deny='all' are ignored + * - Unknown types in the deny list are ignored * 3. Check ALLOW list with match_allow strategy (default 'all'): * - If match_allow='any' and ANY rule matches, ALLOW access * - If match_allow='all' and ALL rules match, ALLOW access * - Unknown types with match_allow='all' cause DENY * 4. If no allow list specified, ALLOW access + * 5. Malformed credentials (not an object, or allow/deny set but not an array) DENY */ export async function checkCredentials( consumerAddress: string, - credentials: Credentials, + credentials: CredentialRules, signer: Signer ): Promise { - // If credentials are undefined or empty, allow access - if (!isDefined(credentials)) { - return true - } - - const normalizedAddress = consumerAddress.toLowerCase() - // Get matching strategies (with defaults) - const matchDeny: MATCH_RULES = credentials.match_deny || 'any' - const matchAllow: MATCH_RULES = credentials.match_allow || 'all' - - // ======================================== - // STEP 1: Check DENY list (checked first) - // ======================================== - if (isDefined(credentials.deny) && credentials.deny.length > 0) { - const denyResult = await evaluateCredentialList( - credentials.deny, - normalizedAddress, - signer, - matchDeny, - 'deny' - ) - - // If evaluation says to deny, return false - if (denyResult.shouldDeny) { - CORE_LOGGER.debug( - `Access denied: Consumer address ${consumerAddress} matched deny rule(s)` - ) - return false - } - } - - // ======================================== - // STEP 2: Check ALLOW list - // ======================================== - if (isDefined(credentials.allow) && credentials.allow.length > 0) { - const allowResult = await evaluateCredentialList( - credentials.allow, - normalizedAddress, - signer, - matchAllow, - 'allow' - ) - - return allowResult.shouldAllow - } - - // No allow list specified, grant access by default - return true -} - -/** - * Evaluates a list of credentials (either allow or deny) - */ -async function evaluateCredentialList( - credentialList: Credential[], - consumerAddress: string, - signer: Signer, - matchRule: MATCH_RULES, - listType: 'allow' | 'deny' -): Promise<{ shouldAllow: boolean; shouldDeny: boolean }> { - const matchResults: boolean[] = [] - for (const credential of credentialList) { - const matchResult = await checkSingleCredential(credential, consumerAddress, signer) - - if (matchResult === null) { - // Unknown or unsupported credential type - - if (listType === 'allow' && matchRule === 'all') { - // Unknown type in allow list with match_all='all' -> DENY - CORE_LOGGER.debug( - `Unknown credential type '${credential?.type}' in allow list with match_allow='all'. Access denied.` - ) - return { shouldAllow: false, shouldDeny: false } - } - // For deny list with match_all='all', unknown types are ignored - // For 'any' match, unknown types don't contribute to matching - } else { - matchResults.push(matchResult) - } - } - - // No valid credential checks were performed - if (matchResults.length === 0) { - if (listType === 'allow') { - // No valid allow rules means deny - return { shouldAllow: false, shouldDeny: false } - } else { - // No valid deny rules means don't deny - return { shouldAllow: false, shouldDeny: false } - } - } - - // Apply matching strategy - if (listType === 'deny') { - let shouldDeny = false - if (matchRule === 'any') { - // If ANY rule matches, deny - shouldDeny = matchResults.some((r) => r === true) - } else { - // matchRule === 'all' - // If ALL rules match, deny - shouldDeny = matchResults.every((r) => r === true) - } - return { shouldAllow: false, shouldDeny } - } else { - // listType === 'allow' - let shouldAllow = false - if (matchRule === 'any') { - // If ANY rule matches, allow - shouldAllow = matchResults.some((r) => r === true) - } else { - // matchRule === 'all' - // ALL rules must match - shouldAllow = matchResults.every((r) => r === true) - } - return { shouldAllow, shouldDeny: false } + const allowed = await evaluateCredentials( + consumerAddress, + credentials, + accessListResolver(signer) + ) + if (!allowed) { + CORE_LOGGER.debug(`Access denied by credentials for consumer ${consumerAddress}`) } + return allowed } /** * Checks if a consumer address matches a single credential rule * * @param credential The credential rule to check - * @param consumerAddress The consumer address (already normalized) + * @param consumerAddress The consumer address * @param signer Signer for blockchain checks * @returns Promise - true if matches, false if doesn't match, null if unknown type */ -export async function checkSingleCredential( - credential: Credential, +export function checkSingleCredential( + credential: CredentialRule, consumerAddress: string, signer: Signer | null ): Promise { - // A malformed rule (null, or no string type) is treated as an unknown type, not a crash - if (!credential || typeof credential.type !== 'string') { - return null - } - const credentialType = credential.type.toLowerCase() - - // ======================================== - // Handle ADDRESS-based credentials - // ======================================== - if (credentialType === CREDENTIALS_TYPES.ADDRESS.toLowerCase()) { - // Entries may be plain strings or { address } objects; ddo.js reads both formats - const addresses = getCredentialAddresses(credential as any).map((a) => - a.toLowerCase() - ) - if (addresses.length === 0) { - return false - } + return evaluateCredential(credential, consumerAddress, accessListResolver(signer)) +} - // Check for wildcard (*) - if (addresses.includes('*')) { - return true - } +/** + * Resolves the rule types ddo.js cannot check itself. `address` rules never reach + * here; ddo.js matches them. + */ +function accessListResolver(signer: Signer | null): CredentialResolver { + return (credential, consumerAddress) => + resolveCredential(credential, consumerAddress, signer) +} - // Check if address is in the list - return addresses.includes(consumerAddress.toLowerCase()) - } +async function resolveCredential( + credential: CredentialRule, + consumerAddress: string, + signer: Signer | null +): Promise { + const credentialType = credential.type.toLowerCase() // ======================================== // Handle ACCESSLIST-based credentials @@ -210,12 +98,11 @@ export async function checkSingleCredential( try { // Check if the consumer address has tokens in the access list contract - const hasAccess = await checkAddressOnAccessListWithSigner( + return await checkAddressOnAccessListWithSigner( accessListCredential.accessList, consumerAddress, signer ) - return hasAccess } catch (error) { CORE_LOGGER.error( `Error checking accessList credential ${accessListCredential.accessList}: ${errorSummary(error)}` From f0f7841c3b7b0a112474771dca6d7674f6764d7f Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 13:02:43 +0200 Subject: [PATCH 04/11] use ddo.js evaluateAlgorithmTrust and isComputeService for compute trust checks fix getFees crash on unknown serviceId; skip malformed trusted-algorithm entries instead of crashing --- src/components/core/compute/initialize.ts | 4 +- src/components/core/compute/startCompute.ts | 4 +- src/components/core/compute/utils.ts | 90 ++++++------------- src/components/core/handler/feesHandler.ts | 16 ++-- .../unit/computeTrustedAlgoBinding.test.ts | 72 +++++++++++++++ 5 files changed, 113 insertions(+), 73 deletions(-) diff --git a/src/components/core/compute/initialize.ts b/src/components/core/compute/initialize.ts index c78e611a7..380626c85 100644 --- a/src/components/core/compute/initialize.ts +++ b/src/components/core/compute/initialize.ts @@ -34,7 +34,7 @@ import { resolveComputeFileObject } from '../../c2d/compute_engine_docker.js' -import { Credentials, DDOManager, Service } from '@oceanprotocol/ddo-js' +import { Credentials, DDOManager, Service, isComputeService } from '@oceanprotocol/ddo-js' import { checkCredentials } from '../../../utils/credentials.js' import { PolicyServer } from '../../policyServer/index.js' import { @@ -568,7 +568,7 @@ export class ComputeInitializeHandler extends CommandHandler { `Could not decrypt ddo files of ${ddoInstance.getDid()}: ${errorSummary(e)}` ) } - if (service.type === 'compute' && !canDecrypt) { + if (isComputeService(service) && !canDecrypt) { const error = `Service ${elem.serviceId} from DDO ${elem.documentId} cannot be used in compute on this provider` return { stream: null, diff --git a/src/components/core/compute/startCompute.ts b/src/components/core/compute/startCompute.ts index 24cf7d9a0..745558ce1 100644 --- a/src/components/core/compute/startCompute.ts +++ b/src/components/core/compute/startCompute.ts @@ -42,7 +42,7 @@ import { sanitizeServiceFiles } from '../../../utils/util.js' import { FindDdoHandler } from '../handler/ddoHandler.js' // import { ProviderFeeValidation } from '../../../@types/Fees.js' import { isOrderingAllowedForAsset } from '../handler/downloadHandler.js' -import { Credentials, DDOManager, Service } from '@oceanprotocol/ddo-js' +import { Credentials, DDOManager, Service, isComputeService } from '@oceanprotocol/ddo-js' import { getNonceAsNumber } from '../utils/nonceHandler.js' import { PolicyServer } from '../../policyServer/index.js' import { checkCredentials } from '../../../utils/credentials.js' @@ -528,7 +528,7 @@ export class CommonComputeHandler extends CommandHandler { // errorSummary: a JSON.parse error would quote the decrypted files object CORE_LOGGER.error(`Could not decrypt DDO files Object: ${errorSummary(e)}`) } - if (service.type === 'compute' && !canDecrypt) { + if (isComputeService(service) && !canDecrypt) { return buildComputeError( 500, `Service ${elem.serviceId} from DDO ${elem.documentId} cannot be used in compute on this provider` diff --git a/src/components/core/compute/utils.ts b/src/components/core/compute/utils.ts index 2b222e38e..fc35a08cc 100644 --- a/src/components/core/compute/utils.ts +++ b/src/components/core/compute/utils.ts @@ -17,7 +17,7 @@ import { CORE_LOGGER } from '../../../utils/logging/common.js' import { errorSummary } from '../../../utils/logging/redact.js' import { createHash } from 'crypto' import { FindDdoHandler } from '../../core/handler/ddoHandler.js' -import { DDOManager, VersionedDDO } from '@oceanprotocol/ddo-js' +import { DDOManager, VersionedDDO, evaluateAlgorithmTrust } from '@oceanprotocol/ddo-js' import { P2PCommandResponse } from '../../../@types/index.js' @@ -233,6 +233,12 @@ export async function bindAlgorithmContainerToDDO( return 'bound' } +/** + * Decides whether an algorithm may run on a dataset service. The trust rules + * (access service, trusted algorithms, trusted publishers, raw algorithms) are + * evaluated by ddo.js `evaluateAlgorithmTrust`; the node only resolves the + * algorithm's NFT address for `publisherTrustedAlgorithmPublishers`. + */ export async function validateAlgoForDataset( algoDID: string, algoChecksums: { @@ -243,75 +249,31 @@ export async function validateAlgoForDataset( ddoInstance: VersionedDDO, datasetServiceId: string, oceanNode: OceanNode -) { +): Promise { + const logPrefix = `validateAlgoForDataset (dataset ${ddoInstance?.getDid?.()}, algo ${algoDID})` try { - const { services } = ddoInstance.getDDOFields() as any - const datasetService = services.find( - (service: any) => service.id === datasetServiceId - ) + const datasetService = ddoInstance.getService(datasetServiceId) if (!datasetService) { - throw new Error('Dataset service not found') - } - if (datasetService.type === 'access') { - return true + CORE_LOGGER.error(`${logPrefix}: Dataset service not found`) + return false } - const { compute } = datasetService - if (datasetService.type !== 'compute' || !compute) { - throw new Error('Service not compute') - } - const publishers = compute.publisherTrustedAlgorithmPublishers || [] - const algorithms = compute.publisherTrustedAlgorithms || [] - - // If no restrictions are set, deny by default - const hasTrustedPublishers = publishers.length > 0 - const hasTrustedAlgorithms = algorithms.length > 0 - if (!hasTrustedPublishers && !hasTrustedAlgorithms) return false - - if (algoDID) { - // Check if algorithm is explicitly trusted - const isAlgoTrusted = - hasTrustedAlgorithms && - algorithms.some((algo: any) => { - const didMatch = algo.did === '*' || algo.did === algoDID - const filesMatch = - algo.filesChecksum === '*' || algo.filesChecksum === algoChecksums.files - const containerMatch = - algo.containerSectionChecksum === '*' || - algo.containerSectionChecksum === algoChecksums.container - if ('serviceId' in algo) { - const serviceIdMatch = - algo.serviceId === '*' || algo.serviceId === algoChecksums.serviceId - return didMatch && filesMatch && containerMatch && serviceIdMatch - } - - return didMatch && filesMatch && containerMatch - }) - - // Check if algorithm publisher is trusted - let isPublisherTrusted = false - if (hasTrustedPublishers) { - if (!publishers.includes('*')) { - const algoDDO = await new FindDdoHandler(oceanNode).findAndFormatDdo(algoDID) - if (!algoDDO) return false - const algoInstance = DDOManager.getDDOClass(algoDDO) - const { nftAddress } = algoInstance.getDDOFields() - - isPublisherTrusted = publishers - .map((addr: string) => addr?.toLowerCase()) - .includes(nftAddress?.toLowerCase()) - } else { - isPublisherTrusted = true + return await evaluateAlgorithmTrust( + datasetService, + algoDID, + algoChecksums, + async (did) => { + try { + const algoDDO = await new FindDdoHandler(oceanNode).findAndFormatDdo(did) + if (!algoDDO) return null + return DDOManager.getDDOClass(algoDDO).getDDOFields().nftAddress + } catch (error) { + CORE_LOGGER.error(`${logPrefix}: ${error.message}`) + return null } } - - return isAlgoTrusted || isPublisherTrusted - } - - return compute.allowRawAlgorithm - } catch (error) { - CORE_LOGGER.error( - `validateAlgoForDataset (dataset ${ddoInstance?.getDid?.()}, algo ${algoDID}): ${error.message}` ) + } catch (error) { + CORE_LOGGER.error(`${logPrefix}: ${error.message}`) return false } } diff --git a/src/components/core/handler/feesHandler.ts b/src/components/core/handler/feesHandler.ts index cd1911133..080fa7f07 100644 --- a/src/components/core/handler/feesHandler.ts +++ b/src/components/core/handler/feesHandler.ts @@ -16,7 +16,7 @@ import { ProviderInitialize } from '../../../@types/Fees.js' import { getNonce } from '../utils/nonceHandler.js' import { streamToString } from '../../../utils/util.js' import { isOrderingAllowedForAsset } from './downloadHandler.js' -import { DDOManager } from '@oceanprotocol/ddo-js' +import { DDOManager, isComputeService } from '@oceanprotocol/ddo-js' export class FeesHandler extends CommandHandler { validate(command: GetFeesCommand): ValidateParams { @@ -60,13 +60,19 @@ export class FeesHandler extends CommandHandler { } const ddoInstance = DDOManager.getDDOClass(ddo) - const { services } = ddoInstance.getDDOFields() as any - const service = services.find((what: any) => what.id === task.serviceId) + const service = ddoInstance.getService(task.serviceId) as any if (!service) { - errorMsg = 'Invalid serviceId' + PROVIDER_LOGGER.debug(`getFees ${task.ddoId}/${task.serviceId}: Invalid serviceId`) + return { + stream: null, + status: { + httpStatus: 500, + error: 'Invalid serviceId' + } + } } - if (service.type === 'compute') { + if (isComputeService(service)) { errorMsg = 'Use the initializeCompute endpoint to initialize compute jobs' } const now = new Date().getTime() / 1000 diff --git a/src/test/unit/computeTrustedAlgoBinding.test.ts b/src/test/unit/computeTrustedAlgoBinding.test.ts index 87ad63368..704acb256 100644 --- a/src/test/unit/computeTrustedAlgoBinding.test.ts +++ b/src/test/unit/computeTrustedAlgoBinding.test.ts @@ -398,6 +398,78 @@ describe('validateAlgoForDataset (trusted-algo allow/deny still holds)', () => { ) expect(result).to.equal(false) }) + + it('rejects when the dataset service id does not exist', async () => { + const ddoInstance = DDOManager.getDDOClass(datasetDDO([{ did: '*' }])) + const result = await validateAlgoForDataset( + ALGO_DID, + checksums, + ddoInstance, + 'no-such-service', + {} as any + ) + expect(result).to.equal(false) + }) + + describe('trusted publishers (algorithm NFT address resolved by the node)', () => { + afterEach(() => { + sinon.restore() + }) + + function publisherDDO(publishers: string[]) { + const ddo = datasetDDO([]) + ddo.services[0].compute.publisherTrustedAlgorithmPublishers = publishers + return DDOManager.getDDOClass(ddo) + } + + it('allows an algorithm whose NFT address is a trusted publisher', async () => { + sinon.stub(FindDdoHandler.prototype, 'findAndFormatDdo').resolves(algoDDO()) + const result = await validateAlgoForDataset( + ALGO_DID, + checksums, + publisherDDO(['0x0000000000000000000000000000000000000001']), + DATASET_SERVICE_ID, + {} as any + ) + expect(result).to.equal(true) + }) + + it('rejects an algorithm from another publisher', async () => { + sinon.stub(FindDdoHandler.prototype, 'findAndFormatDdo').resolves(algoDDO()) + const result = await validateAlgoForDataset( + ALGO_DID, + checksums, + publisherDDO(['0x00000000000000000000000000000000000000ff']), + DATASET_SERVICE_ID, + {} as any + ) + expect(result).to.equal(false) + }) + + it('rejects when the algorithm DDO cannot be resolved or the lookup throws', async () => { + const stub = sinon.stub(FindDdoHandler.prototype, 'findAndFormatDdo').resolves(null) + const ddoInstance = publisherDDO(['0x0000000000000000000000000000000000000001']) + expect( + await validateAlgoForDataset( + ALGO_DID, + checksums, + ddoInstance, + DATASET_SERVICE_ID, + {} as any + ) + ).to.equal(false) + stub.rejects(new Error('db down')) + expect( + await validateAlgoForDataset( + ALGO_DID, + checksums, + ddoInstance, + DATASET_SERVICE_ID, + {} as any + ) + ).to.equal(false) + }) + }) }) // Handler-level regression tests. The helper tests above call the binding directly, so From 42c12fe1780e1d3d428a0cf34c9d9709d8c3a27b Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 13:12:35 +0200 Subject: [PATCH 05/11] use ddo.js getServiceByDatatoken in indexer processors, remove findServiceIdByDatatoken fix stats not written when a service has no datatokenAddress --- .../processors/DispenserActivatedEventProcessor.ts | 3 +-- .../processors/DispenserCreatedEventProcessor.ts | 3 +-- .../processors/DispenserDeactivatedEventProcessor.ts | 3 +-- .../processors/ExchangeActivatedEventProcessor.ts | 3 +-- .../processors/ExchangeCreatedEventProcessor.ts | 3 +-- .../processors/ExchangeDeactivatedEventProcessor.ts | 3 +-- .../processors/ExchangeRateChangedEventProcessor.ts | 3 +-- .../Indexer/processors/OrderReusedEventProcessor.ts | 9 ++------- src/components/Indexer/utils.ts | 12 ------------ 9 files changed, 9 insertions(+), 33 deletions(-) diff --git a/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts b/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts index 680d98d21..e116e47a2 100644 --- a/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts +++ b/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts @@ -6,7 +6,6 @@ import { getDtContract, getDid, doesDispenserAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidDispenserContract } from '../utils.js' @@ -86,7 +85,7 @@ export class DispenserActivatedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[DispenserActivated] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[DispenserActivated] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts b/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts index 5a21d9d54..adaa08814 100644 --- a/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts +++ b/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts @@ -7,7 +7,6 @@ import { getDtContract, getDid, doesDispenserAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidDispenserContract } from '../utils.js' @@ -88,7 +87,7 @@ export class DispenserCreatedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[DispenserCreated] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[DispenserCreated] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts b/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts index 462a9dd10..956e4a6b4 100644 --- a/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts +++ b/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts @@ -6,7 +6,6 @@ import { getDtContract, getDid, doesDispenserAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidDispenserContract } from '../utils.js' @@ -89,7 +88,7 @@ export class DispenserDeactivatedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[DispenserDeactivated] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[DispenserDeactivated] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts b/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts index 194e70c78..6d593dcae 100644 --- a/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts @@ -6,7 +6,6 @@ import { getDtContract, getDid, doesFreAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidFreContract } from '../utils.js' @@ -89,7 +88,7 @@ export class ExchangeActivatedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[ExchangeActivated] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[ExchangeActivated] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts b/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts index c38837db7..12491e71d 100644 --- a/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts @@ -6,7 +6,6 @@ import { getDtContract, getDid, doesFreAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidFreContract } from '../utils.js' @@ -90,7 +89,7 @@ export class ExchangeCreatedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[ExchangeCreated] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[ExchangeCreated] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts b/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts index 1d4df94b1..8242ce596 100644 --- a/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts @@ -6,7 +6,6 @@ import { getDtContract, getDid, doesFreAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidFreContract } from '../utils.js' @@ -97,7 +96,7 @@ export class ExchangeDeactivatedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[ExchangeDeactivated] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[ExchangeDeactivated] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts b/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts index 8151c12e2..a63cfc04d 100644 --- a/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts @@ -7,7 +7,6 @@ import { getDtContract, getDid, doesFreAlreadyExist, - findServiceIdByDatatoken, getPricesByDt, isValidFreContract } from '../utils.js' @@ -91,7 +90,7 @@ export class ExchangeRateChangedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[ExchangeRateChanged] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, datatokenAddress) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(datatokenAddress)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[ExchangeRateChanged] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/processors/OrderReusedEventProcessor.ts b/src/components/Indexer/processors/OrderReusedEventProcessor.ts index 5f2481919..2db9386a8 100644 --- a/src/components/Indexer/processors/OrderReusedEventProcessor.ts +++ b/src/components/Indexer/processors/OrderReusedEventProcessor.ts @@ -2,12 +2,7 @@ import { DDOManager } from '@oceanprotocol/ddo-js' import { ethers, Signer, FallbackProvider } from 'ethers' import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' -import { - getDtContract, - getDid, - findServiceIdByDatatoken, - getPricesByDt -} from '../utils.js' +import { getDtContract, getDid, getPricesByDt } from '../utils.js' import { BaseEventProcessor } from './BaseProcessor.js' import ERC20Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC20TemplateEnterprise.sol/ERC20TemplateEnterprise.json' with { type: 'json' } @@ -67,7 +62,7 @@ export class OrderReusedEventProcessor extends BaseEventProcessor { } } else { INDEXER_LOGGER.debug(`[OrderReused] - No stats were found on the ddo`) - const serviceIdToFind = findServiceIdByDatatoken(ddoInstance, event.address) + const serviceIdToFind = ddoInstance.getServiceByDatatoken(event.address)?.id if (!serviceIdToFind) { INDEXER_LOGGER.debug( `[OrderReused] - This datatoken does not contain this service. Invalid service id!` diff --git a/src/components/Indexer/utils.ts b/src/components/Indexer/utils.ts index 471acd42b..a7cca8c45 100644 --- a/src/components/Indexer/utils.ts +++ b/src/components/Indexer/utils.ts @@ -245,18 +245,6 @@ export function buildJobIdentifier(command: string, extra: string[]): JobStatus } } -export function findServiceIdByDatatoken( - ddo: VersionedDDO, - datatokenAddress: string -): string { - for (const s of ddo.getDDOFields().services) { - if (s.datatokenAddress.toLowerCase() === datatokenAddress.toLowerCase()) { - return s.id - } - } - return null -} - export function doesDispenserAlreadyExist( dispenserAddress: string, prices: ServicePrice[] From a8fb48624c202264ff7946146656f4e78dd3c883 Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 14:25:58 +0200 Subject: [PATCH 06/11] find v5 (did:ope) DDOs in indexer events and remote FindDDO via ddo.js DID helpers; remove v4-only getDid, validateDDOHash, generateDDOHash add tests for v5 DDO lookup, remote v5 FindDDO and stats init on DDOs without indexedMetadata --- .../DispenserActivatedEventProcessor.ts | 5 +- .../DispenserCreatedEventProcessor.ts | 5 +- .../DispenserDeactivatedEventProcessor.ts | 5 +- .../ExchangeActivatedEventProcessor.ts | 5 +- .../ExchangeCreatedEventProcessor.ts | 5 +- .../ExchangeDeactivatedEventProcessor.ts | 5 +- .../ExchangeRateChangedEventProcessor.ts | 5 +- .../processors/MetadataEventProcessor.ts | 18 +++-- .../processors/MetadataStateEventProcessor.ts | 5 +- .../processors/OrderReusedEventProcessor.ts | 5 +- .../processors/OrderStartedEventProcessor.ts | 5 +- src/components/Indexer/utils.ts | 28 +++++--- src/components/core/handler/ddoHandler.ts | 26 +++++-- src/test/unit/findDdoProviders.test.ts | 30 ++++++-- src/test/unit/indexer/indexedMetadata.test.ts | 72 +++++++++++++++++++ .../unit/indexer/retrieveDdoByNft.test.ts | 54 ++++++++++++++ src/utils/asset.ts | 41 +---------- 17 files changed, 225 insertions(+), 94 deletions(-) create mode 100644 src/test/unit/indexer/indexedMetadata.test.ts create mode 100644 src/test/unit/indexer/retrieveDdoByNft.test.ts diff --git a/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts b/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts index e116e47a2..a780c1d80 100644 --- a/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts +++ b/src/components/Indexer/processors/DispenserActivatedEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesDispenserAlreadyExist, getPricesByDt, isValidDispenserContract @@ -41,10 +41,9 @@ export class DispenserActivatedEventProcessor extends BaseEventProcessor { const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) try { const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected DispenserActivated changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts b/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts index adaa08814..ffba2deec 100644 --- a/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts +++ b/src/components/Indexer/processors/DispenserCreatedEventProcessor.ts @@ -5,7 +5,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesDispenserAlreadyExist, getPricesByDt, isValidDispenserContract @@ -42,10 +42,9 @@ export class DispenserCreatedEventProcessor extends BaseEventProcessor { const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) try { const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected DispenserCreated changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts b/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts index 956e4a6b4..72c8bc640 100644 --- a/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts +++ b/src/components/Indexer/processors/DispenserDeactivatedEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesDispenserAlreadyExist, getPricesByDt, isValidDispenserContract @@ -41,10 +41,9 @@ export class DispenserDeactivatedEventProcessor extends BaseEventProcessor { const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) try { const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected DispenserDeactivated changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts b/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts index 6d593dcae..f85519fed 100644 --- a/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeActivatedEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesFreAlreadyExist, getPricesByDt, isValidFreContract @@ -49,10 +49,9 @@ export class ExchangeActivatedEventProcessor extends BaseEventProcessor { } const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected ExchangeActivated changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts b/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts index 12491e71d..d949ed8e5 100644 --- a/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeCreatedEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesFreAlreadyExist, getPricesByDt, isValidFreContract @@ -49,10 +49,9 @@ export class ExchangeCreatedEventProcessor extends BaseEventProcessor { } const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected ExchangeCreated changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts b/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts index 8242ce596..63c6fb407 100644 --- a/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeDeactivatedEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesFreAlreadyExist, getPricesByDt, isValidFreContract @@ -55,10 +55,9 @@ export class ExchangeDeactivatedEventProcessor extends BaseEventProcessor { } const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) try { const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected ExchangeDeactivated changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts b/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts index a63cfc04d..4e919735a 100644 --- a/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts +++ b/src/components/Indexer/processors/ExchangeRateChangedEventProcessor.ts @@ -5,7 +5,7 @@ import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { getDtContract, - getDid, + retrieveDdoByNft, doesFreAlreadyExist, getPricesByDt, isValidFreContract @@ -50,10 +50,9 @@ export class ExchangeRateChangedEventProcessor extends BaseEventProcessor { } const datatokenContract = getDtContract(signer, datatokenAddress) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected ExchangeRateChanged changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/MetadataEventProcessor.ts b/src/components/Indexer/processors/MetadataEventProcessor.ts index f5f844bba..2f990a65e 100644 --- a/src/components/Indexer/processors/MetadataEventProcessor.ts +++ b/src/components/Indexer/processors/MetadataEventProcessor.ts @@ -1,4 +1,4 @@ -import { DDOManager, DDO, VersionedDDO } from '@oceanprotocol/ddo-js' +import { DDOManager, DDO, VersionedDDO, deriveDid } from '@oceanprotocol/ddo-js' import { ethers, Signer, FallbackProvider, getAddress } from 'ethers' import { ENVIRONMENT_VARIABLES, @@ -13,7 +13,11 @@ import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { errorSummary } from '../../../utils/logging/redact.js' import { asyncCallWithTimeout } from '../../../utils/util.js' import { PolicyServer } from '../../policyServer/index.js' -import { wasNFTDeployedByOurFactory, getPricingStatsForDddo, getDid } from '../utils.js' +import { + wasNFTDeployedByOurFactory, + getPricingStatsForDddo, + retrieveDdoByNft +} from '../utils.js' import { BaseEventProcessor } from './BaseProcessor.js' import ERC721Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC721Template.sol/ERC721Template.json' with { type: 'json' } import { Purgatory } from '../purgatory.js' @@ -55,7 +59,8 @@ export class MetadataEventProcessor extends BaseEventProcessor { const dataNftAddress = ethers.getAddress(event.address) - did = getDid(event.address, chainId) + // v4 DID until the DDO is decrypted and its own id is checked below + did = deriveDid(event.address, chainId, '4') const templateContract = new ethers.Contract( dataNftAddress, @@ -70,7 +75,10 @@ export class MetadataEventProcessor extends BaseEventProcessor { `Delete DDO ${did} because Metadata state is ${metadataState}` ) const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const found = await retrieveDdoByNft(ddoDatabase, event.address, chainId) + // eslint-disable-next-line prefer-destructuring + did = found.did + const { ddo } = found if (!ddo) { INDEXER_LOGGER.debug( `Detected MetadataState changed for ${did}, but it does not exists.` @@ -132,6 +140,8 @@ export class MetadataEventProcessor extends BaseEventProcessor { ) return } + // The id matches the NFT and chain, so it is this asset's DID (v4 or v5) + did = updatedDdo.id // for unencrypted DDOs if ((parseInt(flag) & 2) === 0 && !this.checkDdoHash(updatedDdo, metadataHash)) { INDEXER_LOGGER.debug( diff --git a/src/components/Indexer/processors/MetadataStateEventProcessor.ts b/src/components/Indexer/processors/MetadataStateEventProcessor.ts index f7572acc6..b9084dd77 100644 --- a/src/components/Indexer/processors/MetadataStateEventProcessor.ts +++ b/src/components/Indexer/processors/MetadataStateEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS, MetadataStates } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { BaseEventProcessor } from './BaseProcessor.js' import ERC721Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC721Template.sol/ERC721Template.json' with { type: 'json' } -import { getDid } from '../utils.js' +import { retrieveDdoByNft } from '../utils.js' export class MetadataStateEventProcessor extends BaseEventProcessor { async processEvent( @@ -23,11 +23,10 @@ export class MetadataStateEventProcessor extends BaseEventProcessor { const metadataState = parseInt(decodedEventData.args[1].toString()) INDEXER_LOGGER.debug(`Processed new metadata state ${metadataState} `) INDEXER_LOGGER.debug(`NFT address in processing MetadataState: ${event.address} `) - const did = getDid(event.address, chainId) try { const { ddo: ddoDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, event.address, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected MetadataState changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/OrderReusedEventProcessor.ts b/src/components/Indexer/processors/OrderReusedEventProcessor.ts index 2db9386a8..2d099743e 100644 --- a/src/components/Indexer/processors/OrderReusedEventProcessor.ts +++ b/src/components/Indexer/processors/OrderReusedEventProcessor.ts @@ -2,7 +2,7 @@ import { DDOManager } from '@oceanprotocol/ddo-js' import { ethers, Signer, FallbackProvider } from 'ethers' import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' -import { getDtContract, getDid, getPricesByDt } from '../utils.js' +import { getDtContract, retrieveDdoByNft, getPricesByDt } from '../utils.js' import { BaseEventProcessor } from './BaseProcessor.js' import ERC20Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC20TemplateEnterprise.sol/ERC20TemplateEnterprise.json' with { type: 'json' } @@ -27,10 +27,9 @@ export class OrderReusedEventProcessor extends BaseEventProcessor { const datatokenContract = getDtContract(signer, event.address) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) try { const { ddo: ddoDatabase, order: orderDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected OrderReused changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/processors/OrderStartedEventProcessor.ts b/src/components/Indexer/processors/OrderStartedEventProcessor.ts index 8d09bfec6..b8c6d65ea 100644 --- a/src/components/Indexer/processors/OrderStartedEventProcessor.ts +++ b/src/components/Indexer/processors/OrderStartedEventProcessor.ts @@ -2,7 +2,7 @@ import { DDOManager } from '@oceanprotocol/ddo-js' import { ethers, Signer, FallbackProvider } from 'ethers' import { EVENTS } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' -import { getDtContract, getDid, getPricesByDt } from '../utils.js' +import { getDtContract, retrieveDdoByNft, getPricesByDt } from '../utils.js' import { BaseEventProcessor } from './BaseProcessor.js' import ERC20Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC20TemplateEnterprise.sol/ERC20TemplateEnterprise.json' with { type: 'json' } @@ -29,10 +29,9 @@ export class OrderStartedEventProcessor extends BaseEventProcessor { const datatokenContract = getDtContract(signer, event.address) const nftAddress = await datatokenContract.getERC721Address() - const did = getDid(nftAddress, chainId) try { const { ddo: ddoDatabase, order: orderDatabase } = await this.getDatabase() - const ddo = await ddoDatabase.retrieve(did) + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, nftAddress, chainId) if (!ddo) { INDEXER_LOGGER.debug( `Detected OrderStarted changed for ${did}, but it does not exists.` diff --git a/src/components/Indexer/utils.ts b/src/components/Indexer/utils.ts index a7cca8c45..4dd6d390b 100644 --- a/src/components/Indexer/utils.ts +++ b/src/components/Indexer/utils.ts @@ -11,9 +11,8 @@ import { CommandStatus, JobStatus } from '../../@types/commands.js' import { create256Hash } from '../../utils/crypt.js' import Dispenser from '@oceanprotocol/contracts/artifacts/contracts/pools/dispenser/Dispenser.sol/Dispenser.json' with { type: 'json' } import FixedRateExchange from '@oceanprotocol/contracts/artifacts/contracts/pools/fixedRate/FixedRateExchange.sol/FixedRateExchange.json' with { type: 'json' } -import { createHash } from 'crypto' import { ServicePrice } from '../../@types/IndexedMetadata.js' -import { VersionedDDO } from '@oceanprotocol/ddo-js' +import { VersionedDDO, deriveDidCandidates } from '@oceanprotocol/ddo-js' import FactoryRouter from '@oceanprotocol/contracts/artifacts/contracts/pools/FactoryRouter.sol/FactoryRouter.json' with { type: 'json' } /** @@ -473,13 +472,24 @@ export async function getPricingStatsForDddo( return ddo } -export function getDid(nftAddress: string, chainId: number): string { - return ( - 'did:op:' + - createHash('sha256') - .update(getAddress(nftAddress) + chainId.toString(10)) - .digest('hex') - ) +/** + * Finds the DDO of an NFT. Contract events only give the NFT address and chain id, + * so the DDO is looked up under both DIDs it may be indexed as: v4 (`did:op:`) + * first, then v5 (`did:ope:`). + * @returns The DDO and the DID it was found under. When neither is indexed, `ddo` + * is null and `did` is the v4 DID. + */ +export async function retrieveDdoByNft( + ddoDatabase: { retrieve(did: string): Promise | null> }, + nftAddress: string, + chainId: number +): Promise<{ did: string; ddo: Record | null }> { + const candidates = deriveDidCandidates(nftAddress, chainId) + for (const did of candidates) { + const ddo = await ddoDatabase.retrieve(did) + if (ddo) return { did, ddo } + } + return { did: candidates[0], ddo: null } } export async function withRetrial( diff --git a/src/components/core/handler/ddoHandler.ts b/src/components/core/handler/ddoHandler.ts index ba233a5f3..8bcd1d412 100644 --- a/src/components/core/handler/ddoHandler.ts +++ b/src/components/core/handler/ddoHandler.ts @@ -43,8 +43,15 @@ import { getNetworkHeight, wasNFTDeployedByOurFactory } from '../../Indexer/utils.js' -import { deleteIndexedMetadataIfExists, validateDDOHash } from '../../../utils/asset.js' -import { Asset, DDO, DDOManager } from '@oceanprotocol/ddo-js' +import { deleteIndexedMetadataIfExists } from '../../../utils/asset.js' +import { + Asset, + DDO, + DDOManager, + getDdoChainId, + getDdoNftAddress, + matchesDid +} from '@oceanprotocol/ddo-js' import { checkCredentialOnAccessList } from '../../../utils/credentials.js' const MAX_NUM_PROVIDERS = 5 @@ -638,10 +645,13 @@ export class FindDdoHandler extends CommandHandler { const isResponseLegit = await checkIfDDOResponseIsLegit(ddo, node) if (isResponseLegit) { + // v5 keeps metadata under credentialSubject; the event tx may be tx or txid + const { metadata } = DDOManager.getDDOClass(ddo).getDDOFields() const ddoInfo: FindDDOResponse = { id: ddo.id, - lastUpdateTx: ddo.indexedMetadata.event.txid, - lastUpdateTime: ddo.metadata.updated, + lastUpdateTx: + ddo.indexedMetadata.event.txid || ddo.indexedMetadata.event.tx, + lastUpdateTime: metadata?.updated, provider: peer } resultList.push(ddoInfo) @@ -1140,9 +1150,11 @@ async function checkIfDDOResponseIsLegit( const clonedDdo = structuredClone(ddo) const { indexedMetadata } = clonedDdo const updatedDdo = deleteIndexedMetadataIfExists(ddo) - const { nftAddress, chainId } = updatedDdo - let isValid = validateDDOHash(updatedDdo.id, nftAddress, chainId) - // 1) check hash sha256(nftAddress + chainId) + // v4 keeps nftAddress/chainId at the top level, v5 under credentialSubject + const nftAddress = getDdoNftAddress(updatedDdo) + const chainId = Number(getDdoChainId(updatedDdo)) + // 1) check the DID is sha256(nftAddress + chainId), with the v4 or v5 prefix + let isValid = matchesDid(updatedDdo.id, nftAddress, chainId) if (!isValid) { CORE_LOGGER.debug(`Asset ${updatedDdo.id} does not have a valid hash`) return false diff --git a/src/test/unit/findDdoProviders.test.ts b/src/test/unit/findDdoProviders.test.ts index 1748561fe..350665e95 100644 --- a/src/test/unit/findDdoProviders.test.ts +++ b/src/test/unit/findDdoProviders.test.ts @@ -1,13 +1,13 @@ import { expect } from 'chai' import { ethers } from 'ethers' import { Readable } from 'stream' +import { deriveDid } from '@oceanprotocol/ddo-js' import { FindDdoHandler, resetDdoNotFoundCache } from '../../components/core/handler/ddoHandler.js' import { OceanNode } from '../../OceanNode.js' import { ENVIRONMENT_VARIABLES, PROTOCOL_COMMANDS } from '../../utils/constants.js' -import { generateDDOHash } from '../../utils/asset.js' import { P2P_TIMEOUTS } from '../../components/P2P/timeouts.js' import { buildEnvOverrideConfig, @@ -35,7 +35,7 @@ import { const CHAIN_ID = 137 const NFT_ADDRESS = '0x1111111111111111111111111111111111111111' -const DDO_ID = generateDDOHash(NFT_ADDRESS, CHAIN_ID) +const DDO_ID = deriveDid(NFT_ADDRESS, CHAIN_ID, '4') const TX_ID = '0x' + 'ab'.repeat(32) const METADATA_CREATED_TOPIC = '0x5463569dcc320958360074a9ab27e809e8a6942c394fb151d139b5f7b4ecb1bd' @@ -50,6 +50,18 @@ const legitimateDdo = (): any => ({ indexedMetadata: { event: { block: 100, txid: TX_ID, tx: TX_ID } } }) +/** The same asset as a v5 DDO: did:ope id, nftAddress/chainId/metadata under credentialSubject. */ +const legitimateDdoV5 = (): any => ({ + id: deriveDid(NFT_ADDRESS, CHAIN_ID, '5'), + version: '5.0.0', + credentialSubject: { + nftAddress: NFT_ADDRESS, + chainId: CHAIN_ID, + metadata: { updated: '2026-01-02T00:00:00Z', created: '2026-01-01T00:00:00Z' } + }, + indexedMetadata: { event: { block: 100, tx: TX_ID } } +}) + /** Same shape, but the id does not hash to (nftAddress, chainId) - the first gate rejects it. */ const forgedDdo = (): any => ({ ...legitimateDdo(), @@ -163,10 +175,10 @@ function buildNode( } as unknown as OceanNode } -const findDdo = async (node: OceanNode): Promise => { +const findDdo = async (node: OceanNode, id: string = DDO_ID): Promise => { const response = await new FindDdoHandler(node).handle({ command: PROTOCOL_COMMANDS.FIND_DDO, - id: DDO_ID + id } as any) expect(response.status.httpStatus).to.equal(200) let text = '' @@ -295,6 +307,16 @@ describe('FindDDO stops at the first legitimate answer', () => { expect(results.length).to.equal(1) expect(results[0].provider).to.equal('honest') }) + + it('accepts a legitimate v5 DDO (did:ope, fields under credentialSubject)', async () => { + const ddo = legitimateDdoV5() + const results = await findDdo(buildNode({ v5: { body: ddo } }), ddo.id) + + expect(results.length, 'the v5 answer must pass verification').to.equal(1) + expect(results[0].id).to.equal(ddo.id) + expect(results[0].lastUpdateTx).to.equal(TX_ID) + expect(results[0].lastUpdateTime).to.equal('2026-01-02T00:00:00Z') + }) }) describe('FindDDO remembers a DDO that was found nowhere', () => { diff --git a/src/test/unit/indexer/indexedMetadata.test.ts b/src/test/unit/indexer/indexedMetadata.test.ts new file mode 100644 index 000000000..0b67ea45d --- /dev/null +++ b/src/test/unit/indexer/indexedMetadata.test.ts @@ -0,0 +1,72 @@ +import { expect } from 'chai' +import { DDOManager } from '@oceanprotocol/ddo-js' + +// The stats processors (OrderStarted/Reused, Exchange*, Dispenser*) initialise a missing +// indexedMetadata with updateFields({ indexedMetadata: {} }) and then read +// indexedMetadata.stats. With ddo-js 1.0.0 that call was a no-op on a DDO that had no +// indexedMetadata, so the next read threw a TypeError and the event was not indexed. +// ddo-js 1.1.0 creates indexedMetadata in updateFields; these tests pin that behaviour. +// Deprecated DDOs are left out: the node always builds them with indexedMetadata.nft +// (MetadataStateEventProcessor) and DeprecatedDDO keeps no stats. + +const NFT_ADDRESS = '0xBB1081DbF3227bbB233Db68f7117114baBb43656' +const STATS: any[] = [ + { + datatokenAddress: '0x0000000000000000000000000000000000000001', + name: 'DT', + serviceId: '0', + orders: 0, + prices: [] + } +] + +function ddosWithoutIndexedMetadata(): Record[] { + return [ + { + '@context': ['https://w3id.org/did/v1'], + id: 'did:op:fa0e8fa9550e8eb13392d6eeb9ba9f8111801b332c8d2345b350b3bc66b379d5', + version: '4.1.0', + chainId: 137, + nftAddress: NFT_ADDRESS, + metadata: { type: 'dataset', name: 'v4' }, + services: [] + }, + { + '@context': ['https://www.w3.org/ns/credentials/v2'], + id: 'did:ope:fa0e8fa9550e8eb13392d6eeb9ba9f8111801b332c8d2345b350b3bc66b379d5', + version: '5.0.0', + credentialSubject: { + id: 'did:ope:fa0e8fa9550e8eb13392d6eeb9ba9f8111801b332c8d2345b350b3bc66b379d5', + chainId: 137, + nftAddress: NFT_ADDRESS, + metadata: { type: 'dataset', name: 'v5' }, + services: [] + } + } + ] +} + +describe('Indexer stats on a DDO without indexedMetadata', () => { + for (const ddo of ddosWithoutIndexedMetadata()) { + it(`processor init sequence creates indexedMetadata.stats (version ${ddo.version})`, () => { + const ddoInstance = DDOManager.getDDOClass(ddo) + expect(ddoInstance.getAssetFields().indexedMetadata).to.equal(undefined) + + // Same sequence as the stats processors + if (!ddoInstance.getAssetFields().indexedMetadata) { + ddoInstance.updateFields({ indexedMetadata: {} }) + } + if (!Array.isArray(ddoInstance.getAssetFields().indexedMetadata.stats)) { + ddoInstance.updateFields({ indexedMetadata: { stats: [] } }) + } + + expect(ddoInstance.getAssetFields().indexedMetadata.stats).to.deep.equal([]) + }) + + it(`updateFields({ indexedMetadata: { stats } }) writes stats directly (version ${ddo.version})`, () => { + const ddoInstance = DDOManager.getDDOClass(ddo) + ddoInstance.updateFields({ indexedMetadata: { stats: STATS } }) + expect(ddoInstance.getAssetFields().indexedMetadata.stats).to.deep.equal(STATS) + }) + } +}) diff --git a/src/test/unit/indexer/retrieveDdoByNft.test.ts b/src/test/unit/indexer/retrieveDdoByNft.test.ts new file mode 100644 index 000000000..6b6dd5737 --- /dev/null +++ b/src/test/unit/indexer/retrieveDdoByNft.test.ts @@ -0,0 +1,54 @@ +import { expect } from 'chai' +import { deriveDid } from '@oceanprotocol/ddo-js' +import { retrieveDdoByNft } from '../../../components/Indexer/utils.js' + +// Contract events (orders, prices, dispensers, metadata state) only give the NFT address and +// chain id. Before, the processors derived the v4 DID (did:op:) only, so events for a v5 asset +// (indexed under did:ope:) were never applied to it. + +const NFT_ADDRESS = '0xBB1081DbF3227bbB233Db68f7117114baBb43656' +const CHAIN_ID = 137 +const DID_V4 = deriveDid(NFT_ADDRESS, CHAIN_ID, '4') +const DID_V5 = deriveDid(NFT_ADDRESS, CHAIN_ID, '5') + +function fakeDdoDatabase(stored: Record) { + const lookups: string[] = [] + return { + lookups, + retrieve(did: string): Promise | null> { + lookups.push(did) + return Promise.resolve(stored[did] ?? null) + } + } +} + +describe('retrieveDdoByNft', () => { + it('finds a v4 DDO with a single lookup', async () => { + const db = fakeDdoDatabase({ [DID_V4]: { id: DID_V4 } }) + const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) + expect(did).to.equal(DID_V4) + expect(ddo).to.deep.equal({ id: DID_V4 }) + expect(db.lookups).to.deep.equal([DID_V4]) + }) + + it('finds a v5 DDO indexed under did:ope:', async () => { + const db = fakeDdoDatabase({ [DID_V5]: { id: DID_V5 } }) + const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) + expect(did).to.equal(DID_V5) + expect(ddo).to.deep.equal({ id: DID_V5 }) + expect(db.lookups).to.deep.equal([DID_V4, DID_V5]) + }) + + it('returns a null DDO and the v4 DID when neither is indexed', async () => { + const db = fakeDdoDatabase({}) + const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) + expect(did).to.equal(DID_V4) + expect(ddo).to.equal(null) + }) + + it('matches the NFT address in any letter case', async () => { + const db = fakeDdoDatabase({ [DID_V5]: { id: DID_V5 } }) + const { did } = await retrieveDdoByNft(db, NFT_ADDRESS.toLowerCase(), CHAIN_ID) + expect(did).to.equal(DID_V5) + }) +}) diff --git a/src/utils/asset.ts b/src/utils/asset.ts index f024c49f6..406a12e95 100644 --- a/src/utils/asset.ts +++ b/src/utils/asset.ts @@ -1,11 +1,10 @@ import { Service, DDOManager, DDO } from '@oceanprotocol/ddo-js' import type { Dispatcher } from 'undici' import { PRIVATE_URL_ERROR } from './safeUrl.js' -import { DDO_IDENTIFIER_PREFIX } from './constants.js' import { CORE_LOGGER } from './logging/common.js' import { errorSummary, safeStringify } from './logging/redact.js' import { createHash } from 'crypto' -import { ethers, getAddress, Signer } from 'ethers' +import { ethers, Signer } from 'ethers' import { KNOWN_CONFIDENTIAL_EVMS } from './address.js' import ERC20Template from '@oceanprotocol/contracts/artifacts/contracts/interfaces/IERC20Template.sol/IERC20Template.json' with { type: 'json' } import ERC20Template4 from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC20Template4.sol/ERC20Template4.json' with { type: 'json' } @@ -86,26 +85,6 @@ export async function fetchFileMetadata( } } -/** - * Validates if a given DDO identifier matches the NFT address and the chain ID provided - * @param ddoID the ID of the DDO - * @param nftAddress the nft address - * @param chainId the chain id - * @returns validation result - */ -export function validateDDOHash( - ddoID: string, - nftAddress: string, - chainId: number -): boolean { - if (!ddoID || !nftAddress || !chainId) { - CORE_LOGGER.debug('Invalid or missing data for proper DDO id validation') - return false - } - const hashAddressAndChain: string = generateDDOHash(nftAddress, chainId) - return ddoID === hashAddressAndChain -} - export function deleteIndexedMetadataIfExists(ddo: DDO): DDO { const ddoCopy: DDO = structuredClone(ddo) if ('indexedMetadata' in ddoCopy) { @@ -115,24 +94,6 @@ export function deleteIndexedMetadataIfExists(ddo: DDO): DDO { return ddo } -/** - * Generates DDO Id given the chain and nft address provided - * @param nftAddress the nft address - * @param chainId the chain id - * @returns did - */ -export function generateDDOHash(nftAddress: string, chainId: number): string | null { - if (!nftAddress || !chainId) { - CORE_LOGGER.debug('Invalid or missing data for proper DDO id hash generation') - return null - } - const hashAddressAndChain: string = createHash('sha256') - .update(getAddress(nftAddress) + chainId.toString(10)) - .digest('hex') - - return DDO_IDENTIFIER_PREFIX + hashAddressAndChain -} - /** * Checks if the given network is a confidential evm (oasis mainnet and testnet for now) * @param network name or chain id From 22b8d87da29c6c578042c1e03831d75c22434cd7 Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 20:12:03 +0200 Subject: [PATCH 07/11] retrieveDdoByNft returns the latest published DDO when both did:op and did:ope records exist for an NFT --- src/components/Indexer/utils.ts | 22 +++++++--- .../unit/indexer/retrieveDdoByNft.test.ts | 41 ++++++++++++++++++- 2 files changed, 56 insertions(+), 7 deletions(-) diff --git a/src/components/Indexer/utils.ts b/src/components/Indexer/utils.ts index 4dd6d390b..c49f41e4a 100644 --- a/src/components/Indexer/utils.ts +++ b/src/components/Indexer/utils.ts @@ -475,7 +475,9 @@ export async function getPricingStatsForDddo( /** * Finds the DDO of an NFT. Contract events only give the NFT address and chain id, * so the DDO is looked up under both DIDs it may be indexed as: v4 (`did:op:`) - * first, then v5 (`did:ope:`). + * and v5 (`did:ope:`). Republishing an NFT with the other DDO version indexes it + * under the other DID and leaves the old record in place, so when both exist the + * one published at the later block is returned (v5 on a tie or missing block). * @returns The DDO and the DID it was found under. When neither is indexed, `ddo` * is null and `did` is the v4 DID. */ @@ -485,11 +487,21 @@ export async function retrieveDdoByNft( chainId: number ): Promise<{ did: string; ddo: Record | null }> { const candidates = deriveDidCandidates(nftAddress, chainId) - for (const did of candidates) { - const ddo = await ddoDatabase.retrieve(did) - if (ddo) return { did, ddo } + const found = ( + await Promise.all( + candidates.map(async (did) => ({ did, ddo: await ddoDatabase.retrieve(did) })) + ) + ).filter((candidate) => candidate.ddo) + if (found.length === 0) return { did: candidates[0], ddo: null } + + const publishedAt = (ddo: Record): number => { + const block = Number(ddo.indexedMetadata?.event?.block) + return Number.isFinite(block) ? block : -1 } - return { did: candidates[0], ddo: null } + // candidates are ordered v4 then v5, so >= lets the v5 record win a tie + return found.reduce((latest, candidate) => + publishedAt(candidate.ddo) >= publishedAt(latest.ddo) ? candidate : latest + ) } export async function withRetrial( diff --git a/src/test/unit/indexer/retrieveDdoByNft.test.ts b/src/test/unit/indexer/retrieveDdoByNft.test.ts index 6b6dd5737..fc17e15ca 100644 --- a/src/test/unit/indexer/retrieveDdoByNft.test.ts +++ b/src/test/unit/indexer/retrieveDdoByNft.test.ts @@ -23,12 +23,12 @@ function fakeDdoDatabase(stored: Record) { } describe('retrieveDdoByNft', () => { - it('finds a v4 DDO with a single lookup', async () => { + it('finds a v4 DDO', async () => { const db = fakeDdoDatabase({ [DID_V4]: { id: DID_V4 } }) const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) expect(did).to.equal(DID_V4) expect(ddo).to.deep.equal({ id: DID_V4 }) - expect(db.lookups).to.deep.equal([DID_V4]) + expect(db.lookups).to.deep.equal([DID_V4, DID_V5]) }) it('finds a v5 DDO indexed under did:ope:', async () => { @@ -39,6 +39,43 @@ describe('retrieveDdoByNft', () => { expect(db.lookups).to.deep.equal([DID_V4, DID_V5]) }) + // Republishing an NFT with the other DDO version indexes it under the other DID and + // leaves the old record, so both can exist. Events must go to the current one. + const published = (id: string, block?: number) => ({ + id, + indexedMetadata: block === undefined ? {} : { event: { block } } + }) + + it('returns the later published DDO when both DIDs are indexed', async () => { + const v4ThenV5 = fakeDdoDatabase({ + [DID_V4]: published(DID_V4, 100), + [DID_V5]: published(DID_V5, 200) + }) + expect((await retrieveDdoByNft(v4ThenV5, NFT_ADDRESS, CHAIN_ID)).did).to.equal(DID_V5) + const v5ThenV4 = fakeDdoDatabase({ + [DID_V4]: published(DID_V4, 300), + [DID_V5]: published(DID_V5, 200) + }) + const { did, ddo } = await retrieveDdoByNft(v5ThenV4, NFT_ADDRESS, CHAIN_ID) + expect(did).to.equal(DID_V4) + expect(ddo.id).to.equal(DID_V4) + }) + + it('prefers the v5 DDO when both DIDs are indexed without a later block', async () => { + const sameBlock = fakeDdoDatabase({ + [DID_V4]: published(DID_V4, 100), + [DID_V5]: published(DID_V5, 100) + }) + expect((await retrieveDdoByNft(sameBlock, NFT_ADDRESS, CHAIN_ID)).did).to.equal( + DID_V5 + ) + const noBlocks = fakeDdoDatabase({ + [DID_V4]: published(DID_V4), + [DID_V5]: published(DID_V5) + }) + expect((await retrieveDdoByNft(noBlocks, NFT_ADDRESS, CHAIN_ID)).did).to.equal(DID_V5) + }) + it('returns a null DDO and the v4 DID when neither is indexed', async () => { const db = fakeDdoDatabase({}) const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) From 81bb852a505582d27b46a7b5b357e313048998ed Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 21:17:13 +0200 Subject: [PATCH 08/11] download: resolve the service before credential checks so the policy server gets the downloaded service id, not the raw index; short DDOs keep indexedMetadata.event so a revoked v5 record still wins over a stale v4 in retrieveDdoByNft --- .../processors/MetadataEventProcessor.ts | 15 +- .../processors/MetadataStateEventProcessor.ts | 16 +-- src/components/Indexer/utils.ts | 20 +++ .../core/handler/downloadHandler.ts | 20 +-- src/test/unit/downloadPolicyServer.test.ts | 132 ++++++++++++++++++ .../unit/indexer/retrieveDdoByNft.test.ts | 35 ++++- 6 files changed, 205 insertions(+), 33 deletions(-) create mode 100644 src/test/unit/downloadPolicyServer.test.ts diff --git a/src/components/Indexer/processors/MetadataEventProcessor.ts b/src/components/Indexer/processors/MetadataEventProcessor.ts index 2f990a65e..30c9f2faf 100644 --- a/src/components/Indexer/processors/MetadataEventProcessor.ts +++ b/src/components/Indexer/processors/MetadataEventProcessor.ts @@ -16,6 +16,7 @@ import { PolicyServer } from '../../policyServer/index.js' import { wasNFTDeployedByOurFactory, getPricingStatsForDddo, + buildShortDdoRecord, retrieveDdoByNft } from '../utils.js' import { BaseEventProcessor } from './BaseProcessor.js' @@ -94,17 +95,9 @@ export class MetadataEventProcessor extends BaseEventProcessor { } to ${metadataState}` ) - const shortDdoInstance = DDOManager.getDDOClass({ - id: ddo.id, - version: 'deprecated', - chainId, - nftAddress: ddo.nftAddress, - indexedMetadata: { - nft: { - state: metadataState - } - } - }) + const shortDdoInstance = DDOManager.getDDOClass( + buildShortDdoRecord(ddo, chainId, metadataState) + ) const savedDDO = await this.createOrUpdateDDO( shortDdoInstance, diff --git a/src/components/Indexer/processors/MetadataStateEventProcessor.ts b/src/components/Indexer/processors/MetadataStateEventProcessor.ts index b9084dd77..c05378404 100644 --- a/src/components/Indexer/processors/MetadataStateEventProcessor.ts +++ b/src/components/Indexer/processors/MetadataStateEventProcessor.ts @@ -4,7 +4,7 @@ import { EVENTS, MetadataStates } from '../../../utils/constants.js' import { INDEXER_LOGGER } from '../../../utils/logging/common.js' import { BaseEventProcessor } from './BaseProcessor.js' import ERC721Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC721Template.sol/ERC721Template.json' with { type: 'json' } -import { retrieveDdoByNft } from '../utils.js' +import { buildShortDdoRecord, retrieveDdoByNft } from '../utils.js' export class MetadataStateEventProcessor extends BaseEventProcessor { async processEvent( @@ -55,17 +55,9 @@ export class MetadataStateEventProcessor extends BaseEventProcessor { // We should keep it here, because in further development we'll store // the previous structure of the non-visible DDOs (full version) // in case their state changes back to active. - const shortDdoInstance = DDOManager.getDDOClass({ - id: ddo.id, - version: 'deprecated', - chainId, - nftAddress: ddo.nftAddress, - indexedMetadata: { - nft: { - state: metadataState - } - } - }) + const shortDdoInstance = DDOManager.getDDOClass( + buildShortDdoRecord(ddo, chainId, metadataState) + ) const savedDDO = await this.createOrUpdateDDO( shortDdoInstance, diff --git a/src/components/Indexer/utils.ts b/src/components/Indexer/utils.ts index c49f41e4a..1fbdd125c 100644 --- a/src/components/Indexer/utils.ts +++ b/src/components/Indexer/utils.ts @@ -504,6 +504,26 @@ export async function retrieveDdoByNft( ) } +/** + * Builds the short DDO stored when an asset's metadata state leaves Active (revoked, + * deprecated, ...) + */ +export function buildShortDdoRecord( + ddo: Record, + chainId: number, + state: number +): Record { + const indexedMetadata: Record = { nft: { state } } + if (ddo.indexedMetadata?.event) indexedMetadata.event = ddo.indexedMetadata.event + return { + id: ddo.id, + version: 'deprecated', + chainId, + nftAddress: ddo.nftAddress, + indexedMetadata + } +} + export async function withRetrial( fn: () => Promise, maxRetries: number = 5, diff --git a/src/components/core/handler/downloadHandler.ts b/src/components/core/handler/downloadHandler.ts index ead609331..799bfe49a 100644 --- a/src/components/core/handler/downloadHandler.ts +++ b/src/components/core/handler/downloadHandler.ts @@ -300,6 +300,16 @@ export class DownloadHandler extends CommandHandler { } } + // Resolve the service first: task.serviceId may be an index, and every access + // decision (including the policy server's) must name the service that is downloaded. + let service = ddoInstance.getService(task.serviceId) as Service + if (!service) { + service = ddoInstance.getServiceByIndex(Number(task.serviceId)) as Service + } + if (!service) throw new Error('Cannot find service') + // The service may have been found by index, so look its index up by the resolved id + const serviceIndex = ddoInstance.getServiceIndex(service.id) + // check credentials (DDO level) let accessGrantedDDOLevel: boolean if (credentials) { @@ -309,7 +319,7 @@ export class DownloadHandler extends CommandHandler { const response = await policyServer.checkDownload( ddoInstance.getDid(), ddo, - task.serviceId, + service.id, task.consumerAddress, task.policyServer ) @@ -333,14 +343,6 @@ export class DownloadHandler extends CommandHandler { } } - let service = ddoInstance.getService(task.serviceId) as Service - if (!service) { - service = ddoInstance.getServiceByIndex(Number(task.serviceId)) as Service - } - if (!service) throw new Error('Cannot find service') - // The service may have been found by index, so look its index up by the resolved id - const serviceIndex = ddoInstance.getServiceIndex(service.id) - // check credentials on service level // if using a policy server and we are here it means that access was granted (they are merged/assessed together) if (service.credentials) { diff --git a/src/test/unit/downloadPolicyServer.test.ts b/src/test/unit/downloadPolicyServer.test.ts new file mode 100644 index 000000000..754ab7cb4 --- /dev/null +++ b/src/test/unit/downloadPolicyServer.test.ts @@ -0,0 +1,132 @@ +import { expect } from 'chai' +import sinon from 'sinon' +import { deriveDid } from '@oceanprotocol/ddo-js' +import { DownloadHandler } from '../../components/core/handler/downloadHandler.js' +import { PolicyServer } from '../../components/policyServer/index.js' +import { ENVIRONMENT_VARIABLES, PROTOCOL_COMMANDS } from '../../utils/constants.js' +import { + OverrideEnvConfig, + buildEnvOverrideConfig, + setupEnvironment, + tearDownEnvironment +} from '../utils/utils.js' + +// The download handler accepts a service id or a service index. With a policy server +// configured, the access decision must name the service that is actually downloaded: +// before, the asset-level policy check sent the raw `serviceId` ('1'), and its approval +// then covered whichever service the index pointed to. + +const CHAIN_ID = 8996 +const NFT_ADDRESS = '0xBB1081DbF3227bbB233Db68f7117114baBb43656' +const CONSUMER = '0x0000000000000000000000000000000000000ABC' +const DID = deriveDid(NFT_ADDRESS, CHAIN_ID, '4') + +const service = (id: string) => ({ + id, + type: 'access', + files: '0x', + datatokenAddress: '0x0000000000000000000000000000000000000001', + serviceEndpoint: 'http://localhost:8001', + timeout: 0 +}) + +const DDO = { + '@context': ['https://w3id.org/did/v1'], + id: DID, + version: '4.1.0', + chainId: CHAIN_ID, + nftAddress: NFT_ADDRESS, + metadata: { created: '', updated: '', type: 'dataset', name: 'x', author: 'x' }, + services: [service('public'), service('restricted')], + credentials: { allow: [{ type: 'address', values: ['*'] }] }, + indexedMetadata: { nft: { state: 0 } } +} + +function buildNode(): any { + const blockchain = { + isNetworkReady: () => Promise.resolve({ ready: true }), + getProvider: () => Promise.resolve({}), + getSigner: () => Promise.resolve({}) + } + return { + getRequestMap: () => new Map(), + getConfig: () => ({ + rateLimit: undefined as number | undefined, + supportedNetworks: { [CHAIN_ID]: { chainId: CHAIN_ID } } + }), + getAuth: () => ({ + validateAuthenticationOrToken: () => + Promise.resolve({ valid: true, error: '', address: CONSUMER }) + }), + getCoreHandlers: () => ({ + getHandler: () => ({ + findAndFormatDdo: () => Promise.resolve(structuredClone(DDO)) + }) + }), + getBlockchain: () => blockchain + } +} + +const downloadTask = (serviceId: string): any => ({ + command: PROTOCOL_COMMANDS.DOWNLOAD, + fileIndex: 0, + documentId: DID, + serviceId, + transferTxId: '0x01', + consumerAddress: CONSUMER, + nonce: '1', + signature: '0xsignature' +}) + +describe('Download handler: policy server sees the downloaded service', () => { + let envOverrides: OverrideEnvConfig[] + let checkDownload: sinon.SinonStub + + before(async () => { + envOverrides = await setupEnvironment( + undefined, + buildEnvOverrideConfig( + [ENVIRONMENT_VARIABLES.POLICY_SERVER_URL], + ['http://localhost:9999'] + ) + ) + }) + + beforeEach(() => { + // Deny, so the handler stops right after the asset-level decision. + checkDownload = sinon + .stub(PolicyServer.prototype, 'checkDownload') + .resolves({ success: false, message: 'denied', httpStatus: 403 }) + }) + + afterEach(() => { + sinon.restore() + }) + + after(async () => { + await tearDownEnvironment(envOverrides) + }) + + it('sends the resolved service id when the service is selected by index', async () => { + const result = await new DownloadHandler(buildNode()).handle(downloadTask('1')) + expect(result.status.httpStatus).to.equal(403) + expect(checkDownload.calledOnce).to.equal(true) + expect(checkDownload.firstCall.args[2]).to.equal('restricted') + }) + + it('sends the service id when the service is selected by id', async () => { + await new DownloadHandler(buildNode()).handle(downloadTask('public')) + expect(checkDownload.firstCall.args[2]).to.equal('public') + }) + + it('rejects an unknown service before asking the policy server', async () => { + let error: Error + try { + await new DownloadHandler(buildNode()).handle(downloadTask('missing')) + } catch (e) { + error = e + } + expect(error?.message).to.equal('Cannot find service') + expect(checkDownload.called).to.equal(false) + }) +}) diff --git a/src/test/unit/indexer/retrieveDdoByNft.test.ts b/src/test/unit/indexer/retrieveDdoByNft.test.ts index fc17e15ca..42612c831 100644 --- a/src/test/unit/indexer/retrieveDdoByNft.test.ts +++ b/src/test/unit/indexer/retrieveDdoByNft.test.ts @@ -1,6 +1,9 @@ import { expect } from 'chai' import { deriveDid } from '@oceanprotocol/ddo-js' -import { retrieveDdoByNft } from '../../../components/Indexer/utils.js' +import { + buildShortDdoRecord, + retrieveDdoByNft +} from '../../../components/Indexer/utils.js' // Contract events (orders, prices, dispensers, metadata state) only give the NFT address and // chain id. Before, the processors derived the v4 DID (did:op:) only, so events for a v5 asset @@ -76,6 +79,36 @@ describe('retrieveDdoByNft', () => { expect((await retrieveDdoByNft(noBlocks, NFT_ADDRESS, CHAIN_ID)).did).to.equal(DID_V5) }) + it('keeps the current publication selected after it is revoked', async () => { + const stored: Record = { + [DID_V4]: published(DID_V4, 100), + [DID_V5]: published(DID_V5, 200) + } + const db = fakeDdoDatabase(stored) + const before = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) + expect(before.did).to.equal(DID_V5) + + // MetadataState / MetadataEvent processors replace the revoked DDO with a short one + stored[before.did] = buildShortDdoRecord(before.ddo, CHAIN_ID, 8) + expect(stored[DID_V5].indexedMetadata.event.block).to.equal(200) + + const after = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) + expect(after.did).to.equal(DID_V5) + expect(after.ddo.version).to.equal('deprecated') + expect(after.ddo.indexedMetadata.nft.state).to.equal(8) + }) + + it('builds a short DDO without event when the full DDO has none', () => { + const shortDdo = buildShortDdoRecord(published(DID_V4), CHAIN_ID, 2) + expect(shortDdo).to.deep.equal({ + id: DID_V4, + version: 'deprecated', + chainId: CHAIN_ID, + nftAddress: undefined, + indexedMetadata: { nft: { state: 2 } } + }) + }) + it('returns a null DDO and the v4 DID when neither is indexed', async () => { const db = fakeDdoDatabase({}) const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) From fe98728a0c2db093ddd25bb1db3c02ab266fe4ae Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Tue, 17 Nov 2026 22:22:26 +0200 Subject: [PATCH 09/11] fix code review --- src/components/Indexer/utils.ts | 6 ++- .../unit/indexer/retrieveDdoByNft.test.ts | 39 ++++++++++++++++--- 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/src/components/Indexer/utils.ts b/src/components/Indexer/utils.ts index 1fbdd125c..2f3651dbc 100644 --- a/src/components/Indexer/utils.ts +++ b/src/components/Indexer/utils.ts @@ -12,7 +12,7 @@ import { create256Hash } from '../../utils/crypt.js' import Dispenser from '@oceanprotocol/contracts/artifacts/contracts/pools/dispenser/Dispenser.sol/Dispenser.json' with { type: 'json' } import FixedRateExchange from '@oceanprotocol/contracts/artifacts/contracts/pools/fixedRate/FixedRateExchange.sol/FixedRateExchange.json' with { type: 'json' } import { ServicePrice } from '../../@types/IndexedMetadata.js' -import { VersionedDDO, deriveDidCandidates } from '@oceanprotocol/ddo-js' +import { DDOManager, VersionedDDO, deriveDidCandidates } from '@oceanprotocol/ddo-js' import FactoryRouter from '@oceanprotocol/contracts/artifacts/contracts/pools/FactoryRouter.sol/FactoryRouter.json' with { type: 'json' } /** @@ -515,11 +515,13 @@ export function buildShortDdoRecord( ): Record { const indexedMetadata: Record = { nft: { state } } if (ddo.indexedMetadata?.event) indexedMetadata.event = ddo.indexedMetadata.event + // v5 keeps nftAddress under credentialSubject; the versioned accessor reads both + const { nftAddress } = DDOManager.getDDOClass(ddo).getDDOFields() return { id: ddo.id, version: 'deprecated', chainId, - nftAddress: ddo.nftAddress, + nftAddress, indexedMetadata } } diff --git a/src/test/unit/indexer/retrieveDdoByNft.test.ts b/src/test/unit/indexer/retrieveDdoByNft.test.ts index 42612c831..22bf8b1e9 100644 --- a/src/test/unit/indexer/retrieveDdoByNft.test.ts +++ b/src/test/unit/indexer/retrieveDdoByNft.test.ts @@ -44,10 +44,24 @@ describe('retrieveDdoByNft', () => { // Republishing an NFT with the other DDO version indexes it under the other DID and // leaves the old record, so both can exist. Events must go to the current one. - const published = (id: string, block?: number) => ({ - id, - indexedMetadata: block === undefined ? {} : { event: { block } } - }) + // v4 keeps nftAddress at the top level, v5 under credentialSubject + const published = (id: string, block?: number): Record => { + const indexedMetadata = block === undefined ? {} : { event: { block } } + return id === DID_V5 + ? { + id, + version: '5.0.0', + credentialSubject: { id, nftAddress: NFT_ADDRESS, chainId: CHAIN_ID }, + indexedMetadata + } + : { + id, + version: '4.1.0', + nftAddress: NFT_ADDRESS, + chainId: CHAIN_ID, + indexedMetadata + } + } it('returns the later published DDO when both DIDs are indexed', async () => { const v4ThenV5 = fakeDdoDatabase({ @@ -104,11 +118,26 @@ describe('retrieveDdoByNft', () => { id: DID_V4, version: 'deprecated', chainId: CHAIN_ID, - nftAddress: undefined, + nftAddress: NFT_ADDRESS, indexedMetadata: { nft: { state: 2 } } }) }) + // createOrUpdateDDO recreates the DDO and its state from the short record, so a missing + // address would drop the NFT identity of a revoked v5 asset + it('keeps the nested v5 NFT address in the short DDO', () => { + const v5 = published(DID_V5, 200) + expect(v5.nftAddress).to.equal(undefined) + const shortDdo = buildShortDdoRecord(v5, CHAIN_ID, 8) + expect(shortDdo).to.deep.equal({ + id: DID_V5, + version: 'deprecated', + chainId: CHAIN_ID, + nftAddress: NFT_ADDRESS, + indexedMetadata: { nft: { state: 8 }, event: { block: 200 } } + }) + }) + it('returns a null DDO and the v4 DID when neither is indexed', async () => { const db = fakeDdoDatabase({}) const { did, ddo } = await retrieveDdoByNft(db, NFT_ADDRESS, CHAIN_ID) From 7b418e8cb3f9721c1817f3a8d378610b7fb67533 Mon Sep 17 00:00:00 2001 From: Denis <61563365+dnsi0@users.noreply.github.com> Date: Wed, 18 Nov 2026 16:50:07 +0200 Subject: [PATCH 10/11] fix review comments --- package-lock.json | 28 +--- package.json | 2 +- .../processors/MetadataEventProcessor.ts | 6 +- .../processors/MetadataStateEventProcessor.ts | 15 +- .../unit/indexer/shortDdoTransitions.test.ts | 139 ++++++++++++++++++ 5 files changed, 154 insertions(+), 36 deletions(-) create mode 100644 src/test/unit/indexer/shortDdoTransitions.test.ts diff --git a/package-lock.json b/package-lock.json index 6212d275e..6a65b3f51 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34,7 +34,7 @@ "@libp2p/websockets": "^10.1.21", "@multiformats/multiaddr": "^13.0.3", "@oceanprotocol/contracts": "^3.2.0", - "@oceanprotocol/ddo-js": "^1.1.0-next.0", + "@oceanprotocol/ddo-js": "^1.1.0-next.1", "@opentelemetry/api": "^1.9.1", "@opentelemetry/exporter-metrics-otlp-http": "^0.221.0", "@opentelemetry/exporter-trace-otlp-http": "^0.221.0", @@ -193,7 +193,6 @@ "resolved": "https://registry.npmjs.org/@aws-sdk/client-s3/-/client-s3-3.1161.0.tgz", "integrity": "sha512-iRZGMsJnYRrI98O+U6o5fHeLPQTP+Dc/w0mWLcBLQcEQ10DA06+XQj0WmdRiCM7vIso7QEtN1fsj9Vzo5/R3LQ==", "license": "Apache-2.0", - "peer": true, "dependencies": { "@aws-sdk/checksums": "^3.1002.1", "@aws-sdk/core": "^3.979.1", @@ -532,7 +531,6 @@ "integrity": "sha512-RgHBCvtjbOK2gXSNBNIkNoEc9qoVEtau3hj8gEqKQuL3HZAibKarWFEI3Lfm6EYKkLalOh8eSrj9b+ch9H/VBA==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@babel/code-frame": "^7.29.7", "@babel/generator": "^7.29.7", @@ -3154,10 +3152,9 @@ "license": "Apache-2.0" }, "node_modules/@oceanprotocol/ddo-js": { - "version": "1.1.0-next.0", - "resolved": "https://registry.npmjs.org/@oceanprotocol/ddo-js/-/ddo-js-1.1.0-next.0.tgz", - "integrity": "sha512-hfyOmD6CaucXv4srVP/KZtfrGXqutXGlvrUfQyjaFsDcLFq64XG5kbqO878NbpybM2wxuDK0kwxyQKd/XnVtPQ==", - "license": "Apache-2.0", + "version": "1.1.0-next.1", + "resolved": "https://registry.npmjs.org/@oceanprotocol/ddo-js/-/ddo-js-1.1.0-next.1.tgz", + "integrity": "sha512-j5ItdVv25w4Q/RwG2+RYnyXwZXrqzm9U2SO0Ymd5ssbPfBX9dugM7KygDVTE5jTZ535VRMgradKcyfAFK0qySA==", "dependencies": { "ethers": "^6.17.0", "jsonld": "^9.0.0", @@ -3182,7 +3179,6 @@ "integrity": "sha512-DcB0M3KFgr9ECI328lhBMVsyFT2DnmNucSBTqEN3exyNKUzkkpUSCHmTRcunF41Eou2TIQKW4seewri8ON9bSA==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@octokit/auth-token": "^6.0.0", "@octokit/graphql": "^9.0.4", @@ -3373,7 +3369,6 @@ "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.1.tgz", "integrity": "sha512-gLyJlPHPZYdAk1JENA9LeHejZe1Ti77/pTeFm/nMXmQH/HFZlcS/O2XJB+L8fkbrNSqhdtlvjBVjxwUYanNH5Q==", "license": "Apache-2.0", - "peer": true, "engines": { "node": ">=8.0.0" } @@ -4528,7 +4523,6 @@ "resolved": "https://registry.npmjs.org/@rdfjs/types/-/types-2.0.1.tgz", "integrity": "sha512-uyAzpugX7KekAXAHq26m3JlUIZJOC0uSBhpnefGV5i15bevDyyejoB7I+9MKeUrzXD8OOUI3+4FeV1wwQr5ihA==", "license": "MIT", - "peer": true, "dependencies": { "@types/node": "*" } @@ -5135,7 +5129,6 @@ "integrity": "sha512-CG4nPk1f2zc8yw4pALqHsFYH2hdo+h1T9daSp21+Hnxi9LOE3GT9hAfTKJCBXVNM2GmYs1eMEP615wPoeOgk3A==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "8.71.0", "@typescript-eslint/types": "8.71.0", @@ -5477,7 +5470,6 @@ "integrity": "sha512-lGq+9yr1/GuAWaVYIHRjvvySG5/4VfKIvC8EWxStPdcDh/Ka7FG3twP6v4d5BkravUilhIAsG4Qj83t02LWUPQ==", "dev": true, "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -5777,7 +5769,6 @@ "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.9.1.tgz", "integrity": "sha512-Z0oHEHAFDZkffN8Qc39zNZjQlMDkPJRyyyZieU1VH7u8c5S+qHZ2S8ixdKIAxEjfHO7FJxXmJWgteOghVanIsg==", "license": "Apache-2.0", - "peer": true, "peerDependencies": { "bare-abort-controller": "*" }, @@ -6025,7 +6016,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.11.12", "caniuse-lite": "^1.0.30001809", @@ -7030,7 +7020,6 @@ "resolved": "https://registry.npmjs.org/@noble/ciphers/-/ciphers-1.3.0.tgz", "integrity": "sha512-2I0gnIVPtfnMw9ee9h1dJG7tp81+8Ob3OJb3Mv37rx5L40/b0i7djjCVvGOVqc9AEIQyvyu1i6ypKdFw8R8gQw==", "license": "MIT", - "peer": true, "engines": { "node": "^14.21.3 || >=16" }, @@ -7222,7 +7211,6 @@ "integrity": "sha512-T0pNsxkb9IKmtQjhpK3d7nWOpFv+YHuMbTJnSVMoQblF0onvXfErrtp4V1jHtsQPan7dKaGVD0q1WCXnzMF31A==", "dev": true, "license": "MIT", - "peer": true, "workspaces": [ "packages/*" ], @@ -7282,7 +7270,6 @@ "integrity": "sha512-82GZUjRS0p/jganf6q1rEO25VSoHH0hKPCTrgillPjdI/3bgBhAE1QzHrHTizjpRvy6pGAvKjDJtk2pF9NDq8w==", "dev": true, "license": "MIT", - "peer": true, "bin": { "eslint-config-prettier": "bin/cli.js" }, @@ -9489,7 +9476,6 @@ "integrity": "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "@keyv/serialize": "^1.1.1" } @@ -11114,7 +11100,6 @@ "integrity": "sha512-RvwwcruNjI1ncT5xRakeyS9Lf8lcItv34KD+aif+VH9kduAyfYBipGh12274xtenIPZ119/R9BdTBa8gAwSh0A==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": ">=12" }, @@ -11232,7 +11217,6 @@ "integrity": "sha512-skGHTH1Yb9QvaTC4hWnRTzEYtCpApF0UMBPz+t/0ZPzP8ihefo/btKd+QA7pUE0fEwA1SbS/NmhyEcstdXOIdA==", "dev": true, "license": "MIT", - "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -11537,8 +11521,7 @@ "resolved": "https://registry.npmjs.org/quickjs-wasi/-/quickjs-wasi-2.2.0.tgz", "integrity": "sha512-zQxXmQMrEoD3S+jQdYsloq4qAuaxKFHZj6hHqOYGwB2iQZH+q9e/lf5zQPXCKOk0WJuAjzRFbO4KwHIp2D05Iw==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/race-event": { "version": "1.6.1", @@ -12945,7 +12928,6 @@ "integrity": "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw==", "dev": true, "license": "Apache-2.0", - "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" diff --git a/package.json b/package.json index 53e4d6fdd..8e11af1b7 100644 --- a/package.json +++ b/package.json @@ -76,7 +76,7 @@ "@libp2p/websockets": "^10.1.21", "@multiformats/multiaddr": "^13.0.3", "@oceanprotocol/contracts": "^3.2.0", - "@oceanprotocol/ddo-js": "^1.1.0-next.0", + "@oceanprotocol/ddo-js": "^1.1.0-next.1", "@opentelemetry/api": "^1.9.1", "@opentelemetry/exporter-metrics-otlp-http": "^0.221.0", "@opentelemetry/exporter-trace-otlp-http": "^0.221.0", diff --git a/src/components/Indexer/processors/MetadataEventProcessor.ts b/src/components/Indexer/processors/MetadataEventProcessor.ts index 30c9f2faf..1571f0d7e 100644 --- a/src/components/Indexer/processors/MetadataEventProcessor.ts +++ b/src/components/Indexer/processors/MetadataEventProcessor.ts @@ -87,11 +87,11 @@ export class MetadataEventProcessor extends BaseEventProcessor { return } - const ddoInstance = DDOManager.getDDOClass(ddo) - + // Read the stored record, not getAssetFields(): on a short DDO that call nulls + // indexedMetadata.event in place, which buildShortDdoRecord then cannot carry over INDEXER_LOGGER.debug( `DDO ${did} became non-visible from ${ - ddoInstance.getAssetFields().indexedMetadata.nft.state + ddo.indexedMetadata?.nft?.state } to ${metadataState}` ) diff --git a/src/components/Indexer/processors/MetadataStateEventProcessor.ts b/src/components/Indexer/processors/MetadataStateEventProcessor.ts index c05378404..abc5c8463 100644 --- a/src/components/Indexer/processors/MetadataStateEventProcessor.ts +++ b/src/components/Indexer/processors/MetadataStateEventProcessor.ts @@ -37,19 +37,16 @@ export class MetadataStateEventProcessor extends BaseEventProcessor { const ddoInstance = DDOManager.getDDOClass(ddo) INDEXER_LOGGER.debug(`Found did ${did} on network ${chainId}`) - if ( - 'nft' in ddoInstance.getAssetFields().indexedMetadata && - ddoInstance.getAssetFields().indexedMetadata.nft.state !== metadataState - ) { + // Read the stored record, not getAssetFields(): on a short DDO that call nulls + // indexedMetadata.event in place, and the record is saved again below + const currentState = ddo.indexedMetadata?.nft?.state + if (ddo.indexedMetadata?.nft && currentState !== metadataState) { if ( - ddoInstance.getAssetFields().indexedMetadata.nft.state === - MetadataStates.ACTIVE && + currentState === MetadataStates.ACTIVE && [MetadataStates.REVOKED, MetadataStates.DEPRECATED].includes(metadataState) ) { INDEXER_LOGGER.debug( - `DDO became non-visible from ${ - ddoInstance.getAssetFields().indexedMetadata.nft.state - } to ${metadataState}` + `DDO became non-visible from ${currentState} to ${metadataState}` ) // We should keep it here, because in further development we'll store diff --git a/src/test/unit/indexer/shortDdoTransitions.test.ts b/src/test/unit/indexer/shortDdoTransitions.test.ts new file mode 100644 index 000000000..ca5519095 --- /dev/null +++ b/src/test/unit/indexer/shortDdoTransitions.test.ts @@ -0,0 +1,139 @@ +import { expect } from 'chai' +import sinon from 'sinon' +import { AbiCoder, Interface, Signer, ethers, id } from 'ethers' +import { deriveDid } from '@oceanprotocol/ddo-js' +import ERC721Template from '@oceanprotocol/contracts/artifacts/contracts/templates/ERC721Template.sol/ERC721Template.json' with { type: 'json' } +import { EVENT_PROCESSOR_MAP } from '../../../components/Indexer/processor.js' +import { retrieveDdoByNft } from '../../../components/Indexer/utils.js' +import { EVENTS, MetadataStates } from '../../../utils/constants.js' +import { OceanNodeConfig } from '../../../@types/OceanNode.js' + +// A revoked asset is stored as a short DDO that keeps indexedMetadata.event, so +// retrieveDdoByNft still picks it over an older publication under the other DID. +// DeprecatedDDO.getAssetFields() nulls that event in place, so a second state change +// (e.g. Revoked -> Deprecated) must not call it before the record is saved again. + +const CHAIN_ID = 137 // has an ERC721Factory in the contracts address file +const NFT_ADDRESS = '0xBB1081DbF3227bbB233Db68f7117114baBb43656' +const OWNER = '0x0000000000000000000000000000000000000ABC' +const DID_V4 = deriveDid(NFT_ADDRESS, CHAIN_ID, '4') +const DID_V5 = deriveDid(NFT_ADDRESS, CHAIN_ID, '5') + +const published = (did: string, block: number): Record => { + const indexedMetadata = { nft: { state: MetadataStates.ACTIVE }, event: { block } } + return did === DID_V5 + ? { + id: did, + version: '5.0.0', + credentialSubject: { id: did, nftAddress: NFT_ADDRESS, chainId: CHAIN_ID }, + indexedMetadata + } + : { + id: did, + version: '4.1.0', + nftAddress: NFT_ADDRESS, + chainId: CHAIN_ID, + indexedMetadata + } +} + +// v4 published first, then republished as v5 +const initialRecords = (): Record => ({ + [DID_V4]: published(DID_V4, 100), + [DID_V5]: published(DID_V5, 200) +}) + +function stubStorage(processor: any, stored: Record) { + const ddoDatabase = { + retrieve: (did: string) => Promise.resolve(structuredClone(stored[did] ?? null)) + } + sinon.stub(processor, 'getDatabase').resolves({ ddo: ddoDatabase, ddoState: {} }) + // createOrUpdateDDO replaces the stored record with the instance's data + sinon.stub(processor, 'createOrUpdateDDO').callsFake((ddo: any) => { + const data = structuredClone(ddo.getDDOData()) + stored[data.id] = data + return Promise.resolve(data) + }) + return ddoDatabase +} + +async function expectCurrentShortDdo( + ddoDatabase: { retrieve(did: string): Promise | null> }, + state: number +) { + const { did, ddo } = await retrieveDdoByNft(ddoDatabase, NFT_ADDRESS, CHAIN_ID) + expect(did).to.equal(DID_V5) + expect(ddo.version).to.equal('deprecated') + expect(ddo.indexedMetadata.nft.state).to.equal(state) + expect(ddo.indexedMetadata.event).to.deep.equal({ block: 200 }) +} + +const log = { address: NFT_ADDRESS, transactionHash: '0x01' } as unknown as ethers.Log + +describe('Short DDO keeps its event across state changes', () => { + afterEach(() => { + sinon.restore() + }) + + it('MetadataState: Active -> Revoked -> Deprecated', async () => { + const stored = initialRecords() + const processor = new EVENT_PROCESSOR_MAP[EVENTS.METADATA_STATE]( + CHAIN_ID, + {} as OceanNodeConfig + ) + const ddoDatabase = stubStorage(processor, stored) + const getEventData = sinon.stub(processor as any, 'getEventData') + const changeState = (state: number) => { + getEventData.resolves({ args: [OWNER, BigInt(state)] }) + return processor.processEvent(log, CHAIN_ID, null, null) + } + + await changeState(MetadataStates.REVOKED) + await expectCurrentShortDdo(ddoDatabase, MetadataStates.REVOKED) + + await changeState(MetadataStates.DEPRECATED) + await expectCurrentShortDdo(ddoDatabase, MetadataStates.DEPRECATED) + }) + + it('MetadataUpdated on a revoked asset that becomes deprecated', async () => { + const stored = initialRecords() + const processor = new EVENT_PROCESSOR_MAP[EVENTS.METADATA_UPDATED]( + CHAIN_ID, + {} as OceanNodeConfig + ) + const ddoDatabase = stubStorage(processor, stored) + sinon.stub(processor as any, 'getEventData').resolves({ + args: [OWNER, 0, 'http://decryptor', '0x02', '0x', ethers.ZeroHash] + }) + + // Answers the factory check and the NFT's on-chain metadata state + const erc721 = new Interface(ERC721Template.abi) + const coder = AbiCoder.defaultAbiCoder() + let onChainState: number = MetadataStates.ACTIVE + const signer = { + provider: null, + call: (tx: { data: string }) => { + const selector = tx.data.slice(0, 10) + if (selector === id('erc721List(address)').slice(0, 10)) { + return Promise.resolve(coder.encode(['address'], [NFT_ADDRESS])) + } + if (selector === erc721.getFunction('getMetaData').selector) { + return Promise.resolve( + erc721.encodeFunctionResult('getMetaData', ['', '', onChainState, true]) + ) + } + return Promise.reject(new Error(`unexpected call ${selector}`)) + } + } as unknown as Signer + const metadataUpdated = (state: number) => { + onChainState = state + return processor.processEvent(log, CHAIN_ID, signer, null, EVENTS.METADATA_UPDATED) + } + + await metadataUpdated(MetadataStates.REVOKED) + await expectCurrentShortDdo(ddoDatabase, MetadataStates.REVOKED) + + await metadataUpdated(MetadataStates.DEPRECATED) + await expectCurrentShortDdo(ddoDatabase, MetadataStates.DEPRECATED) + }) +}) From c175de11c4f68b3daf273bc5e92bc10c03d08d96 Mon Sep 17 00:00:00 2001 From: alexcos20 Date: Thu, 19 Nov 2026 17:47:52 +0200 Subject: [PATCH 11/11] use latest ddo.js --- package-lock.json | 12 ++++++++---- package.json | 2 +- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6a65b3f51..0dbf9ca70 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34,7 +34,7 @@ "@libp2p/websockets": "^10.1.21", "@multiformats/multiaddr": "^13.0.3", "@oceanprotocol/contracts": "^3.2.0", - "@oceanprotocol/ddo-js": "^1.1.0-next.1", + "@oceanprotocol/ddo-js": "^1.1.0", "@opentelemetry/api": "^1.9.1", "@opentelemetry/exporter-metrics-otlp-http": "^0.221.0", "@opentelemetry/exporter-trace-otlp-http": "^0.221.0", @@ -3152,15 +3152,19 @@ "license": "Apache-2.0" }, "node_modules/@oceanprotocol/ddo-js": { - "version": "1.1.0-next.1", - "resolved": "https://registry.npmjs.org/@oceanprotocol/ddo-js/-/ddo-js-1.1.0-next.1.tgz", - "integrity": "sha512-j5ItdVv25w4Q/RwG2+RYnyXwZXrqzm9U2SO0Ymd5ssbPfBX9dugM7KygDVTE5jTZ535VRMgradKcyfAFK0qySA==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@oceanprotocol/ddo-js/-/ddo-js-1.1.0.tgz", + "integrity": "sha512-9/CYpaD0qzA/smmK63nMDnnd3XYNGGreb8y7uUwiC6ODqEKyvhEdMnSj2Rya4oNpyiJQ9cJhOsNGSEmYDhynKw==", + "license": "Apache-2.0", "dependencies": { "ethers": "^6.17.0", "jsonld": "^9.0.0", "n3": "^2.13.12", "rdf-literal": "^2.0.0", "rdf-validate-shacl": "^0.6.5" + }, + "engines": { + "node": ">=22" } }, "node_modules/@octokit/auth-token": { diff --git a/package.json b/package.json index 8e11af1b7..6115d63e4 100644 --- a/package.json +++ b/package.json @@ -76,7 +76,7 @@ "@libp2p/websockets": "^10.1.21", "@multiformats/multiaddr": "^13.0.3", "@oceanprotocol/contracts": "^3.2.0", - "@oceanprotocol/ddo-js": "^1.1.0-next.1", + "@oceanprotocol/ddo-js": "^1.1.0", "@opentelemetry/api": "^1.9.1", "@opentelemetry/exporter-metrics-otlp-http": "^0.221.0", "@opentelemetry/exporter-trace-otlp-http": "^0.221.0",