@decaf-ts/for-fabric 0.0.2

package/lib/contracts/erc20/erc20contract.d.ts

@@ -0,0 +1,151 @@
+import { Context } from "fabric-contract-api";
+import { Allowance, ERC20Token, ERC20Wallet } from "./models";
+import { FabricCrudContract } from "../crud/crud-contract";
+/**
+ * @description ERC20 token contract base for Hyperledger Fabric
+ * @summary Implements ERC20-like token logic using repositories and adapters, providing standard token operations such as balance queries, transfers, approvals, minting and burning.
+ * @param {string} name - The contract name used to scope token identity
+ * @note https://eips.ethereum.org/EIPS/eip-20
+ * @return {void}
+ * @class FabricERC20Contract
+ * @example
+ * class MyTokenContract extends FabricERC20Contract {
+ *   constructor() { super('MyToken'); }
+ * }
+ * // The contract exposes methods like Transfer, Approve, Mint, Burn, etc.
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant Contract
+ *   participant WalletRepo
+ *   participant TokenRepo
+ *   participant Ledger
+ *   Client->>Contract: Transfer(ctx, to, value)
+ *   Contract->>WalletRepo: read(from)
+ *   Contract->>WalletRepo: read(to)
+ *   Contract->>Ledger: putState(updated balances)
+ *   Contract-->>Client: success
+ */
+export declare abstract class FabricERC20Contract extends FabricCrudContract<ERC20Wallet> {
+    private walletRepository;
+    private tokenRepository;
+    private allowanceRepository;
+    protected constructor(name: string);
+    TokenName(ctx: Context): Promise<string>;
+    /**
+     * Return the symbol of the token. E.g. “HIX”.
+     *
+     * @param {Context} ctx the transaction context
+     * @returns {String} Returns the symbol of the token
+     */
+    Symbol(ctx: Context): Promise<string>;
+    /**
+     * Return the number of decimals the token uses
+     * e.g. 8, means to divide the token amount by 100000000 to get its user representation.
+     *
+     * @param {Context} ctx the transaction context
+     * @returns {Number} Returns the number of decimals
+     */
+    Decimals(ctx: Context): Promise<number>;
+    /**
+     * Return the total token supply.
+     *
+     * @param {Context} ctx the transaction context
+     * @returns {Number} Returns the total token supply
+     */
+    TotalSupply(ctx: Context): Promise<number>;
+    /**
+     * BalanceOf returns the balance of the given account.
+     *
+     * @param {Context} ctx the transaction context
+     * @param {String} owner The owner from which the balance will be retrieved
+     * @returns {Number} Returns the account balance
+     */
+    BalanceOf(ctx: Context, owner: string): Promise<number>;
+    /**
+     * @summary Transfer transfers tokens from client account to recipient account.
+     * @description recipient account must be a valid clientID as returned by the ClientAccountID() function.
+     *
+     * @param {Context} ctx the transaction context
+     * @param {String} to The recipient
+     * @param {number} value The amount of token to be transferred
+     *
+     * @returns {Boolean} Return whether the transfer was successful or not
+     */
+    Transfer(ctx: Context, to: string, value: number): Promise<boolean>;
+    /**
+     * Transfer `value` amount of tokens from `from` to `to`.
+     *
+     * @param {Context} ctx the transaction context
+     * @param {String} from The sender
+     * @param {String} to The recipient
+     * @param {number} value The amount of token to be transferred
+     * @returns {Boolean} Return whether the transfer was successful or not
+     */
+    TransferFrom(ctx: Context, from: string, to: string, value: number): Promise<boolean>;
+    _transfer(ctx: Context, from: string, to: string, value: number): Promise<boolean>;
+    /**
+     * Allows `spender` to spend `value` amount of tokens from the owner. New Approve calls override the previous allowance.
+     * @note https://eips.ethereum.org/EIPS/eip-20
+     *
+     * @param {Context} ctx the transaction context
+     * @param {String} spender The spender
+     * @param {number} value The amount of tokens to be approved for transfer
+     * @returns {Boolean} Return whether the approval was successful or not
+     */
+    Approve(ctx: Context, spender: string, value: number): Promise<boolean>;
+    /**
+     * Returns the amount of tokens which ` ` is allowed to withdraw from `owner`.
+     *
+     * @param {Context} ctx the transaction context
+     * @param {String} owner The owner of tokens
+     * @param {String} spender The spender who are able to transfer the tokens
+     * @returns {number} Return the amount of remaining tokens allowed to spent
+     */
+    Allowance(ctx: Context, owner: string, spender: string): Promise<number>;
+    _getAllowance(ctx: Context, owner: string, spender: string): Promise<Allowance>;
+    /**
+     * Set optional infomation for a token.
+     *
+     * @param {Context} ctx the transaction context
+     * @param {String} name The name of the token
+     * @param {String} symbol The symbol of the token
+     * @param {String} decimals The decimals of the token
+     * @param {String} totalSupply The totalSupply of the token
+     */
+    Initialize(ctx: Context, token: ERC20Token): Promise<boolean>;
+    CheckInitialized(ctx: Context): Promise<void>;
+    /**
+     * Mint creates new tokens and adds them to minter's account balance
+     *
+     * @param {Context} ctx the transaction context
+     * @param {number} amount amount of tokens to be minted
+     * @returns {Object} The balance
+     */
+    Mint(ctx: Context, amount: number): Promise<void>;
+    /**
+     * Burn redeem tokens from minter's account balance
+     *
+     * @param {Context} ctx the transaction context
+     * @param {number} amount amount of tokens to be burned
+     * @returns {Object} The balance
+     */
+    Burn(ctx: Context, amount: number): Promise<void>;
+    /**
+     * BurnFrom redeem tokens from account allowence and balance
+     *
+     * @param {Context} ctx the transaction context
+     * @param {number} account account from where tokens will be burned
+     * @param {number} amount amount of tokens to be burned
+     * @returns {Object} The balance
+     */
+    BurnFrom(ctx: Context, account: string, amount: number): Promise<void>;
+    /**
+     * ClientAccountBalance returns the balance of the requesting client's account.
+     *
+     * @param {Context} ctx the transaction context
+     * @returns {Number} Returns the account balance
+     */
+    ClientAccountBalance(ctx: Context): Promise<number>;
+    ClientAccountID(ctx: Context): Promise<string>;
+}

