Constructor

# new FabricClientAdapter(config, alias)

The FabricAdapter extends CouchDBAdapter to provide a seamless interface for interacting with Hyperledger Fabric networks. It handles connection management, transaction submission, and CRUD operations against Fabric chaincode.

Adapter for interacting with Hyperledger Fabric networks

sequenceDiagram participant Client participant FabricAdapter participant Gateway participant Network participant Contract participant Chaincode Client->>FabricAdapter: create(tableName, id, model, transient, serializer) FabricAdapter->>FabricAdapter: submitTransaction(OperationKeys.CREATE, [serializedModel], transient) FabricAdapter->>Gateway: connect() Gateway->>Network: getNetwork(channelName) Network->>Contract: getContract(chaincodeName, contractName) FabricAdapter->>Contract: submit(api, proposalOptions) Contract->>Chaincode: invoke Chaincode-->>Contract: response Contract-->>FabricAdapter: result FabricAdapter->>FabricAdapter: decode(result) FabricAdapter->>FabricAdapter: serializer.deserialize(decodedResult) FabricAdapter-->>Client: deserializedResult

Parameters:

Name	Type	Description
`config`		Configuration for connecting to a Fabric peer
`alias`		Optional alias for the adapter instance

View Source client/FabricClientAdapter.ts, line 29

Example

```typescript
// Create a new FabricAdapter instance
const config: PeerConfig = {
  mspId: 'Org1MSP',
  peerEndpoint: 'localhost:7051',
  channelName: 'mychannel',
  chaincodeName: 'mycc',
  contractName: 'mycontract',
  tlsCertPath: '/path/to/tls/cert',
  certDirectoryPath: '/path/to/cert/dir',
  keyDirectoryPath: '/path/to/key/dir'
};

const adapter = new FabricAdapter(config, 'org1-adapter');

// Use the adapter to interact with the Fabric network
const result = await adapter.read('users', 'user1', mySerializer);
```

Classes

FabricClientAdapter: Initializes a new adapter for interacting with a Hyperledger Fabric network
FabricClientAdapter: Initializes a new adapter for interacting with a Hyperledger Fabric network

Members

# decoder

Static text decoder for converting Uint8Array to string

View Source client/FabricClientAdapter.ts, line 84

Methods

# async protected Contract(ctx, contractNameopt) → {Promise.<Contrakt>}

Creates a new Contract instance using the current Gateway

Gets a Contract instance for the Fabric chaincode

Parameters:

Name	Type	Attributes	Description
`ctx`	`Context.<FabricClientFlags>`
`contractName`	`string`	<optional>

View Source client/FabricClientAdapter.ts, line 1531

Returns:

Promise resolving to the Contract instance

Type: Promise.<Contrakt>

# Dispatch() → {Dispatch}

This function is responsible for creating a new FabricClientDispatch instance that can be used to interact with the Fabric network.

Creates a new Dispatch instance for the Fabric client.

View Source client/FabricClientAdapter.ts, line 1681

Returns:

A new Dispatch instance configured for the Fabric client.

Type: Dispatch

Example

const fabricDispatch = fabricClientAdapter.Dispatch();
fabricDispatch.submitTransaction('createProduct', { name: 'Product A', price: 100 });

# async protected Gateway(ctx) → {Promise.<Gateway>}

Creates a new Gateway instance using the current client

Gets a Gateway instance for the Fabric network

Parameters:

Name	Type	Description
`ctx`	`Context.<FabricClientFlags>`

View Source client/FabricClientAdapter.ts, line 1520

Returns:

Promise resolving to the Gateway instance

Type: Promise.<Gateway>

# async create(tableName, id, model, transient) → {Promise.<Record.<string, any>>}

Submits a transaction to create a record in the Fabric ledger

Creates a single record

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`id`	`string` \| `number`	The record identifier
`model`	`Record.<string, any>`	The record data
`transient`	`Record.<string, any>`	Transient data for the transaction

