From 97860f3ef5e365965f52e8e1fc8ca65e55aa4c2b Mon Sep 17 00:00:00 2001 From: MaryamArif7 Date: Wed, 18 Nov 2026 23:40:51 +0500 Subject: [PATCH 1/4] feat (fabric-x): Simplify the Fabric-X configuration schema Signed-off-by: MaryamArif7 --- README.md | 1 + docs/getting-started.md | 2 +- docs/reference/configuration.md | 28 ++++++++ docs/schema.json | 79 +++------------------- e2e-network/docker/test-09-fabric-x-bft.sh | 4 +- e2e/fabloCommands.test.ts | 13 ++-- samples/fablo-config-fabric-x-2orgs.json | 57 ++-------------- src/commands/init/index.ts | 50 +++----------- src/commands/validate/index.ts | 58 +++++++++++----- src/extend-config/applyFabricXDefaults.ts | 38 +++++++++++ src/extend-config/defaults.ts | 13 +++- src/extend-config/extendConfig.ts | 3 +- src/extend-config/extendFabricXConfig.ts | 21 +++--- src/types/FabloConfigJson.ts | 24 +++++-- 14 files changed, 190 insertions(+), 201 deletions(-) create mode 100644 src/extend-config/applyFabricXDefaults.ts diff --git a/README.md b/README.md index e4f60765..866e2530 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,7 @@ fablo init fabric-x [--set = ...] ``` Creates a minimal config for the experimental Fabric-X provider, with `global.provider` set to `fabric-x`. +Use `--set fabricX.orderer.partyCount=4` for the four party BFT orderer. You cannot combine `fabric-x` with `node`, `rest`, `dev`, `ccaas` or `gateway`. #### Custom overrides diff --git a/docs/getting-started.md b/docs/getting-started.md index 4ebef115..2b838474 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -56,7 +56,7 @@ The `fabric-x` option works differently, because you get a whole different start fablo init fabric-x ``` -Fablo writes a minimal config for the experimental Fabric-X provider, with `global.provider` set to `fabric-x`, a single organization (`Org1`) that has one BFT orderer and no peers, and a channel named `mychannel`. You cannot combine `fabric-x` with `node`, `dev`, `ccaas`, `gateway` or `rest`. +Fablo writes a minimal config for the experimental Fabric-X provider, with `global.provider` set to `fabric-x`, a single organization (`Org1`), a channel named `mychannel` that all organizations join, and a namespace named `mynamespace`. The config holds only what you need to change, and Fablo derives the rest. The orderer is a single party by default, and `--set fabricX.orderer.partyCount=4` selects the four party BFT profile. You cannot combine `fabric-x` with `node`, `dev`, `ccaas`, `gateway` or `rest`. You can also override generated fields with `--set`: diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index e7cd510f..3694f3fc 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -72,6 +72,34 @@ When `provider` is `fabric-x`, `fablo validate` reports an error for any of the - Explorer or Fablo REST is enabled, in `global.tools` or in any `orgs[].tools` - `chaincodes` is not empty, because the Fabric-X provider does not deploy chaincodes yet - `channels` does not hold exactly one channel +- `fabricX.orderer.partyCount` is not `1` or `4` + +#### Compact Fabric-X config + +A Fabric-X config can be much smaller than a classic one, because Fablo fills in what it can derive. These settings are optional when `provider` is `fabric-x`: + +- `global.fabricVersion` (default `3.1.0`), `global.tls` (default `true`), `global.peerDevMode` (default `false`) and `global.engine` (default `docker`) +- `orgs[].organization.mspName` (default `MSP`) and `orgs[].ca` +- `channels[].orgs`. When omitted, all top-level organizations join the channel. When given, an entry needs only `name`, and `peers` is not needed. +- `chaincodes` and `hooks` +- `namespaces[].orgs`. When omitted, all organizations on the channel govern the namespace. +- `fabricX.orderer.partyCount` (default `1`). Use `4` for the local BFT profile. Fablo derives the organizations of the orderer parties. + +```json +{ + "$schema": "https://github.com/hyperledger-labs/fablo/releases/download/2.6.0/schema.json", + "global": { "provider": "fabric-x" }, + "orgs": [ + { "organization": { "name": "Org1", "domain": "org1.example.com" } }, + { "organization": { "name": "Org2", "domain": "org2.example.com" } } + ], + "channels": [{ "name": "mychannel" }], + "namespaces": [{ "name": "mynamespace" }, { "name": "audit_ns", "orgs": ["Org1"] }], + "fabricX": { "orderer": { "partyCount": 4 } } +} +``` + +For the `fabric` provider, `global.fabricVersion`, `global.tls`, `chaincodes`, `channels[].orgs` and the `peers` of each channel organization are still required, and `fablo validate` reports them when they are missing. ### `global.fabricImages` diff --git a/docs/schema.json b/docs/schema.json index 4f42340b..feeb0903 100644 --- a/docs/schema.json +++ b/docs/schema.json @@ -7,8 +7,7 @@ "required": [ "global", "orgs", - "channels", - "chaincodes" + "channels" ], "properties": { "$schema": { @@ -19,10 +18,7 @@ "title": "Global network settings", "description": "Basic settings of the Hyperledger Fabric network", "type": "object", - "required": [ - "fabricVersion", - "tls" - ], + "required": [], "properties": { "fabricVersion": { "$id": "#/properties/global/properties/fabricVersion", @@ -415,8 +411,7 @@ "title": "Channel", "type": "object", "required": [ - "name", - "orgs" + "name" ], "properties": { "name": { @@ -440,8 +435,7 @@ "title": "Organization", "type": "object", "required": [ - "name", - "peers" + "name" ], "properties": { "name": { @@ -692,71 +686,18 @@ "type": "object", "title": "Fabric-X settings (EXPERIMENTAL)", "description": "Settings of the 'fabric-x' provider. Ignored for the 'fabric' provider.", - "required": [ - "orderer" - ], "properties": { "orderer": { "$id": "#/properties/fabricX/properties/orderer", "type": "object", "title": "Orderer", - "required": [ - "parties" - ], "properties": { - "parties": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties", - "type": "array", - "title": "Orderer parties", - "description": "A party is an organization of the orderer with its own router, batcher, consenter and assembler. Fablo currently supports 1 party (the quick default) or 4 parties (a local profile for BFT testing).", - "default": [ - { - "organization": { - "name": "Orderer", - "domain": "orderer.example.com", - "mspName": "OrdererOrdererMSP" - } - } - ], - "items": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items", - "title": "Orderer party", - "type": "object", - "required": [ - "organization" - ], - "properties": { - "organization": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization", - "title": "Organization of the party", - "type": "object", - "required": [ - "name", - "domain" - ], - "properties": { - "name": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization/properties/name", - "title": "Name", - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "mspName": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization/properties/mspName", - "title": "MSP Name", - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "domain": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization/properties/domain", - "title": "Domain", - "type": "string", - "pattern": "^[a-z0-9\\.\\-]+$" - } - } - } - } - } + "partyCount": { + "$id": "#/properties/fabricX/properties/orderer/properties/partyCount", + "type": "integer", + "title": "Number of orderer parties", + "description": "A party is an organization of the orderer with its own router, batcher, consenter and assembler. Fablo derives the organizations of the parties. Fablo currently supports 1 party (the quick default) or 4 parties (a local profile for BFT testing).", + "default": 1 } } } diff --git a/e2e-network/docker/test-09-fabric-x-bft.sh b/e2e-network/docker/test-09-fabric-x-bft.sh index d8172c4f..91b84c68 100755 --- a/e2e-network/docker/test-09-fabric-x-bft.sh +++ b/e2e-network/docker/test-09-fabric-x-bft.sh @@ -29,8 +29,8 @@ expectCommand() { networkUp() { run_fablo init fabric-x - # four orderer parties, each with its own organization - jq '.fabricX.orderer.parties = [range(1;5) | {organization: {name: "OrdererOrg\(.)", domain: "orderer-org-\(.)", mspName: "OrdererOrg\(.)MSP"}}]' \ + # four orderer parties + jq '.fabricX.orderer.partyCount = 4' \ "$TEST_TMP/fablo-config.json" >"$TEST_TMP/fablo-config.json.tmp" mv "$TEST_TMP/fablo-config.json.tmp" "$TEST_TMP/fablo-config.json" run_fablo validate diff --git a/e2e/fabloCommands.test.ts b/e2e/fabloCommands.test.ts index 05f013f1..5a67d921 100644 --- a/e2e/fabloCommands.test.ts +++ b/e2e/fabloCommands.test.ts @@ -305,7 +305,6 @@ describe("validate", () => { organization: { name: "Org2", domain: "org2.example.com", mspName: "Org2MSP" }, ca: { prefix: "ca", db: "sqlite" }, } as OrgJson); - config.channels[0].orgs.push({ name: "Org2", peers: [] }); }); it("should validate valid multi-org config with valid multi-org namespace policy", () => { @@ -319,7 +318,10 @@ describe("validate", () => { it("should reject channel organization not in top-level orgs", () => { const channelName = config.channels[0].name; - config.channels[0].orgs.push({ name: "MissingOrg", peers: [] }); + config.channels[0].orgs = [ + { name: "Org1", peers: [] }, + { name: "MissingOrg", peers: [] }, + ]; fs.writeFileSync(configPath, JSON.stringify(config, null, 2)); const missingOrgResult = commands.fabloExec("validate", true); @@ -341,7 +343,6 @@ describe("validate", () => { organization: { name: "org1", domain: "org1-dup.example.com", mspName: "Org1DupMSP" }, ca: { prefix: "ca", db: "sqlite" }, } as OrgJson); - config.channels[0].orgs.push({ name: "org1", peers: [] }); fs.writeFileSync(configPath, JSON.stringify(config, null, 2)); const duplicateSlugResult = commands.fabloExec("validate", true); @@ -356,6 +357,10 @@ describe("validate", () => { organization: { name: "Org1", domain: "org1-alt.example.com", mspName: "Org1AltMSP" }, ca: { prefix: "ca", db: "sqlite" }, } as OrgJson); + config.channels[0].orgs = [ + { name: "Org1", peers: [] }, + { name: "Org2", peers: [] }, + ]; fs.writeFileSync(configPath, JSON.stringify(config, null, 2)); const duplicateTopLevelResult = commands.fabloExec("validate", true); @@ -517,7 +522,7 @@ describe("generate", () => { it("should generate Fabric-X network files with custom organization", () => { // Given commands.fabloExec( - "init fabric-x --set orgs[0].organization.name=Bank --set orgs[0].organization.domain=bank.fablo.com --set orgs[0].organization.mspName=BankMSP --set channels[0].orgs[0].name=Bank --set namespaces[0].orgs[0]=Bank", + "init fabric-x --set orgs[0].organization.name=Bank --set orgs[0].organization.domain=bank.fablo.com --set orgs[0].organization.mspName=BankMSP", ); // When diff --git a/samples/fablo-config-fabric-x-2orgs.json b/samples/fablo-config-fabric-x-2orgs.json index a95fe368..d72b126b 100644 --- a/samples/fablo-config-fabric-x-2orgs.json +++ b/samples/fablo-config-fabric-x-2orgs.json @@ -1,79 +1,34 @@ { "$schema": "https://github.com/hyperledger-labs/fablo/releases/download/2.6.0/schema.json", "global": { - "fabricVersion": "3.1.0", - "tls": true, - "engine": "docker", - "peerDevMode": false, "provider": "fabric-x" }, "orgs": [ { "organization": { "name": "Org1", - "domain": "org1.example.com", - "mspName": "Org1MSP" - }, - "ca": { - "prefix": "ca", - "db": "sqlite" + "domain": "org1.example.com" } }, { "organization": { "name": "Org2", - "domain": "org2.example.com", - "mspName": "Org2MSP" - }, - "ca": { - "prefix": "ca", - "db": "sqlite" + "domain": "org2.example.com" } } ], "channels": [ { - "name": "mychannel", - "orgs": [ - { - "name": "Org1", - "peers": [] - }, - { - "name": "Org2", - "peers": [] - } - ] + "name": "mychannel" } ], "namespaces": [ { - "name": "mynamespace", - "orgs": [ - "Org1", - "Org2" - ] + "name": "mynamespace" }, { "name": "audit_ns", - "orgs": [ - "Org1" - ] + "orgs": ["Org1"] } - ], - "fabricX": { - "orderer": { - "parties": [ - { - "organization": { - "name": "Orderer", - "domain": "orderer.example.com", - "mspName": "OrdererOrdererMSP" - } - } - ] - } - }, - "chaincodes": [], - "hooks": {} + ] } diff --git a/src/commands/init/index.ts b/src/commands/init/index.ts index 35eb4494..577f1994 100644 --- a/src/commands/init/index.ts +++ b/src/commands/init/index.ts @@ -1,6 +1,6 @@ import { Args, Command, Flags } from "@oclif/core"; import * as chalk from "chalk"; -import { GlobalJson, FabloConfigJson, ChaincodeJson, OrgJson } from "../../types/FabloConfigJson"; +import { GlobalJson, FabloConfigJson, FabricXConfigJson, ChaincodeJson, OrgJson } from "../../types/FabloConfigJson"; import { Validator as SchemaValidator } from "jsonschema"; import * as _ from "lodash"; import * as path from "path"; @@ -70,14 +70,10 @@ function getFabricConfig(): FabloConfigJson { }; } -function getDefaultFabricXConfig(): FabloConfigJson { +function getDefaultFabricXConfig(): FabricXConfigJson { return { $schema: `https://github.com/hyperledger-labs/fablo/releases/download/${version}/schema.json`, global: { - fabricVersion: "3.1.0", - tls: true, - engine: "docker", - peerDevMode: false, provider: "fabric-x", }, orgs: [ @@ -85,46 +81,19 @@ function getDefaultFabricXConfig(): FabloConfigJson { organization: { name: "Org1", domain: "org1.example.com", - mspName: "Org1MSP", - }, - ca: { - prefix: "ca", - db: "sqlite", }, }, ], channels: [ { name: "mychannel", - orgs: [ - { - name: "Org1", - peers: [], - }, - ], }, ], namespaces: [ { name: "mynamespace", - orgs: ["Org1"], }, ], - fabricX: { - orderer: { - parties: [ - { - organization: { - name: "Orderer", - domain: "orderer.example.com", - mspName: "OrdererOrdererMSP", - }, - }, - ], - }, - }, - chaincodes: [], - hooks: {}, }; } @@ -234,7 +203,8 @@ export default class Init extends Command { } } - let fabloConfigJson = flags.fabricX ? getDefaultFabricXConfig() : getDefaultFabloConfig(); + // the compact Fabric-X config is completed with defaults when it is read, so it is kept as written + let fabloConfigJson = flags.fabricX ? (getDefaultFabricXConfig() as FabloConfigJson) : getDefaultFabloConfig(); if (flags.fabricX) { this.log("Creating minimal Fabric-X starter config"); @@ -316,11 +286,13 @@ export default class Init extends Command { fabloConfigJson = { ...fabloConfigJson, orgs }; } - const global: GlobalJson = { - ...fabloConfigJson.global, - engine: fabloConfigJson.global.engine ?? "docker", - }; - fabloConfigJson = { ...fabloConfigJson, global }; + if (!flags.fabricX) { + const global: GlobalJson = { + ...fabloConfigJson.global, + engine: fabloConfigJson.global.engine ?? "docker", + }; + fabloConfigJson = { ...fabloConfigJson, global }; + } if (parsed.flags.set) { for (const setValue of parsed.flags.set) { diff --git a/src/commands/validate/index.ts b/src/commands/validate/index.ts index 1da2d209..ca85a539 100644 --- a/src/commands/validate/index.ts +++ b/src/commands/validate/index.ts @@ -22,6 +22,7 @@ import { version } from "../../repositoryUtils"; import { SUPPORTED_ORDERER_PARTY_COUNTS } from "../../setup-docker/fabricXOrdererTopology"; import ListCompatibleUpdates from "../../list-compatible-updates"; import defaults from "../../extend-config/defaults"; +import applyFabricXDefaults from "../../extend-config/applyFabricXDefaults"; const findDuplicatedItems = (arr: string[]): Record => { const duplicates: Record = {}; const seenCounts = new Map(); @@ -124,9 +125,12 @@ export default class Validate extends Command { this._validateIfConfigFileExists(this.fabloConfigPath); const configContent = fs.readFileSync(this.fabloConfigPath, "utf-8"); - const networkConfig = parseFabloConfig(configContent); + const networkConfig = applyFabricXDefaults(parseFabloConfig(configContent)); const provider = networkConfig.global.provider ?? "fabric"; + if (provider === "fabric") { + this._validateClassicRequiredSettings(networkConfig); + } this._validateFabricVersion(networkConfig.global); this._validateJsonSchema(networkConfig); this._validateSupportedFabloVersion(networkConfig.$schema); @@ -174,6 +178,30 @@ export default class Validate extends Command { this._validateFabloRestAndDevMode(networkConfig.global, networkConfig.orgs); } + private _validateClassicRequiredSettings(networkConfig: FabloConfigJson) { + // the schema leaves these optional because fabric-x has defaults for them, but the fabric provider does not + const missing: string[] = []; + if (networkConfig.global.fabricVersion === undefined) missing.push("global.fabricVersion"); + if (networkConfig.global.tls === undefined) missing.push("global.tls"); + if (networkConfig.chaincodes === undefined) missing.push("chaincodes"); + networkConfig.channels.forEach((channel, channelIndex) => { + if (channel.orgs === undefined) { + missing.push(`channels[${channelIndex}].orgs`); + return; + } + channel.orgs.forEach((org, orgIndex) => { + if (org.peers === undefined) missing.push(`channels[${channelIndex}].orgs[${orgIndex}].peers`); + }); + }); + + if (missing.length > 0) { + this.emit(validationErrorType.CRITICAL, { + category: validationCategories.CRITICAL, + message: `Missing required setting(s) for the 'fabric' provider: ${missing.join(", ")}.`, + }); + } + } + private _validateFabricVersion(global: GlobalJson) { // we support Fabric starting from 2.0.0 if (!version(global.fabricVersion).isGreaterOrEqual("2.0.0")) { @@ -743,23 +771,17 @@ export default class Validate extends Command { this._validateNoClassicOrderersForFabricX(orgs); - const parties = fabricX?.orderer?.parties; - if (!parties) { - this.emit(validationErrorType.ERROR, { - category: validationCategories.ORDERER, - message: "fabric-x requires 'fabricX.orderer.parties' with the organizations of the orderer parties.", - }); - return; - } - - this._validateFabricXOrdererPartyCount(parties.length); + const partyCount = fabricX?.orderer?.partyCount ?? defaults.fabricX.orderer.partyCount; + this._validateFabricXOrdererPartyCount(partyCount); + if (!SUPPORTED_ORDERER_PARTY_COUNTS.includes(partyCount)) return; const organizations: FabricXOrganizationIdentity[] = [ - ...orgs.map(({ organization }, index) => - this._toFabricXOrganizationIdentity(organization, `orgs[${index}]`), - ), - ...parties.map(({ organization }, index) => - this._toFabricXOrganizationIdentity(organization, `fabricX.orderer.parties[${index}]`), + ...orgs.map(({ organization }, index) => this._toFabricXOrganizationIdentity(organization, `orgs[${index}]`)), + ...Array.from({ length: partyCount }, (_, index) => + this._toFabricXOrganizationIdentity( + defaults.fabricX.orderer.organization(index + 1, partyCount), + `the orderer party ${index + 1}`, + ), ), ]; @@ -786,7 +808,7 @@ export default class Validate extends Command { .forEach((org) => { this.emit(validationErrorType.ERROR, { category: validationCategories.ORDERER, - message: `Org '${org.organization.name}' defines 'orderers'. fabric-x does not use orderer groups, remove 'orderers' and configure the orderer in 'fabricX.orderer.parties'.`, + message: `Org '${org.organization.name}' defines 'orderers'. fabric-x does not use orderer groups, remove 'orderers', the orderer is configured with 'fabricX.orderer.partyCount'.`, }); }); } @@ -797,7 +819,7 @@ export default class Validate extends Command { const supportedCounts = SUPPORTED_ORDERER_PARTY_COUNTS.join(" or "); this.emit(validationErrorType.ERROR, { category: validationCategories.ORDERER, - message: `'fabricX.orderer.parties' has ${partyCount} parties. Fablo currently supports ${supportedCounts} fabric-x orderer parties.`, + message: `'fabricX.orderer.partyCount' is ${partyCount}. Fablo currently supports ${supportedCounts} fabric-x orderer parties.`, }); } diff --git a/src/extend-config/applyFabricXDefaults.ts b/src/extend-config/applyFabricXDefaults.ts new file mode 100644 index 00000000..49f67c8b --- /dev/null +++ b/src/extend-config/applyFabricXDefaults.ts @@ -0,0 +1,38 @@ +import { FabloConfigJson, FabricXConfigJson } from "../types/FabloConfigJson"; +import defaults from "./defaults"; + +// Fills in the values that a compact fabric-x config leaves out, so the rest of Fablo sees the full config. +const applyFabricXDefaults = (json: FabloConfigJson | FabricXConfigJson): FabloConfigJson => { + if (json.global?.provider !== "fabric-x") return json as FabloConfigJson; + + const config = json as FabricXConfigJson; + const orgs = config.orgs.map((org) => ({ + ...org, + organization: { + ...org.organization, + mspName: org.organization.mspName ?? defaults.organization.mspName(org.organization.name), + }, + ca: org.ca ?? { prefix: defaults.ca.prefix, db: defaults.ca.db }, + })); + const channels = config.channels.map((channel) => { + const channelOrgs: { name: string; peers?: string[] }[] = + channel.orgs ?? orgs.map((org) => ({ name: org.organization.name })); + return { ...channel, orgs: channelOrgs.map((org) => ({ name: org.name, peers: org.peers ?? [] })) }; + }); + + return { + ...config, + global: { + fabricVersion: defaults.fabricX.fabricVersion, + tls: true, + peerDevMode: false, + ...config.global, + }, + orgs, + channels, + chaincodes: config.chaincodes ?? [], + hooks: config.hooks ?? {}, + }; +}; + +export default applyFabricXDefaults; diff --git a/src/extend-config/defaults.ts b/src/extend-config/defaults.ts index 27a97da0..b45c3c61 100644 --- a/src/extend-config/defaults.ts +++ b/src/extend-config/defaults.ts @@ -17,7 +17,7 @@ export default { }, ca: { prefix: "ca", - db: "sqlite", + db: "sqlite" as const, }, peer: { prefix: "peer", @@ -39,4 +39,15 @@ export default { return `AND(${orgs.map((o) => `'${o.mspName}.member'`).join(",")})`; }, }, + fabricX: { + fabricVersion: "3.1.0", + orderer: { + partyCount: 1, + organization(partyId: number, partyCount: number): { name: string; domain: string; mspName: string } { + return partyCount === 1 + ? { name: "Orderer", domain: "orderer.example.com", mspName: "OrdererOrdererMSP" } + : { name: `OrdererOrg${partyId}`, domain: `orderer-org-${partyId}`, mspName: `OrdererOrg${partyId}MSP` }; + }, + }, + }, }; diff --git a/src/extend-config/extendConfig.ts b/src/extend-config/extendConfig.ts index 0b6c27a9..730aa47d 100644 --- a/src/extend-config/extendConfig.ts +++ b/src/extend-config/extendConfig.ts @@ -8,6 +8,7 @@ import extendHooksConfig from "./extendHooksConfig"; import { distinctOrdererHeads, mergeOrdererGroups } from "./mergeOrdererGroups"; import extendNamespacesConfig from "./extendNamespacesConfig"; import extendFabricXConfig from "./extendFabricXConfig"; +import applyFabricXDefaults from "./applyFabricXDefaults"; const extendConfig = (json: FabloConfigJson): FabloConfigExtended => { const { global: globalJson, @@ -17,7 +18,7 @@ const extendConfig = (json: FabloConfigJson): FabloConfigExtended => { hooks: hooksJson, namespaces: namespacesJson, fabricX: fabricXJson, - } = json; + } = applyFabricXDefaults(json); const global = extendGlobal(globalJson); const orgs = extendOrgsConfig(orgsJson, global); diff --git a/src/extend-config/extendFabricXConfig.ts b/src/extend-config/extendFabricXConfig.ts index 556d3b96..1e44f45f 100644 --- a/src/extend-config/extendFabricXConfig.ts +++ b/src/extend-config/extendFabricXConfig.ts @@ -2,15 +2,14 @@ import { FabricXConfig } from "../types/FabloConfigExtended"; import { FabricXJson } from "../types/FabloConfigJson"; import defaults from "./defaults"; -const extendFabricXConfig = (fabricXJson: FabricXJson | undefined): FabricXConfig => ({ - orderer: { - parties: (fabricXJson?.orderer?.parties ?? []).map(({ organization }) => ({ - organization: { - name: organization.name, - domain: organization.domain, - mspName: organization.mspName ?? defaults.organization.mspName(organization.name), - }, - })), - }, -}); +const extendFabricXConfig = (fabricXJson: FabricXJson | undefined): FabricXConfig => { + const partyCount = fabricXJson?.orderer?.partyCount ?? defaults.fabricX.orderer.partyCount; + return { + orderer: { + parties: Array.from({ length: partyCount }, (_, i) => ({ + organization: defaults.fabricX.orderer.organization(i + 1, partyCount), + })), + }, + }; +}; export default extendFabricXConfig; diff --git a/src/types/FabloConfigJson.ts b/src/types/FabloConfigJson.ts index 2d2b4718..f75639c6 100644 --- a/src/types/FabloConfigJson.ts +++ b/src/types/FabloConfigJson.ts @@ -91,11 +91,8 @@ export interface NamespaceJson { orgs?: string[]; policy?: string; } -export interface FabricXOrdererPartyJson { - organization: Omit & { mspName?: string }; -} export interface FabricXJson { - orderer: { parties: FabricXOrdererPartyJson[] }; + orderer?: { partyCount?: number }; } export interface FabloConfigJson { $schema: string; @@ -107,3 +104,22 @@ export interface FabloConfigJson { namespaces?: NamespaceJson[]; fabricX?: FabricXJson; } + +// Compact config accepted for the fabric-x provider. Fablo derives everything that is omitted here. +export interface FabricXOrgJson extends Omit { + organization: Omit & { mspName?: string }; + ca?: CAJson; +} +export interface FabricXChannelJson { + name: string; + orgs?: { name: string; peers?: string[] }[]; +} +export interface FabricXConfigJson + extends Omit { + global: Omit & + Partial>; + orgs: FabricXOrgJson[]; + channels: FabricXChannelJson[]; + chaincodes?: ChaincodeJson[]; + hooks?: HooksJson; +} From 5fd027b3263d3943f017ebec6104c60b5ac26c97 Mon Sep 17 00:00:00 2001 From: MaryamArif7 Date: Fri, 20 Nov 2026 12:24:53 +0500 Subject: [PATCH 2/4] test:updated snapshot Signed-off-by: MaryamArif7 --- ...lo-config-fabric-x-2orgs.json.test.ts.snap | 57 ++------------- e2e/__snapshots__/schema.test.ts.snap | 73 ++----------------- 2 files changed, 13 insertions(+), 117 deletions(-) diff --git a/e2e/__snapshots__/fablo-config-fabric-x-2orgs.json.test.ts.snap b/e2e/__snapshots__/fablo-config-fabric-x-2orgs.json.test.ts.snap index 6365dcf7..c8d4276e 100644 --- a/e2e/__snapshots__/fablo-config-fabric-x-2orgs.json.test.ts.snap +++ b/e2e/__snapshots__/fablo-config-fabric-x-2orgs.json.test.ts.snap @@ -4,81 +4,36 @@ exports[`samples/fablo-config-fabric-x-2orgs.json should create proper e2e/__tmp "{ "$schema": "https://github.com/hyperledger-labs/fablo/releases/download/2.6.0/schema.json", "global": { - "fabricVersion": "3.1.0", - "tls": true, - "engine": "docker", - "peerDevMode": false, "provider": "fabric-x" }, "orgs": [ { "organization": { "name": "Org1", - "domain": "org1.example.com", - "mspName": "Org1MSP" - }, - "ca": { - "prefix": "ca", - "db": "sqlite" + "domain": "org1.example.com" } }, { "organization": { "name": "Org2", - "domain": "org2.example.com", - "mspName": "Org2MSP" - }, - "ca": { - "prefix": "ca", - "db": "sqlite" + "domain": "org2.example.com" } } ], "channels": [ { - "name": "mychannel", - "orgs": [ - { - "name": "Org1", - "peers": [] - }, - { - "name": "Org2", - "peers": [] - } - ] + "name": "mychannel" } ], "namespaces": [ { - "name": "mynamespace", - "orgs": [ - "Org1", - "Org2" - ] + "name": "mynamespace" }, { "name": "audit_ns", - "orgs": [ - "Org1" - ] + "orgs": ["Org1"] } - ], - "fabricX": { - "orderer": { - "parties": [ - { - "organization": { - "name": "Orderer", - "domain": "orderer.example.com", - "mspName": "OrdererOrdererMSP" - } - } - ] - } - }, - "chaincodes": [], - "hooks": {} + ] } " `; diff --git a/e2e/__snapshots__/schema.test.ts.snap b/e2e/__snapshots__/schema.test.ts.snap index e7f3984e..179d0e3d 100644 --- a/e2e/__snapshots__/schema.test.ts.snap +++ b/e2e/__snapshots__/schema.test.ts.snap @@ -254,7 +254,6 @@ exports[`schema should match snapshot 1`] = ` }, "required": [ "name", - "peers", ], "title": "Organization", "type": "object", @@ -265,7 +264,6 @@ exports[`schema should match snapshot 1`] = ` }, "required": [ "name", - "orgs", ], "title": "Channel", "type": "object", @@ -280,71 +278,18 @@ exports[`schema should match snapshot 1`] = ` "orderer": { "$id": "#/properties/fabricX/properties/orderer", "properties": { - "parties": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties", - "default": [ - { - "organization": { - "domain": "orderer.example.com", - "mspName": "OrdererOrdererMSP", - "name": "Orderer", - }, - }, - ], - "description": "A party is an organization of the orderer with its own router, batcher, consenter and assembler. Fablo currently supports 1 party (the quick default) or 4 parties (a local profile for BFT testing).", - "items": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items", - "properties": { - "organization": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization", - "properties": { - "domain": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization/properties/domain", - "pattern": "^[a-z0-9\\.\\-]+$", - "title": "Domain", - "type": "string", - }, - "mspName": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization/properties/mspName", - "pattern": "^[a-zA-Z0-9]+$", - "title": "MSP Name", - "type": "string", - }, - "name": { - "$id": "#/properties/fabricX/properties/orderer/properties/parties/items/properties/organization/properties/name", - "pattern": "^[a-zA-Z0-9]+$", - "title": "Name", - "type": "string", - }, - }, - "required": [ - "name", - "domain", - ], - "title": "Organization of the party", - "type": "object", - }, - }, - "required": [ - "organization", - ], - "title": "Orderer party", - "type": "object", - }, - "title": "Orderer parties", - "type": "array", + "partyCount": { + "$id": "#/properties/fabricX/properties/orderer/properties/partyCount", + "default": 1, + "description": "A party is an organization of the orderer with its own router, batcher, consenter and assembler. Fablo derives the organizations of the parties. Fablo currently supports 1 party (the quick default) or 4 parties (a local profile for BFT testing).", + "title": "Number of orderer parties", + "type": "integer", }, }, - "required": [ - "parties", - ], "title": "Orderer", "type": "object", }, }, - "required": [ - "orderer", - ], "title": "Fabric-X settings (EXPERIMENTAL)", "type": "object", }, @@ -496,10 +441,7 @@ exports[`schema should match snapshot 1`] = ` "type": "object", }, }, - "required": [ - "fabricVersion", - "tls", - ], + "required": [], "title": "Global network settings", "type": "object", }, @@ -789,7 +731,6 @@ exports[`schema should match snapshot 1`] = ` "global", "orgs", "channels", - "chaincodes", ], "title": "Root", "type": "object", From 95c0d23b57dceb8f9d424b9cbe048e8f14bfc561 Mon Sep 17 00:00:00 2001 From: MaryamArif7 Date: Fri, 20 Nov 2026 13:14:16 +0500 Subject: [PATCH 3/4] fix:resolved the test-08-failure Signed-off-by: MaryamArif7 --- e2e-network/docker/test-08-fabric-x.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/e2e-network/docker/test-08-fabric-x.sh b/e2e-network/docker/test-08-fabric-x.sh index ac9208dd..c699da19 100755 --- a/e2e-network/docker/test-08-fabric-x.sh +++ b/e2e-network/docker/test-08-fabric-x.sh @@ -111,7 +111,7 @@ fxconfig_value() { FX_ORG_DOMAIN="$(jq -r '.orgs[0].organization.domain' "$CONFIG")" FX_NAMESPACE="$(jq -r '.namespaces[] | select(.orgs == ["Org1"]) | .name' "$CONFIG" | head -n 1)" -FX_MSP_NAME="$(jq -r '.orgs[0].organization.mspName' "$CONFIG")" +FX_MSP_NAME="$(jq -r '.orgs[0].organization | .mspName // (.name + "MSP")' "$CONFIG")" FX_CHANNEL="$(jq -r '.channels[0].name' "$CONFIG")" FX_ORDERER="$(fxconfig_value orderer address)" FX_SIDECAR="$(fxconfig_value notifications address)" From 3d95f97a2b3610080ab156a8d504790bba029cbd Mon Sep 17 00:00:00 2001 From: MaryamArif7 Date: Fri, 20 Nov 2026 13:53:36 +0500 Subject: [PATCH 4/4] fix:line removed Signed-off-by: MaryamArif7 --- src/extend-config/applyFabricXDefaults.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/extend-config/applyFabricXDefaults.ts b/src/extend-config/applyFabricXDefaults.ts index 49f67c8b..5f6dd04f 100644 --- a/src/extend-config/applyFabricXDefaults.ts +++ b/src/extend-config/applyFabricXDefaults.ts @@ -1,7 +1,7 @@ import { FabloConfigJson, FabricXConfigJson } from "../types/FabloConfigJson"; import defaults from "./defaults"; -// Fills in the values that a compact fabric-x config leaves out, so the rest of Fablo sees the full config. + const applyFabricXDefaults = (json: FabloConfigJson | FabricXConfigJson): FabloConfigJson => { if (json.global?.provider !== "fabric-x") return json as FabloConfigJson;