package/lib/contracts/erc20/index.cjs

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contracts = void 0;
+const erc20contract_1 = require("./erc20contract.cjs");
+__exportStar(require("./../FabricContractStatement.cjs"), exports);
+exports.contracts = [erc20contract_1.FabricERC20Contract];
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29udHJhY3RzL2VyYzIwL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsdURBQXNEO0FBRXRELG1FQUEyQztBQUU5QixRQUFBLFNBQVMsR0FBVSxDQUFDLG1DQUFtQixDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBGYWJyaWNFUkMyMENvbnRyYWN0IH0gZnJvbSBcIi4vZXJjMjBjb250cmFjdFwiO1xuXG5leHBvcnQgKiBmcm9tIFwiLi4vRmFicmljQ29udHJhY3RTdGF0ZW1lbnRcIjtcblxuZXhwb3J0IGNvbnN0IGNvbnRyYWN0czogYW55W10gPSBbRmFicmljRVJDMjBDb250cmFjdF07XG4iXX0=

package/lib/contracts/erc20/index.d.ts

@@ -0,0 +1,2 @@
+export * from "../FabricContractStatement";
+export declare const contracts: any[];

package/lib/contracts/erc20/models.cjs

@@ -0,0 +1,209 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Allowance = exports.ERC20Wallet = exports.ERC20Token = void 0;
+const core_1 = require("@decaf-ts/core");
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+/**
+ * @description ERC20 token metadata model
+ * @summary Represents an ERC20 token definition within the Fabric ERC20 sample, including name, symbol, decimals, and the owning identity. Used to define the unique token managed by the contract.
+ * @param {ModelArg<ERC20Token>} [m] - Optional partial data or another instance to initialize the model
+ * @return {void}
+ * @class ERC20Token
+ * @example
+ * const token = new ERC20Token({ name: "MyToken", symbol: "MTK", decimals: 18, owner: "x509::..." });
+ * // Persist through a repository: await repo.create(token, ctx)
+ * @mermaid
+ * sequenceDiagram
+ *   participant App
+ *   participant Repo
+ *   participant Adapter
+ *   App->>Repo: create(new ERC20Token({...}), ctx)
+ *   Repo->>Adapter: create(table, id=name, record, flags)
+ *   Adapter-->>Repo: stored
+ *   Repo-->>App: model
+ */
+let ERC20Token = class ERC20Token extends core_1.BaseModel {
+    constructor(m) {
+        super(m);
+    }
+};
+exports.ERC20Token = ERC20Token;
+__decorate([
+    (0, core_1.pk)({ type: "String" })
+    /**
+     * @description Token unique name
+     * @summary Serves as the primary key for the ERC20 token definition; typically a human-readable identifier
+     */
+    ,
+    __metadata("design:type", String)
+], ERC20Token.prototype, "name", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Owning identity of the token
+     * @summary X.509 subject or MSP identity string that denotes who owns/controls the token definition
+     */
+    ,
+    __metadata("design:type", String)
+], ERC20Token.prototype, "owner", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Token symbol
+     * @summary Short ticker-like symbol used to represent the token (e.g., MTK)
+     */
+    ,
+    __metadata("design:type", String)
+], ERC20Token.prototype, "symbol", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Decimal precision for token amounts
+     * @summary Number of digits after the decimal separator used when formatting token balances
+     */
+    ,
+    __metadata("design:type", Number)
+], ERC20Token.prototype, "decimals", void 0);
+exports.ERC20Token = ERC20Token = __decorate([
+    (0, core_1.table)("erc20_tokens"),
+    (0, decorator_validation_1.model)(),
+    __metadata("design:paramtypes", [Object])
+], ERC20Token);
+/**
+ * @description ERC20 wallet model
+ * @summary Represents a holder account for an ERC20 token within the Fabric network, tracking balance and token association.
+ * @param {ModelArg<ERC20Wallet>} [m] - Optional partial data or another instance to initialize the model
+ * @return {void}
+ * @class ERC20Wallet
+ * @example
+ * const wallet = new ERC20Wallet({ id: "acct1", token: "MyToken", balance: 1000 });
+ * // Update balance via repository: await repo.update(wallet, ctx)
+ * @mermaid
+ * sequenceDiagram
+ *   participant App
+ *   participant Repo
+ *   App->>Repo: read("acct1", ctx)
+ *   Repo-->>App: ERC20Wallet
+ */
+let ERC20Wallet = class ERC20Wallet extends core_1.BaseModel {
+    constructor(m) {
+        super(m);
+    }
+};
+exports.ERC20Wallet = ERC20Wallet;
+__decorate([
+    (0, core_1.pk)({ type: "String" })
+    /**
+     * @description Wallet unique identifier
+     * @summary Primary key for the wallet; commonly references an account or identity
+     */
+    ,
+    __metadata("design:type", String)
+], ERC20Wallet.prototype, "id", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Associated token name
+     * @summary References the ERC20Token this wallet holds; maintained as a relationship for cascading updates/deletes
+     */
+    ,
+    __metadata("design:type", String)
+], ERC20Wallet.prototype, "token", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Token balance for this wallet
+     * @summary Current amount of the associated token held by this wallet
+     */
+    ,
+    __metadata("design:type", Number)
+], ERC20Wallet.prototype, "balance", void 0);
+__decorate([
+    (0, core_1.column)()
+    /**
+     * @description Captive flag or identifier
+     * @summary Optional field used by some flows to mark non-transferable funds or managed custody
+     */
+    ,
+    __metadata("design:type", String)
+], ERC20Wallet.prototype, "captive", void 0);
+exports.ERC20Wallet = ERC20Wallet = __decorate([
+    (0, core_1.table)("erc20_wallets"),
+    (0, decorator_validation_1.model)(),
+    __metadata("design:paramtypes", [Object])
+], ERC20Wallet);
+/**
+ * @description ERC20 allowance model
+ * @summary Captures an approval relationship where an owner allows a spender to transfer up to a certain value from the owner's wallet.
+ * @param {ModelArg<Allowance>} [m] - Optional partial data or another instance to initialize the model
+ * @return {void}
+ * @class Allowance
+ * @example
+ * const allowance = new Allowance({ owner: "acct1", spender: "acct2", value: 50 });
+ * @mermaid
+ * sequenceDiagram
+ *   participant App
+ *   App->>App: new Allowance({ owner, spender, value })
+ */
+let Allowance = class Allowance extends core_1.BaseModel {
+    constructor(m) {
+        super(m);
+    }
+};
+exports.Allowance = Allowance;
+__decorate([
+    (0, core_1.pk)({ type: "String" })
+    /**
+     * @description Allowance unique identifier
+     * @summary Primary key for the allowance; typically a unique identifier for the approval relationship
+     */
+    ,
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Owner wallet identifier
+     * @summary Wallet that authorizes the allowance
+     */
+    ,
+    __metadata("design:type", String)
+], Allowance.prototype, "owner", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Spender wallet identifier
+     * @summary Wallet allowed to spend up to the approved value from the owner
+     */
+    ,
+    __metadata("design:type", String)
+], Allowance.prototype, "spender", void 0);
+__decorate([
+    (0, core_1.column)(),
+    (0, decorator_validation_1.required)()
+    /**
+     * @description Approved value
+     * @summary Maximum token amount the spender may transfer on behalf of the owner
+     */
+    ,
+    __metadata("design:type", Number)
+], Allowance.prototype, "value", void 0);
+exports.Allowance = Allowance = __decorate([
+    (0, core_1.table)("erc20_allowances"),
+    (0, decorator_validation_1.model)(),
+    __metadata("design:paramtypes", [Object])
+], Allowance);
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/contracts/erc20/models.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAA8D;AAC9D,yEAAgF;AAEhF;;;;;;;;;;;;;;;;;;GAkBG;AAGI,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,gBAAS;IA8BvC,YAAY,CAAyB;QACnC,KAAK,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;CACF,CAAA;AAjCY,gCAAU;AAMrB;IALC,IAAA,SAAE,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IACvB;;;OAGG;;;wCACW;AAQd;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;yCACY;AAOf;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;0CACa;AAOhB;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;4CACe;qBA5BP,UAAU;IAFtB,IAAA,YAAK,EAAC,cAAc,CAAC;IACrB,IAAA,4BAAK,GAAE;;GACK,UAAU,CAiCtB;AAED;;;;;;;;;;;;;;;GAeG;AAGI,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,gBAAS;IA+BxC,YAAY,CAAyB;QACnC,KAAK,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;CACF,CAAA;AAlCY,kCAAW;AAMtB;IALC,IAAA,SAAE,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IACvB;;;OAGG;;;uCACS;AAQZ;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;0CACY;AAQf;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;4CACc;AAOjB;IALC,IAAA,aAAM,GAAE;IACT;;;OAGG;;;4CACc;sBA7BN,WAAW;IAFvB,IAAA,YAAK,EAAC,eAAe,CAAC;IACtB,IAAA,4BAAK,GAAE;;GACK,WAAW,CAkCvB;AAED;;;;;;;;;;;;GAYG;AAGI,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,gBAAS;IA8BtC,YAAY,CAAuB;QACjC,KAAK,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;CACF,CAAA;AAjCY,8BAAS;AAYpB;IAXC,IAAA,SAAE,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IACvB;;;OAGG;;IACF,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;wCACY;AAQf;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;0CACc;AAQjB;IANC,IAAA,aAAM,GAAE;IACR,IAAA,+BAAQ,GAAE;IACX;;;OAGG;;;wCACY;oBA5BJ,SAAS;IAFrB,IAAA,YAAK,EAAC,kBAAkB,CAAC;IACzB,IAAA,4BAAK,GAAE;;GACK,SAAS,CAiCrB","sourcesContent":["import { BaseModel, column, pk, table } from \"@decaf-ts/core\";\nimport { model, type ModelArg, required } from \"@decaf-ts/decorator-validation\";\n\n/**\n * @description ERC20 token metadata model\n * @summary Represents an ERC20 token definition within the Fabric ERC20 sample, including name, symbol, decimals, and the owning identity. Used to define the unique token managed by the contract.\n * @param {ModelArg<ERC20Token>} [m] - Optional partial data or another instance to initialize the model\n * @return {void}\n * @class ERC20Token\n * @example\n * const token = new ERC20Token({ name: \"MyToken\", symbol: \"MTK\", decimals: 18, owner: \"x509::...\" });\n * // Persist through a repository: await repo.create(token, ctx)\n * @mermaid\n * sequenceDiagram\n *   participant App\n *   participant Repo\n *   participant Adapter\n *   App->>Repo: create(new ERC20Token({...}), ctx)\n *   Repo->>Adapter: create(table, id=name, record, flags)\n *   Adapter-->>Repo: stored\n *   Repo-->>App: model\n */\n@table(\"erc20_tokens\")\n@model()\nexport class ERC20Token extends BaseModel {\n  @pk({ type: \"String\" })\n  /**\n   * @description Token unique name\n   * @summary Serves as the primary key for the ERC20 token definition; typically a human-readable identifier\n   */\n  name!: string;\n\n  @column()\n  @required()\n  /**\n   * @description Owning identity of the token\n   * @summary X.509 subject or MSP identity string that denotes who owns/controls the token definition\n   */\n  owner!: string;\n  @column()\n  @required()\n  /**\n   * @description Token symbol\n   * @summary Short ticker-like symbol used to represent the token (e.g., MTK)\n   */\n  symbol!: string;\n  @column()\n  @required()\n  /**\n   * @description Decimal precision for token amounts\n   * @summary Number of digits after the decimal separator used when formatting token balances\n   */\n  decimals!: number;\n\n  constructor(m?: ModelArg<ERC20Wallet>) {\n    super(m);\n  }\n}\n\n/**\n * @description ERC20 wallet model\n * @summary Represents a holder account for an ERC20 token within the Fabric network, tracking balance and token association.\n * @param {ModelArg<ERC20Wallet>} [m] - Optional partial data or another instance to initialize the model\n * @return {void}\n * @class ERC20Wallet\n * @example\n * const wallet = new ERC20Wallet({ id: \"acct1\", token: \"MyToken\", balance: 1000 });\n * // Update balance via repository: await repo.update(wallet, ctx)\n * @mermaid\n * sequenceDiagram\n *   participant App\n *   participant Repo\n *   App->>Repo: read(\"acct1\", ctx)\n *   Repo-->>App: ERC20Wallet\n */\n@table(\"erc20_wallets\")\n@model()\nexport class ERC20Wallet extends BaseModel {\n  @pk({ type: \"String\" })\n  /**\n   * @description Wallet unique identifier\n   * @summary Primary key for the wallet; commonly references an account or identity\n   */\n  id!: string;\n\n  @column()\n  @required()\n  /**\n   * @description Associated token name\n   * @summary References the ERC20Token this wallet holds; maintained as a relationship for cascading updates/deletes\n   */\n  token!: string;\n\n  @column()\n  @required()\n  /**\n   * @description Token balance for this wallet\n   * @summary Current amount of the associated token held by this wallet\n   */\n  balance!: number;\n\n  @column()\n  /**\n   * @description Captive flag or identifier\n   * @summary Optional field used by some flows to mark non-transferable funds or managed custody\n   */\n  captive!: string;\n\n  constructor(m?: ModelArg<ERC20Wallet>) {\n    super(m);\n  }\n}\n\n/**\n * @description ERC20 allowance model\n * @summary Captures an approval relationship where an owner allows a spender to transfer up to a certain value from the owner's wallet.\n * @param {ModelArg<Allowance>} [m] - Optional partial data or another instance to initialize the model\n * @return {void}\n * @class Allowance\n * @example\n * const allowance = new Allowance({ owner: \"acct1\", spender: \"acct2\", value: 50 });\n * @mermaid\n * sequenceDiagram\n *   participant App\n *   App->>App: new Allowance({ owner, spender, value })\n */\n@table(\"erc20_allowances\")\n@model()\nexport class Allowance extends BaseModel {\n  @pk({ type: \"String\" })\n  /**\n   * @description Allowance unique identifier\n   * @summary Primary key for the allowance; typically a unique identifier for the approval relationship\n   */\n  @column()\n  @required()\n  /**\n   * @description Owner wallet identifier\n   * @summary Wallet that authorizes the allowance\n   */\n  owner!: string;\n\n  @column()\n  @required()\n  /**\n   * @description Spender wallet identifier\n   * @summary Wallet allowed to spend up to the approved value from the owner\n   */\n  spender!: string;\n\n  @column()\n  @required()\n  /**\n   * @description Approved value\n   * @summary Maximum token amount the spender may transfer on behalf of the owner\n   */\n  value!: number;\n\n  constructor(m?: ModelArg<Allowance>) {\n    super(m);\n  }\n}\n"]}