View Source client/FabricClientAdapter.ts, line 1430

Returns:

Promise resolving to the created record

Type: Promise.<Record.<string, any>>

# async createAll(tableName, ids, models, transient) → {Promise.<Array.<Record.<string, any>>>}

Submits a transaction to create multiple records in the Fabric ledger

Creates multiple records in a single transaction

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`ids`	`Array.<string>` \| `Array.<number>`	Array of record identifiers
`models`	`Array.<Record.<string, any>>`	Array of record data
`transient`	`Record.<string, any>`	Transient data for the transaction

View Source client/FabricClientAdapter.ts, line 1374

Returns:

Promise resolving to the created records

Type: Promise.<Array.<Record.<string, any>>>

# protected createAllPrefix(tableName, ids, models)

Adds necessary CouchDB fields to multiple records before creation

Prepares multiple records for creation

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table
`ids`	`Array.<string>` \| `Array.<number>`	The IDs of the records
`models`		The models to prepare

View Source client/FabricClientAdapter.ts, line 1362

Throws:

If ids and models arrays have different lengths

Type: InternalError

Returns:

A tuple containing the tableName, ids, and prepared records

# decode(data) → {string}

Converts binary data received from Fabric to a string using UTF-8 encoding

Decodes a Uint8Array to a string

Parameters:

Name	Type	Description
`data`	`Uint8Array`	The binary data to decode

View Source client/FabricClientAdapter.ts, line 1350

Returns:

The decoded string

Type: string

# async delete(tableName, id) → {Promise.<Record.<string, any>>}

Submits a transaction to delete a record from the Fabric ledger

Deletes a single record

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`id`	`string` \| `number`	The record identifier to delete

View Source client/FabricClientAdapter.ts, line 1462

Returns:

Promise resolving to the deleted record

Type: Promise.<Record.<string, any>>

# async deleteAll(tableName, ids, serializer) → {Promise.<Array.<Record.<string, any>>>}

Submits a transaction to delete multiple records from the Fabric ledger

Deletes multiple records in a single transaction

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`ids`	`Array.<(string\|number\|bigint)>`	Array of record identifiers to delete
`serializer`	`Serializer.<any>`	Serializer for the model data

View Source client/FabricClientAdapter.ts, line 1407

Returns:

Promise resolving to the deleted records

Type: Promise.<Array.<Record.<string, any>>>

# async evaluateTransaction(api, argsopt, transientDataopt, endorsingOrganizationsopt) → {Promise.<Uint8Array>}

Executes a transaction that does not modify the ledger state

Evaluates a transaction on the Fabric network

Parameters:

Name	Type	Attributes	Description
`api`	`string`		The chaincode function to call
`args`	`Array.<any>`	<optional>	Arguments to pass to the chaincode function
`transientData`	`Record.<string, string>`	<optional>	Transient data for the transaction
`endorsingOrganizations`	`Array.<string>`	<optional>	Organizations that must endorse the transaction

View Source client/FabricClientAdapter.ts, line 1596

Returns:

Promise resolving to the transaction result

Type: Promise.<Uint8Array>

# getClient() → {Promise.<Client>}

Returns a cached client or creates a new one if none exists

Gets or creates a gRPC client for the Fabric peer

View Source client/FabricClientAdapter.ts, line 1510

Returns:

Promise resolving to the gRPC client

Type: Promise.<Client>

# parseError(err, reasonopt) → {BaseError}

Converts any error into a standardized BaseError

Parses an error into a BaseError

Parameters:

Name	Type	Attributes	Description
`err`	`Error` \| `string`		The error to parse
`reason`	`string`	<optional>	Optional reason for the error

View Source client/FabricClientAdapter.ts, line 1572

Returns:

The parsed error

Type: BaseError

# prepare(model, pk)

Converts a model instance into a format suitable for database storage, handling column mapping and separating transient properties

Prepares a model for persistence

Parameters:

Name	Type	Description
`model`	`M`	The model instance to prepare
`pk`		The primary key property name

