@decaf-ts/for-fabric 0.9.0 → 0.10.0

package/lib/types/client/erc20/FabricERC20ClientRepository.d.cts

@@ -0,0 +1,254 @@
+import { FabricClientRepository } from "../FabricClientRepository.cjs";
+import { ERC20Token, ERC20Wallet } from "../../contracts/erc20/models.cjs";
+import { Model, Serializer } from "@decaf-ts/decorator-validation";
+import { FabricClientAdapter } from "../FabricClientAdapter.cjs";
+import { ContextOf, ContextualArgs, EventIds, MaybeContextualArg } from "@decaf-ts/core";
+import { BulkCrudOperationKeys, OperationKeys } from "@decaf-ts/db-decorators";
+import { Constructor } from "@decaf-ts/decoration";
+/**
+ * Repository for interacting with ERC20 contracts on a Hyperledger Fabric network.
+ * Extends the base FabricClientRepository class and utilizes the ClientSerializer for data serialization.
+ */
+export declare class FabricERC20ClientRepository<A extends FabricClientAdapter> extends FabricClientRepository<ERC20Wallet, A> {
+    private static serializer;
+    protected readonly serializer: Serializer<any>;
+    private static decoder;
+    /**
+     * @description Notifies all observers of an event.
+     * @summary Updates all registered observers with information about a database event.
+     * @param {string} table - The table name where the event occurred.
+     * @param {OperationKeys|BulkCrudOperationKeys|string} event - The type of event that occurred.
+     * @param {EventIds} id - The ID or IDs of the affected records.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<void>} A promise that resolves when all observers have been notified.
+     * @throws {InternalError} If the observer handler is not initialized.
+     */
+    updateObservers<M extends Model>(table: Constructor<M> | string, event: OperationKeys | BulkCrudOperationKeys | string, id: EventIds, ...args: ContextualArgs<ContextOf<A>>): Promise<void>;
+    /**
+     * Decodes a Uint8Array into a string using the TextDecoder.
+     *
+     * @param data - The Uint8Array to decode.
+     * @returns The decoded string.
+     */
+    decode(data: Uint8Array): string;
+    constructor(adapter?: A);
+    /**
+     * Retrieves the name of the ERC20 token.
+     *
+     * @description
+     * This function interacts with the blockchain network to fetch the name of the ERC20 token.
+     * It calls the "TokenName" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<string>} A promise that resolves with the name of the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    tokenName(...args: MaybeContextualArg<ContextOf<A>>): Promise<string>;
+    /**
+     * Retrieves the symbol of the ERC20 token.
+     *
+     * This function interacts with the blockchain network to fetch the symbol of the ERC20 token.
+     * It calls the "Symbol" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<string>} A promise that resolves with the symbol of the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    symbol(...args: MaybeContextualArg<ContextOf<A>>): Promise<string>;
+    /**
+     * Retrieves the number of decimal places for the ERC20 token.
+     *
+     * This function interacts with the blockchain network to fetch the number of decimal places for the ERC20 token.
+     * It calls the "Decimals" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<number>} A promise that resolves with the number of decimal places for the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    decimals(...args: MaybeContextualArg<ContextOf<A>>): Promise<number>;
+    /**
+     * Retrieves the total supply of the ERC20 token.
+     *
+     * This function interacts with the blockchain network to fetch the total supply of the ERC20 token.
+     * It calls the "TotalSupply" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<number>} A promise that resolves with the total supply of the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    totalSupply(...args: MaybeContextualArg<ContextOf<A>>): Promise<number>;
+    /**
+     * Retrieves the balance of the ERC20 token for a specified owner.
+     *
+     * @description
+     * This function interacts with the blockchain network to fetch the balance of the ERC20 token for a given owner.
+     * It calls the "BalanceOf" transaction on the smart contract with the provided owner's address as a parameter.
+     * The returned data is then decoded and converted to a number.
+     *
+     * @param owner - The address of the ERC20 token owner.
+     *
+     * @returns {Promise<number>} A promise that resolves with the balance of the ERC20 token for the specified owner.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    balanceOf(owner: string, ...args: MaybeContextualArg<ContextOf<A>>): Promise<number>;
+    /**
+     * Transfers a specified amount of ERC20 tokens to a recipient.
+     *
+     * @description
+     * This function interacts with the blockchain network to transfer a specified amount of ERC20 tokens to a recipient.
+     * It calls the "Transfer" transaction on the smart contract with the recipient's address and the transfer amount as parameters.
+     * The returned data is then decoded and checked to determine if the transfer was successful.
+     *
+     * @param to - The address of the recipient.
+     * @param value - The amount of ERC20 tokens to transfer.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the transfer was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    transfer(to: string, value: number, ...args: MaybeContextualArg<ContextOf<A>>): Promise<boolean>;
+    /**
+     * Transfers a specified amount of ERC20 tokens from one account to another.
+     *
+     * @description
+     * This function interacts with the blockchain network to transfer a specified amount of ERC20 tokens from one account to another.
+     * For this transfer to work the spender ( account that will trigger this function ) need to have the value approved as an allowance by the sender.
+     * It calls the "TransferFrom" transaction on the smart contract with the sender's address, recipient's address, and the transfer amount as parameters.
+     * The returned data is then decoded and checked to determine if the transfer was successful.
+     *
+     * @param from - The address of the sender.
+     * @param to - The address of the recipient.
+     * @param value - The amount of ERC20 tokens to transfer.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the transfer was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    transferFrom(from: string, to: string, value: number): Promise<boolean>;
+    /**
+     * Approves a specified amount of ERC20 tokens to be spent by a specified spender.
+     *
+     * This function interacts with the blockchain network to approve a specified amount of ERC20 tokens to be spent by a specified spender.
+     * It calls the "Approve" transaction on the smart contract with the spender's address and the approval amount as parameters.
+     * The returned data is then decoded and checked to determine if the approval was successful.
+     *
+     * @param spender - The address of the spender.
+     * @param value - The amount of ERC20 tokens to approve for the spender.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the approval was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    approve(spender: string, value: number): Promise<boolean>;
+    /**
+     * Retrieves the allowance of ERC20 tokens that the specified owner has approved for a spender.
+     *
+     * @description
+     * This function interacts with the blockchain network to fetch the allowance of ERC20 tokens that the specified owner has approved for a spender.
+     * It calls the "Allowance" transaction on the smart contract with the owner's address and the spender's address as parameters.
+     * The returned data is then decoded and converted to a number.
+     *
+     * @param owner - The address of the ERC20 token owner.
+     * @param spender - The address of the spender.
+     *
+     * @returns {Promise<number>} A promise that resolves with the allowance of ERC20 tokens that the specified owner has approved for the spender.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    allowance(owner: string, spender: string): Promise<number>;
+    /**
+     * Initializes the ERC20 contract with the provided token information.
+     *
+     * @description
+     * This function interacts with the blockchain network to initialize the ERC20 contract with the given token information.
+     * It calls the "Initialize" transaction on the smart contract with the serialized token data as a parameter.
+     * The returned data is then decoded and checked to determine if the initialization was successful.
+     *
+     * @param token - The ERC20 token information to initialize the contract with.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the initialization was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    initialize(token: ERC20Token): Promise<boolean>;
+    /**
+     * Checks if the ERC20 contract has been initialized.
+     *
+     * This function interacts with the blockchain network to verify if the ERC20 contract has been initialized.
+     * It calls the "CheckInitialized" transaction on the smart contract, which does not require any parameters.
+     *
+     * @returns {Promise<void>} A promise that resolves when the initialization check is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    checkInitialized(): Promise<void>;
+    /**
+     * Mints a specified amount of ERC20 tokens.
+     *
+     * @description
+     * This function interacts with the blockchain network to mint a specified amount of ERC20 tokens.
+     * It calls the "Mint" transaction on the smart contract with the minting amount as a parameter.
+     * The function does not return any value, but it updates the minter's number of tokens.
+     *
+     * @param amount - The amount of ERC20 tokens to mint.
+     *
+     * @returns {Promise<void>} A promise that resolves when the minting process is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    mint(amount: number): Promise<void>;
+    /**
+     * Burns a specified amount of ERC20 tokens from the minter's account.
+     *
+     * This function interacts with the blockchain network to burn a specified amount of ERC20 tokens.
+     * It calls the "Burn" transaction on the smart contract with the burning amount as a parameter.
+     * The function does not return any value, but it decreases the minter's number of tokens.
+     *
+     * @param amount - The amount of ERC20 tokens to burn.
+     *
+     * @returns {Promise<void>} A promise that resolves when the burning process is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    burn(amount: number): Promise<void>;
+    /**
+     * Burns a specified amount of ERC20 tokens from a specified account.
+     *
+     * This function interacts with the blockchain network to burn a specified amount of ERC20 tokens from a given account.
+     * It calls the "BurnFrom" transaction on the smart contract with the account's address and the burning amount as parameters.
+     * The function does not return any value, but it decreases the specified account's number of tokens.
+     *
+     * @param account - The address of the account from which to burn the ERC20 tokens.
+     * @param amount - The amount of ERC20 tokens to burn.
+     *
+     * @returns {Promise<void>} A promise that resolves when the burning process is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    burnFrom(account: string, amount: number): Promise<void>;
+    /**
+     * Retrieves the balance of ERC20 tokens associated with the client's account.
+     *
+     * This function interacts with the blockchain network to fetch the balance of ERC20 tokens associated with the client's account.
+     * It calls the "ClientAccountBalance" transaction on the smart contract, which does not require any parameters.
+     * The returned data is then decoded and converted to a number.
+     *
+     * @returns {Promise<number>} A promise that resolves with the balance of ERC20 tokens associated with the client's account.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    clientAccountBalance(): Promise<number>;
+    /**
+     * Retrieves the client's account ID from the blockchain network.
+     *
+     * This function interacts with the blockchain network to fetch the client's account ID.
+     * It calls the "ClientAccountID" transaction on the smart contract, which does not require any parameters.
+     * The returned data is then decoded and returned as a string.
+     *
+     * @returns {Promise<string>} A promise that resolves with the client's account ID.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    clientAccountID(): Promise<string>;
+}

package/lib/types/client/erc20/FabricERC20ClientRepository.d.mts

@@ -0,0 +1,254 @@
+import { FabricClientRepository } from "../FabricClientRepository.js";
+import { ERC20Token, ERC20Wallet } from "../../contracts/erc20/models.js";
+import { Model, Serializer } from "@decaf-ts/decorator-validation";
+import { FabricClientAdapter } from "../FabricClientAdapter.js";
+import { ContextOf, ContextualArgs, EventIds, MaybeContextualArg } from "@decaf-ts/core";
+import { BulkCrudOperationKeys, OperationKeys } from "@decaf-ts/db-decorators";
+import { Constructor } from "@decaf-ts/decoration";
+/**
+ * Repository for interacting with ERC20 contracts on a Hyperledger Fabric network.
+ * Extends the base FabricClientRepository class and utilizes the ClientSerializer for data serialization.
+ */
+export declare class FabricERC20ClientRepository<A extends FabricClientAdapter> extends FabricClientRepository<ERC20Wallet, A> {
+    private static serializer;
+    protected readonly serializer: Serializer<any>;
+    private static decoder;
+    /**
+     * @description Notifies all observers of an event.
+     * @summary Updates all registered observers with information about a database event.
+     * @param {string} table - The table name where the event occurred.
+     * @param {OperationKeys|BulkCrudOperationKeys|string} event - The type of event that occurred.
+     * @param {EventIds} id - The ID or IDs of the affected records.
+     * @param {...any[]} args - Additional arguments.
+     * @return {Promise<void>} A promise that resolves when all observers have been notified.
+     * @throws {InternalError} If the observer handler is not initialized.
+     */
+    updateObservers<M extends Model>(table: Constructor<M> | string, event: OperationKeys | BulkCrudOperationKeys | string, id: EventIds, ...args: ContextualArgs<ContextOf<A>>): Promise<void>;
+    /**
+     * Decodes a Uint8Array into a string using the TextDecoder.
+     *
+     * @param data - The Uint8Array to decode.
+     * @returns The decoded string.
+     */
+    decode(data: Uint8Array): string;
+    constructor(adapter?: A);
+    /**
+     * Retrieves the name of the ERC20 token.
+     *
+     * @description
+     * This function interacts with the blockchain network to fetch the name of the ERC20 token.
+     * It calls the "TokenName" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<string>} A promise that resolves with the name of the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    tokenName(...args: MaybeContextualArg<ContextOf<A>>): Promise<string>;
+    /**
+     * Retrieves the symbol of the ERC20 token.
+     *
+     * This function interacts with the blockchain network to fetch the symbol of the ERC20 token.
+     * It calls the "Symbol" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<string>} A promise that resolves with the symbol of the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    symbol(...args: MaybeContextualArg<ContextOf<A>>): Promise<string>;
+    /**
+     * Retrieves the number of decimal places for the ERC20 token.
+     *
+     * This function interacts with the blockchain network to fetch the number of decimal places for the ERC20 token.
+     * It calls the "Decimals" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<number>} A promise that resolves with the number of decimal places for the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    decimals(...args: MaybeContextualArg<ContextOf<A>>): Promise<number>;
+    /**
+     * Retrieves the total supply of the ERC20 token.
+     *
+     * This function interacts with the blockchain network to fetch the total supply of the ERC20 token.
+     * It calls the "TotalSupply" transaction on the smart contract and decodes the returned data.
+     *
+     * @returns {Promise<number>} A promise that resolves with the total supply of the ERC20 token.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    totalSupply(...args: MaybeContextualArg<ContextOf<A>>): Promise<number>;
+    /**
+     * Retrieves the balance of the ERC20 token for a specified owner.
+     *
+     * @description
+     * This function interacts with the blockchain network to fetch the balance of the ERC20 token for a given owner.
+     * It calls the "BalanceOf" transaction on the smart contract with the provided owner's address as a parameter.
+     * The returned data is then decoded and converted to a number.
+     *
+     * @param owner - The address of the ERC20 token owner.
+     *
+     * @returns {Promise<number>} A promise that resolves with the balance of the ERC20 token for the specified owner.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    balanceOf(owner: string, ...args: MaybeContextualArg<ContextOf<A>>): Promise<number>;
+    /**
+     * Transfers a specified amount of ERC20 tokens to a recipient.
+     *
+     * @description
+     * This function interacts with the blockchain network to transfer a specified amount of ERC20 tokens to a recipient.
+     * It calls the "Transfer" transaction on the smart contract with the recipient's address and the transfer amount as parameters.
+     * The returned data is then decoded and checked to determine if the transfer was successful.
+     *
+     * @param to - The address of the recipient.
+     * @param value - The amount of ERC20 tokens to transfer.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the transfer was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    transfer(to: string, value: number, ...args: MaybeContextualArg<ContextOf<A>>): Promise<boolean>;
+    /**
+     * Transfers a specified amount of ERC20 tokens from one account to another.
+     *
+     * @description
+     * This function interacts with the blockchain network to transfer a specified amount of ERC20 tokens from one account to another.
+     * For this transfer to work the spender ( account that will trigger this function ) need to have the value approved as an allowance by the sender.
+     * It calls the "TransferFrom" transaction on the smart contract with the sender's address, recipient's address, and the transfer amount as parameters.
+     * The returned data is then decoded and checked to determine if the transfer was successful.
+     *
+     * @param from - The address of the sender.
+     * @param to - The address of the recipient.
+     * @param value - The amount of ERC20 tokens to transfer.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the transfer was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    transferFrom(from: string, to: string, value: number): Promise<boolean>;
+    /**
+     * Approves a specified amount of ERC20 tokens to be spent by a specified spender.
+     *
+     * This function interacts with the blockchain network to approve a specified amount of ERC20 tokens to be spent by a specified spender.
+     * It calls the "Approve" transaction on the smart contract with the spender's address and the approval amount as parameters.
+     * The returned data is then decoded and checked to determine if the approval was successful.
+     *
+     * @param spender - The address of the spender.
+     * @param value - The amount of ERC20 tokens to approve for the spender.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the approval was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    approve(spender: string, value: number): Promise<boolean>;
+    /**
+     * Retrieves the allowance of ERC20 tokens that the specified owner has approved for a spender.
+     *
+     * @description
+     * This function interacts with the blockchain network to fetch the allowance of ERC20 tokens that the specified owner has approved for a spender.
+     * It calls the "Allowance" transaction on the smart contract with the owner's address and the spender's address as parameters.
+     * The returned data is then decoded and converted to a number.
+     *
+     * @param owner - The address of the ERC20 token owner.
+     * @param spender - The address of the spender.
+     *
+     * @returns {Promise<number>} A promise that resolves with the allowance of ERC20 tokens that the specified owner has approved for the spender.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    allowance(owner: string, spender: string): Promise<number>;
+    /**
+     * Initializes the ERC20 contract with the provided token information.
+     *
+     * @description
+     * This function interacts with the blockchain network to initialize the ERC20 contract with the given token information.
+     * It calls the "Initialize" transaction on the smart contract with the serialized token data as a parameter.
+     * The returned data is then decoded and checked to determine if the initialization was successful.
+     *
+     * @param token - The ERC20 token information to initialize the contract with.
+     *
+     * @returns {Promise<boolean>} A promise that resolves with `true` if the initialization was successful, and `false` otherwise.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    initialize(token: ERC20Token): Promise<boolean>;
+    /**
+     * Checks if the ERC20 contract has been initialized.
+     *
+     * This function interacts with the blockchain network to verify if the ERC20 contract has been initialized.
+     * It calls the "CheckInitialized" transaction on the smart contract, which does not require any parameters.
+     *
+     * @returns {Promise<void>} A promise that resolves when the initialization check is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    checkInitialized(): Promise<void>;
+    /**
+     * Mints a specified amount of ERC20 tokens.
+     *
+     * @description
+     * This function interacts with the blockchain network to mint a specified amount of ERC20 tokens.
+     * It calls the "Mint" transaction on the smart contract with the minting amount as a parameter.
+     * The function does not return any value, but it updates the minter's number of tokens.
+     *
+     * @param amount - The amount of ERC20 tokens to mint.
+     *
+     * @returns {Promise<void>} A promise that resolves when the minting process is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    mint(amount: number): Promise<void>;
+    /**
+     * Burns a specified amount of ERC20 tokens from the minter's account.
+     *
+     * This function interacts with the blockchain network to burn a specified amount of ERC20 tokens.
+     * It calls the "Burn" transaction on the smart contract with the burning amount as a parameter.
+     * The function does not return any value, but it decreases the minter's number of tokens.
+     *
+     * @param amount - The amount of ERC20 tokens to burn.
+     *
+     * @returns {Promise<void>} A promise that resolves when the burning process is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    burn(amount: number): Promise<void>;
+    /**
+     * Burns a specified amount of ERC20 tokens from a specified account.
+     *
+     * This function interacts with the blockchain network to burn a specified amount of ERC20 tokens from a given account.
+     * It calls the "BurnFrom" transaction on the smart contract with the account's address and the burning amount as parameters.
+     * The function does not return any value, but it decreases the specified account's number of tokens.
+     *
+     * @param account - The address of the account from which to burn the ERC20 tokens.
+     * @param amount - The amount of ERC20 tokens to burn.
+     *
+     * @returns {Promise<void>} A promise that resolves when the burning process is completed.
+     *
+     * @throws {Error} If the transaction fails.
+     */
+    burnFrom(account: string, amount: number): Promise<void>;
+    /**
+     * Retrieves the balance of ERC20 tokens associated with the client's account.
+     *
+     * This function interacts with the blockchain network to fetch the balance of ERC20 tokens associated with the client's account.
+     * It calls the "ClientAccountBalance" transaction on the smart contract, which does not require any parameters.
+     * The returned data is then decoded and converted to a number.
+     *
+     * @returns {Promise<number>} A promise that resolves with the balance of ERC20 tokens associated with the client's account.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    clientAccountBalance(): Promise<number>;
+    /**
+     * Retrieves the client's account ID from the blockchain network.
+     *
+     * This function interacts with the blockchain network to fetch the client's account ID.
+     * It calls the "ClientAccountID" transaction on the smart contract, which does not require any parameters.
+     * The returned data is then decoded and returned as a string.
+     *
+     * @returns {Promise<string>} A promise that resolves with the client's account ID.
+     *
+     * @throws {Error} If the transaction fails or the decoding process fails.
+     */
+    clientAccountID(): Promise<string>;
+}

package/lib/types/client/erc20/index.d.cts

@@ -0,0 +1 @@
+export * from "./FabricERC20ClientRepository.cjs";

package/lib/types/client/erc20/index.d.mts

@@ -0,0 +1 @@
+export * from "./FabricERC20ClientRepository.js";

package/lib/types/client/fabric-fs.d.cts

@@ -0,0 +1,92 @@
+import { User } from "fabric-common";
+import { Identity, Signer } from "@hyperledger/fabric-gateway";
+/**
+ * @description Loads content from a file or returns the content if already loaded
+ * @summary Determines if the input is already content or a path to a file, and loads the file if needed
+ * @param {string | Uint8Array} contentOrPath - The content or path to load
+ * @param {Function} fileReader - Function to read the file if contentOrPath is a path
+ * @return {Promise<string | Uint8Array | Buffer>} The content
+ * @function contentOfLoadFile
+ * @memberOf module:for-fabric.client
+ */
+export declare function contentOfLoadFile(contentOrPath: string | Uint8Array, fileReader: (path: string) => Promise<string | Uint8Array | Buffer>): Promise<string | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>;
+/**
+ * @description Reads a file from the file system
+ * @summary Loads a file using the Node.js file system module
+ * @param {string | Buffer} contentOrPath - The content or path to load
+ * @return {Promise<Buffer>} The file content as a Buffer
+ * @function readFile
+ * @memberOf module:for-fabric.client
+ */
+export declare function readFile(contentOrPath: string | Buffer): Promise<Buffer<ArrayBufferLike>>;
+/**
+ * @description Creates a Certificate Authority user
+ * @summary Initializes a user with the given credentials for interacting with a Fabric CA
+ * @param {string} userName - The user name
+ * @param {string} privateKey - The private key as a string
+ * @param {string} certificate - The certificate as a string
+ * @param {string} mspId - The Membership Service Provider ID
+ * @return {Promise<User>} Promise resolving to the created user
+ * @function getCAUser
+ * @memberOf module:for-fabric.client
+ */
+export declare function getCAUser(userName: string, privateKey: string, certificate: string, mspId: string): Promise<User>;
+/**
+ * @description Gets an identity from a certificate directory
+ * @summary Loads a certificate from a directory and creates an Identity object
+ * @param {string} mspId - The Membership Service Provider ID
+ * @param {string} certDirectoryPath - Path to the directory containing the certificate
+ * @return {Promise<Identity>} Promise resolving to the identity
+ * @function getIdentity
+ * @memberOf module:for-fabric.client
+ */
+export declare function getIdentity(mspId: string, certDirectoryPath: string): Promise<Identity>;
+/**
+ * @description Gets the full path of the first file in a directory
+ * @summary Reads a directory and returns the path to the first file found
+ * @param {string} dirPath - Path to the directory
+ * @return {Promise<string>} Promise resolving to the full path of the first file
+ * @function getFirstDirFileName
+ * @memberOf module:for-fabric.client
+ */
+export declare function getFirstDirFileName(dirPath: string): Promise<string>;
+/**
+ * @description Gets the content of the first file in a directory
+ * @summary Reads a directory, finds the first file, and returns its content as a string
+ * @param {string} dirPath - Path to the directory
+ * @return {Promise<string>} Promise resolving to the content of the first file
+ * @function getFirstDirFileNameContent
+ * @memberOf module:for-fabric.client
+ */
+export declare function getFirstDirFileNameContent(dirPath: string): Promise<string>;
+/**
+ * @description Gets a signer from a key directory
+ * @summary Loads a private key from a directory and creates a Signer for Fabric transactions
+ * @param {string} keyDirectoryPath - Path to the directory containing the private key
+ * @return {Promise<Signer>} Promise resolving to the signer
+ * @function getSigner
+ * @memberOf module:for-fabric.client
+ */
+export declare function getSigner(keyDirectoryPath: string): Promise<Signer>;
+/**
+ * @description Extracts a private key from a PEM buffer
+ * @summary Converts a PEM-encoded private key to a CryptoKey object
+ * @param {Buffer} pem - The PEM-encoded private key
+ * @return {Promise<CryptoKey>} Promise resolving to the CryptoKey
+ * @function extractPrivateKey
+ * @memberOf module:for-fabric.client
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant ExtractPrivateKey
+ *   participant SubtleCrypto
+ *
+ *   Caller->>ExtractPrivateKey: extractPrivateKey(pem)
+ *   ExtractPrivateKey->>ExtractPrivateKey: Get SubtleCrypto implementation
+ *   ExtractPrivateKey->>ExtractPrivateKey: Parse PEM format
+ *   ExtractPrivateKey->>ExtractPrivateKey: Convert to binary DER
+ *   ExtractPrivateKey->>SubtleCrypto: importKey(pkcs8, binaryDer, options)
+ *   SubtleCrypto-->>ExtractPrivateKey: CryptoKey
+ *   ExtractPrivateKey-->>Caller: CryptoKey
+ */
+export declare function extractPrivateKey(pem: Buffer): Promise<any>;