package/lib/contracts/erc20/models.d.ts

@@ -0,0 +1,114 @@
+import { BaseModel } from "@decaf-ts/core";
+import { type ModelArg } from "@decaf-ts/decorator-validation";
+/**
+ * @description ERC20 token metadata model
+ * @summary Represents an ERC20 token definition within the Fabric ERC20 sample, including name, symbol, decimals, and the owning identity. Used to define the unique token managed by the contract.
+ * @param {ModelArg<ERC20Token>} [m] - Optional partial data or another instance to initialize the model
+ * @return {void}
+ * @class ERC20Token
+ * @example
+ * const token = new ERC20Token({ name: "MyToken", symbol: "MTK", decimals: 18, owner: "x509::..." });
+ * // Persist through a repository: await repo.create(token, ctx)
+ * @mermaid
+ * sequenceDiagram
+ *   participant App
+ *   participant Repo
+ *   participant Adapter
+ *   App->>Repo: create(new ERC20Token({...}), ctx)
+ *   Repo->>Adapter: create(table, id=name, record, flags)
+ *   Adapter-->>Repo: stored
+ *   Repo-->>App: model
+ */
+export declare class ERC20Token extends BaseModel {
+    /**
+     * @description Token unique name
+     * @summary Serves as the primary key for the ERC20 token definition; typically a human-readable identifier
+     */
+    name: string;
+    /**
+     * @description Owning identity of the token
+     * @summary X.509 subject or MSP identity string that denotes who owns/controls the token definition
+     */
+    owner: string;
+    /**
+     * @description Token symbol
+     * @summary Short ticker-like symbol used to represent the token (e.g., MTK)
+     */
+    symbol: string;
+    /**
+     * @description Decimal precision for token amounts
+     * @summary Number of digits after the decimal separator used when formatting token balances
+     */
+    decimals: number;
+    constructor(m?: ModelArg<ERC20Wallet>);
+}
+/**
+ * @description ERC20 wallet model
+ * @summary Represents a holder account for an ERC20 token within the Fabric network, tracking balance and token association.
+ * @param {ModelArg<ERC20Wallet>} [m] - Optional partial data or another instance to initialize the model
+ * @return {void}
+ * @class ERC20Wallet
+ * @example
+ * const wallet = new ERC20Wallet({ id: "acct1", token: "MyToken", balance: 1000 });
+ * // Update balance via repository: await repo.update(wallet, ctx)
+ * @mermaid
+ * sequenceDiagram
+ *   participant App
+ *   participant Repo
+ *   App->>Repo: read("acct1", ctx)
+ *   Repo-->>App: ERC20Wallet
+ */
+export declare class ERC20Wallet extends BaseModel {
+    /**
+     * @description Wallet unique identifier
+     * @summary Primary key for the wallet; commonly references an account or identity
+     */
+    id: string;
+    /**
+     * @description Associated token name
+     * @summary References the ERC20Token this wallet holds; maintained as a relationship for cascading updates/deletes
+     */
+    token: string;
+    /**
+     * @description Token balance for this wallet
+     * @summary Current amount of the associated token held by this wallet
+     */
+    balance: number;
+    /**
+     * @description Captive flag or identifier
+     * @summary Optional field used by some flows to mark non-transferable funds or managed custody
+     */
+    captive: string;
+    constructor(m?: ModelArg<ERC20Wallet>);
+}
+/**
+ * @description ERC20 allowance model
+ * @summary Captures an approval relationship where an owner allows a spender to transfer up to a certain value from the owner's wallet.
+ * @param {ModelArg<Allowance>} [m] - Optional partial data or another instance to initialize the model
+ * @return {void}
+ * @class Allowance
+ * @example
+ * const allowance = new Allowance({ owner: "acct1", spender: "acct2", value: 50 });
+ * @mermaid
+ * sequenceDiagram
+ *   participant App
+ *   App->>App: new Allowance({ owner, spender, value })
+ */
+export declare class Allowance extends BaseModel {
+    /**
+     * @description Owner wallet identifier
+     * @summary Wallet that authorizes the allowance
+     */
+    owner: string;
+    /**
+     * @description Spender wallet identifier
+     * @summary Wallet allowed to spend up to the approved value from the owner
+     */
+    spender: string;
+    /**
+     * @description Approved value
+     * @summary Maximum token amount the spender may transfer on behalf of the owner
+     */
+    value: number;
+    constructor(m?: ModelArg<Allowance>);
+}

package/lib/contracts/index.cjs

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * @description Contracts submodule for Hyperledger Fabric integration
+ * @summary Aggregates chaincode-side building blocks including repositories, sequences, adapters, and ERC20 helpers. This entrypoint re-exports contract-related elements such as {@link FabricContractRepository}, {@link FabricContractSequence}, and CRUD/ERC20 utilities for composing Fabric contracts.
+ * @namespace contracts
+ * @memberOf module:for-fabric
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./crud/index.cjs"), exports);
+__exportStar(require("./erc20/index.cjs"), exports);
+__exportStar(require("./ContractAdapter.cjs"), exports);
+__exportStar(require("./ContractContext.cjs"), exports);
+__exportStar(require("./FabricContractRepository.cjs"), exports);
+__exportStar(require("./FabricContractRepositoryObservableHandler.cjs"), exports);
+__exportStar(require("./FabricContractSequence.cjs"), exports);
+__exportStar(require("./logging.cjs"), exports);
+__exportStar(require("./types.cjs"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3RzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTs7Ozs7R0FLRzs7Ozs7Ozs7Ozs7Ozs7OztBQUVILG1EQUF1QjtBQUN2QixvREFBd0I7QUFDeEIsd0RBQWtDO0FBQ2xDLHdEQUFrQztBQUNsQyxpRUFBMkM7QUFDM0Msa0ZBQTREO0FBQzVELCtEQUF5QztBQUN6QyxnREFBMEI7QUFDMUIsOENBQXdCIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gQ29udHJhY3RzIHN1Ym1vZHVsZSBmb3IgSHlwZXJsZWRnZXIgRmFicmljIGludGVncmF0aW9uXG4gKiBAc3VtbWFyeSBBZ2dyZWdhdGVzIGNoYWluY29kZS1zaWRlIGJ1aWxkaW5nIGJsb2NrcyBpbmNsdWRpbmcgcmVwb3NpdG9yaWVzLCBzZXF1ZW5jZXMsIGFkYXB0ZXJzLCBhbmQgRVJDMjAgaGVscGVycy4gVGhpcyBlbnRyeXBvaW50IHJlLWV4cG9ydHMgY29udHJhY3QtcmVsYXRlZCBlbGVtZW50cyBzdWNoIGFzIHtAbGluayBGYWJyaWNDb250cmFjdFJlcG9zaXRvcnl9LCB7QGxpbmsgRmFicmljQ29udHJhY3RTZXF1ZW5jZX0sIGFuZCBDUlVEL0VSQzIwIHV0aWxpdGllcyBmb3IgY29tcG9zaW5nIEZhYnJpYyBjb250cmFjdHMuXG4gKiBAbmFtZXNwYWNlIGNvbnRyYWN0c1xuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItZmFicmljXG4gKi9cblxuZXhwb3J0ICogZnJvbSBcIi4vY3J1ZFwiO1xuZXhwb3J0ICogZnJvbSBcIi4vZXJjMjBcIjtcbmV4cG9ydCAqIGZyb20gXCIuL0NvbnRyYWN0QWRhcHRlclwiO1xuZXhwb3J0ICogZnJvbSBcIi4vQ29udHJhY3RDb250ZXh0XCI7XG5leHBvcnQgKiBmcm9tIFwiLi9GYWJyaWNDb250cmFjdFJlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL0ZhYnJpY0NvbnRyYWN0UmVwb3NpdG9yeU9ic2VydmFibGVIYW5kbGVyXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9GYWJyaWNDb250cmFjdFNlcXVlbmNlXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9sb2dnaW5nXCI7XG5leHBvcnQgKiBmcm9tIFwiLi90eXBlc1wiO1xuIl19

package/lib/contracts/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description Contracts submodule for Hyperledger Fabric integration
+ * @summary Aggregates chaincode-side building blocks including repositories, sequences, adapters, and ERC20 helpers. This entrypoint re-exports contract-related elements such as {@link FabricContractRepository}, {@link FabricContractSequence}, and CRUD/ERC20 utilities for composing Fabric contracts.
+ * @namespace contracts
+ * @memberOf module:for-fabric
+ */
+export * from "./crud";
+export * from "./erc20";
+export * from "./ContractAdapter";
+export * from "./ContractContext";
+export * from "./FabricContractRepository";
+export * from "./FabricContractRepositoryObservableHandler";
+export * from "./FabricContractSequence";
+export * from "./logging";
+export * from "./types";