View Source client/FabricClientAdapter.ts, line 1418

Returns:

The prepared data

# async raw(rawInput, process) → {Promise.<V>}

Evaluates a transaction to perform a query using Mango Query syntax

Executes a raw query against the Fabric ledger

sequenceDiagram participant Client participant FabricAdapter participant Contract participant Chaincode Client->>FabricAdapter: raw(rawInput, process) FabricAdapter->>FabricAdapter: JSON.stringify(rawInput) FabricAdapter->>FabricAdapter: evaluateTransaction("query", [input]) FabricAdapter->>Contract: evaluate("query", proposalOptions) Contract->>Chaincode: invoke Chaincode-->>Contract: response Contract-->>FabricAdapter: result FabricAdapter->>FabricAdapter: JSON.parse(decode(result)) FabricAdapter->>FabricAdapter: Process result based on type FabricAdapter-->>Client: processed result

Parameters:

Name	Type	Description
`rawInput`	`MangoQuery`	The Mango Query to execute
`process`	`boolean`	Whether to process the result

View Source client/FabricClientAdapter.ts, line 1490

Returns:

Promise resolving to the query result

Type: Promise.<V>

# async read(tableName, id) → {Promise.<Record.<string, any>>}

Evaluates a transaction to read a record from the Fabric ledger

Reads a single record

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`id`	`string` \| `number`	The record identifier

View Source client/FabricClientAdapter.ts, line 1440

Returns:

Promise resolving to the retrieved record

Type: Promise.<Record.<string, any>>

# async readAll(tableName, ids) → {Promise.<Array.<Record.<string, any>>>}

Submits a transaction to read multiple records from the Fabric ledger

Reads multiple records in a single transaction

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`ids`	`Array.<string>` \| `Array.<number>`	Array of record identifiers to read

View Source client/FabricClientAdapter.ts, line 1384

Returns:

Promise resolving to the retrieved records

Type: Promise.<Array.<Record.<string, any>>>

# async shutdown(args) → {Promise.<void>}

Closes the active dispatch (which in turn closes any gateway event subscription) via the base class, then closes the gRPC client. Works correctly regardless of whether syntheticEvents is enabled.

Shuts down the connection to the Fabric network

Parameters:

Name	Type	Description
`args`	`MaybeContextualArg.<Context.<FabricClientFlags>>`

View Source client/FabricClientAdapter.ts, line 1607

Returns:

Promise that resolves when all connections are closed

Type: Promise.<void>

# async submitTransaction(api, argsopt, transientDataopt, endorsingOrganizationsopt) → {Promise.<Uint8Array>}

Executes a transaction that modifies the ledger state

Submits a transaction to the Fabric network

Parameters:

Name	Type	Attributes	Description
`api`	`string`		The chaincode function to call
`args`	`Array.<any>`	<optional>	Arguments to pass to the chaincode function
`transientData`	`Record.<string, string>`	<optional>	Transient data for the transaction
`endorsingOrganizations`	`Array.<string>`	<optional>	Organizations that must endorse the transaction

View Source client/FabricClientAdapter.ts, line 1584

Returns:

Promise resolving to the transaction result

Type: Promise.<Uint8Array>

# async protected transaction(api, submit, argsopt, transientDataopt, endorsingOrganizationsopt) → {Promise.<Uint8Array>}

Submits or evaluates a transaction on the Fabric chaincode

Executes a transaction on the Fabric network

sequenceDiagram participant FabricAdapter participant Gateway participant Contract participant Chaincode FabricAdapter->>Gateway: connect() FabricAdapter->>Contract: getContract() alt submit transaction FabricAdapter->>Contract: submit(api, proposalOptions) else evaluate transaction FabricAdapter->>Contract: evaluate(api, proposalOptions) end Contract->>Chaincode: invoke Chaincode-->>Contract: response Contract-->>FabricAdapter: result FabricAdapter->>Gateway: close()

Parameters:

Name	Type	Attributes	Description
`api`	`string`		The chaincode function to call
`submit`	`boolean`		Whether to submit (true) or evaluate (false) the transaction
`args`	`Array.<any>`	<optional>	Arguments to pass to the chaincode function
`transientData`	`Record.<string, string>`	<optional>	Transient data for the transaction
`endorsingOrganizations`	`Array.<string>`	<optional>	Organizations that must endorse the transaction

View Source client/FabricClientAdapter.ts, line 1563

Returns:

Promise resolving to the transaction result

Type: Promise.<Uint8Array>

# async update(tableName, id, model, transient) → {Promise.<Record.<string, any>>}

Submits a transaction to update a record in the Fabric ledger

Updates a single record

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`id`	`string` \| `number`	The record identifier
`model`	`Record.<string, any>`	The updated record data
`transient`	`Record.<string, any>`	Transient data for the transaction

View Source client/FabricClientAdapter.ts, line 1452

Returns:

Promise resolving to the updated record

Type: Promise.<Record.<string, any>>

# async updateAll(tableName, ids, models, transient) → {Promise.<Array.<Record.<string, any>>>}

Submits a transaction to update multiple records in the Fabric ledger

Updates multiple records in a single transaction

Parameters:

Name	Type	Description
`tableName`	`string`	The name of the table/collection
`ids`	`Array.<string>` \| `Array.<number>`	Array of record identifiers
`models`	`Array.<Record.<string, any>>`	Array of updated record data
`transient`	`Record.<string, any>`	Transient data for the transaction

View Source client/FabricClientAdapter.ts, line 1396

Returns:

Promise resolving to the updated records

Type: Promise.<Array.<Record.<string, any>>>

# async view(ddoc, viewName, options, …args) → {Promise.<ViewResponse.<R>>}

Evaluates a transaction to query a design document view

Executes a CouchDB view query against the Fabric chaincode

Parameters:

Name	Type	Attributes	Description
`ddoc`	`string`		Design document name
`viewName`	`string`		View name
`options`	`Record.<string, any>`		View query options
`args`	`ContextualArgs.<Context.<FabricClientFlags>>`	<repeatable>	Optional contextual arguments

View Source client/FabricClientAdapter.ts, line 1503

Returns:

The view response

Type: Promise.<ViewResponse.<R>>

# static getClient(config) → {Client}

Initializes a client with TLS credentials for secure communication

Creates a gRPC client for connecting to a Fabric peer

Parameters:

Name	Type	Description
`config`	`PeerConfig`	The peer configuration

View Source client/FabricClientAdapter.ts, line 1643

Returns:

Promise resolving to the gRPC client

Type: Client

# async static getConnection(client, config) → {Promise.<Gateway>}

Creates a Gateway connection with identity and signer

Establishes a connection to the Fabric network

sequenceDiagram participant Caller participant FabricAdapter participant Identity participant Signer participant Gateway Caller->>FabricAdapter: getConnection(client, config) FabricAdapter->>Identity: getIdentity(mspId, certDirectoryPath) Identity-->>FabricAdapter: identity FabricAdapter->>Signer: getSigner(keyDirectoryPath) Signer-->>FabricAdapter: signer FabricAdapter->>FabricAdapter: Create ConnectOptions FabricAdapter->>Gateway: connect(options) Gateway-->>FabricAdapter: gateway FabricAdapter-->>Caller: gateway

Parameters:

Name	Type	Description
`client`	`Client`	The gRPC client
`config`	`PeerConfig`	The peer configuration

View Source client/FabricClientAdapter.ts, line 1670

Returns:

Promise resolving to the connected Gateway

Type: Promise.<Gateway>

# static getContract(gateway, config) → {Contrakt}

Retrieves a chaincode contract from the specified network

Gets a Contract instance from a Gateway

Parameters:

Name	Type	Description
`gateway`	`Gateway`	The Gateway instance
`config`	`PeerConfig`	The peer configuration

View Source client/FabricClientAdapter.ts, line 1616

Returns:

The Contract instance

Type: Contrakt

# async static getGateway(config, clientopt) → {Promise.<Gateway>}

Creates a Gateway using the provided configuration and client

Gets a Gateway instance for connecting to the Fabric network

Parameters:

Name	Type	Attributes	Description
`config`	`PeerConfig`		The peer configuration
`client`	`Client`	<optional>	Optional gRPC client, will be created if not provided

View Source client/FabricClientAdapter.ts, line 1635

Returns:

Promise resolving to the Gateway instance

Type: Promise.<Gateway>

# static getNetwork(gateway, channelName) → {Network}

Connects to a specific channel on the Fabric network

Gets a Network instance from a Gateway

Parameters:

Name	Type	Description
`gateway`	`Gateway`	The Gateway instance
`channelName`	`string`	The name of the channel to connect to

View Source client/FabricClientAdapter.ts, line 1625

Returns:

The Network instance

Type: Network

# protected static parseError(err, reasonopt) → {BaseError}

Converts any error into a standardized BaseError using the parent class implementation

Parses an error into a BaseError

Parameters:

Name	Type	Attributes	Description
`err`	`Error` \| `string`		The error to parse
`reason`	`string`	<optional>	Optional reason for the error

View Source client/FabricClientAdapter.ts, line 1691

Returns:

The parsed error

Type: BaseError

ts-template

# new FabricClientAdapter(config, alias)

Parameters:

Example

Classes

Members

# decoder

Methods

# async protected Contract(ctx, contractNameopt) → {Promise.<Contrakt>}

Parameters:

# Dispatch() → {Dispatch}

Example

# async protected Gateway(ctx) → {Promise.<Gateway>}

Parameters:

# async create(tableName, id, model, transient) → {Promise.<Record.<string, any>>}

Parameters:

# async createAll(tableName, ids, models, transient) → {Promise.<Array.<Record.<string, any>>>}

Parameters:

# protected createAllPrefix(tableName, ids, models)

Parameters:

# decode(data) → {string}

Parameters:

# async delete(tableName, id) → {Promise.<Record.<string, any>>}

Parameters:

# async deleteAll(tableName, ids, serializer) → {Promise.<Array.<Record.<string, any>>>}

Parameters:

# async evaluateTransaction(api, argsopt, transientDataopt, endorsingOrganizationsopt) → {Promise.<Uint8Array>}

Parameters:

# getClient() → {Promise.<Client>}

# parseError(err, reasonopt) → {BaseError}

Parameters:

# prepare(model, pk)

Parameters:

# async raw(rawInput, process) → {Promise.<V>}

Parameters:

# async read(tableName, id) → {Promise.<Record.<string, any>>}

Parameters:

# async readAll(tableName, ids) → {Promise.<Array.<Record.<string, any>>>}

Parameters:

# async shutdown(args) → {Promise.<void>}

Parameters:

# async submitTransaction(api, argsopt, transientDataopt, endorsingOrganizationsopt) → {Promise.<Uint8Array>}

Parameters:

# async protected transaction(api, submit, argsopt, transientDataopt, endorsingOrganizationsopt) → {Promise.<Uint8Array>}

Parameters:

# async update(tableName, id, model, transient) → {Promise.<Record.<string, any>>}

Parameters:

# async updateAll(tableName, ids, models, transient) → {Promise.<Array.<Record.<string, any>>>}

Parameters:

# async view(ddoc, viewName, options, …args) → {Promise.<ViewResponse.<R>>}

Parameters:

# static getClient(config) → {Client}

Parameters:

# async static getConnection(client, config) → {Promise.<Gateway>}

Parameters:

# static getContract(gateway, config) → {Contrakt}

Parameters:

# async static getGateway(config, clientopt) → {Promise.<Gateway>}

Parameters:

# static getNetwork(gateway, channelName) → {Network}

Parameters:

# protected static parseError(err, reasonopt) → {BaseError}

Parameters: