@trufnetwork/sdk-js 0.2.2 → 0.3.0

package/dist/esm/contracts-api/composedAction.mjs

@@ -0,0 +1,156 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/contracts-api/composedAction.ts
+import { Utils } from "@kwilteam/kwil-js";
+import { EthereumAddress } from "../util/EthereumAddress.mjs";
+import { StreamId } from "../util/StreamId.mjs";
+import { Action } from "./action.mjs";
+import pg from "pg";
+var DataType = Utils.DataType;
+var { Pool } = pg;
+var ErrorStreamNotComposed = "stream is not a composed stream";
+var ComposedAction = class _ComposedAction extends Action {
+  constructor(kwilClient, kwilSigner, neonConnectionString) {
+    super(kwilClient, kwilSigner);
+    __publicField(this, "neonConnectionString");
+    this.neonConnectionString = neonConnectionString;
+  }
+  /**
+   * Returns the taxonomy of the stream
+   * @param params Parameters for describing taxonomies
+   * @returns A promise that resolves to the taxonomy
+   */
+  async describeTaxonomies(params) {
+    const result = await this.call(
+      "describe_taxonomies",
+      {
+        $data_provider: params.stream.dataProvider.getAddress(),
+        $stream_id: params.stream.streamId.getId(),
+        $latest_group_sequence: params.latestGroupSequence
+      }
+    );
+    return result.mapRight((records) => {
+      const taxonomyItems = records.reduce(
+        (acc, record) => {
+          const currentArray = acc.get(record.start_date.toString()) || [];
+          currentArray.push({
+            childStream: {
+              streamId: StreamId.fromString(record.child_stream_id).throw(),
+              dataProvider: EthereumAddress.fromString(
+                record.child_data_provider
+              ).throw()
+            },
+            weight: record.weight
+          });
+          acc.set(record.start_date.toString(), currentArray);
+          return acc;
+        },
+        /* @__PURE__ */ new Map()
+      );
+      return Array.from(taxonomyItems.entries()).map(
+        ([startDate, taxonomyItems2]) => ({
+          stream: {
+            streamId: StreamId.fromString(records[0].stream_id).throw(),
+            dataProvider: EthereumAddress.fromString(
+              records[0].data_provider
+            ).throw()
+          },
+          taxonomyItems: taxonomyItems2,
+          startDate: Number(startDate)
+        })
+      );
+    }).throw();
+  }
+  /**
+   * Sets the taxonomy of the stream
+   * @param taxonomy The taxonomy to set
+   * @returns A promise that resolves to the transaction receipt
+   */
+  async setTaxonomy(taxonomy) {
+    const childDataProviders = [];
+    const childStreamIds = [];
+    const weights = [];
+    for (const item of taxonomy.taxonomyItems) {
+      childDataProviders.push(item.childStream.dataProvider.getAddress());
+      childStreamIds.push(item.childStream.streamId.getId());
+      weights.push(item.weight.toString());
+    }
+    const txHash = await this.executeWithActionBody({
+      namespace: "main",
+      name: "insert_taxonomy",
+      inputs: [
+        {
+          $data_provider: taxonomy.stream.dataProvider.getAddress(),
+          $stream_id: taxonomy.stream.streamId.getId(),
+          $child_data_providers: childDataProviders,
+          $child_stream_ids: childStreamIds,
+          $weights: weights,
+          $start_date: taxonomy.startDate
+        }
+      ],
+      types: {
+        $data_provider: DataType.Text,
+        $stream_id: DataType.Text,
+        $child_data_providers: DataType.TextArray,
+        $child_stream_ids: DataType.TextArray,
+        $weights: DataType.NumericArray(36, 18),
+        $start_date: DataType.Int
+      }
+    });
+    if (this.neonConnectionString) {
+      const pool = new Pool({ connectionString: this.neonConnectionString });
+      const parentProvider = taxonomy.stream.dataProvider.getAddress().toLowerCase();
+      const parentStreamId = taxonomy.stream.streamId.getId();
+      const startDateText = String(taxonomy.startDate);
+      for (const item of taxonomy.taxonomyItems) {
+        const childProvider = item.childStream.dataProvider.getAddress().toLowerCase();
+        const childStreamId = item.childStream.streamId.getId();
+        const weight = item.weight;
+        await pool.query(
+          `INSERT INTO taxonomies
+            (parent_data_provider, parent_stream_id,
+             child_data_provider,  child_stream_id,
+             weight, start_date)
+           VALUES ($1, $2, $3, $4, $5, $6)
+           ON CONFLICT ON CONSTRAINT unique_parent_child DO NOTHING`,
+          [
+            parentProvider,
+            parentStreamId,
+            childProvider,
+            childStreamId,
+            weight,
+            startDateText
+          ]
+        );
+      }
+      await pool.end();
+      console.log("Successfully inserted taxonomy into Explorer DB", {
+        parentStreamId,
+        childStreamId: childStreamIds,
+        weight: weights,
+        startDate: startDateText
+      });
+    }
+    return txHash;
+  }
+  /**
+   * Creates a ComposedStream from a base Stream
+   * @param stream The base stream to convert
+   * @param neonConnectionString The Neon connection string
+   * @returns A ComposedStream instance
+   */
+  static fromStream(stream, neonConnectionString) {
+    return new _ComposedAction(
+      stream["kwilClient"],
+      stream["kwilSigner"],
+      neonConnectionString
+    );
+  }
+};
+export {
+  ComposedAction,
+  ErrorStreamNotComposed
+};
+//# sourceMappingURL=composedAction.mjs.map

package/dist/esm/contracts-api/composedAction.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/contracts-api/composedAction.ts"],
+  "sourcesContent": ["import {KwilSigner, NodeKwil, Utils, WebKwil} from \"@kwilteam/kwil-js\";\nimport { GenericResponse } from \"@kwilteam/kwil-js/dist/core/resreq\";\nimport { TxReceipt } from \"@kwilteam/kwil-js/dist/core/tx\";\nimport { DateString } from \"../types/other\";\nimport { StreamLocator } from \"../types/stream\";\nimport { EthereumAddress } from \"../util/EthereumAddress\";\nimport { StreamId } from \"../util/StreamId\";\nimport { Action } from \"./action\";\nimport DataType = Utils.DataType;\nimport pg from \"pg\";\nconst { Pool } = pg;\n\nexport const ErrorStreamNotComposed = \"stream is not a composed stream\";\n\nexport interface TaxonomySet {\n  stream: StreamLocator;\n  taxonomyItems: TaxonomyItem[];\n  startDate: number;\n}\n\nexport interface TaxonomyItem {\n  childStream: StreamLocator;\n  weight: string;\n}\n\nexport interface DescribeTaxonomiesParams {\n  stream: StreamLocator;\n  /**\n   * if true, will return the latest version of the taxonomy only\n   */\n  latestGroupSequence: boolean;\n}\n\nexport class ComposedAction extends Action {\n  protected neonConnectionString: string | undefined;\n\n  constructor(\n    kwilClient: WebKwil | NodeKwil,\n    kwilSigner: KwilSigner,\n    neonConnectionString?: string,\n  ) {\n    super(kwilClient, kwilSigner);\n    this.neonConnectionString = neonConnectionString;\n  }\n\n  /**\n   * Returns the taxonomy of the stream\n   * @param params Parameters for describing taxonomies\n   * @returns A promise that resolves to the taxonomy\n   */\n  public async describeTaxonomies(\n    params: DescribeTaxonomiesParams,\n  ): Promise<TaxonomySet[]> {\n    type TaxonomyResult = {\n      data_provider: string;\n      stream_id: string;\n      child_data_provider: string;\n      child_stream_id: string;\n      weight: string;\n      created_at: number;\n      group_sequence: number;\n      start_date: number;\n    }[];\n\n    const result = await this.call<TaxonomyResult>(\n        \"describe_taxonomies\",\n        {\n            $data_provider: params.stream.dataProvider.getAddress(),\n            $stream_id: params.stream.streamId.getId(),\n            $latest_group_sequence: params.latestGroupSequence,\n        },\n    );\n\n\n\n    return result\n      .mapRight((records) => {\n        const taxonomyItems: Map<DateString, TaxonomyItem[]> = records.reduce(\n          (acc, record) => {\n            const currentArray = acc.get(record.start_date.toString()) || [];\n            currentArray.push({\n              childStream: {\n                streamId: StreamId.fromString(record.child_stream_id).throw(),\n                dataProvider: EthereumAddress.fromString(\n                  record.child_data_provider,\n                ).throw(),\n              },\n              weight: record.weight,\n            });\n            acc.set(record.start_date.toString(), currentArray);\n            return acc;\n          },\n          new Map<DateString, TaxonomyItem[]>(),\n        );\n\n        return Array.from(taxonomyItems.entries()).map(\n          ([startDate, taxonomyItems]) => ({\n            stream: {\n              streamId: StreamId.fromString(records[0].stream_id).throw(),\n              dataProvider: EthereumAddress.fromString(\n                records[0].data_provider,\n              ).throw(),\n            },\n            taxonomyItems,\n            startDate: Number(startDate)\n          }),\n        );\n      })\n      .throw();\n  }\n\n  /**\n   * Sets the taxonomy of the stream\n   * @param taxonomy The taxonomy to set\n   * @returns A promise that resolves to the transaction receipt\n   */\n  public async setTaxonomy(\n    taxonomy: TaxonomySet,\n  ): Promise<GenericResponse<TxReceipt>> {\n    const childDataProviders: string[] = [];\n    const childStreamIds: string[] = [];\n    const weights: string[] = [];\n\n    for (const item of taxonomy.taxonomyItems) {\n      childDataProviders.push(item.childStream.dataProvider\n          .getAddress());\n      childStreamIds.push(item.childStream.streamId.getId());\n      weights.push(item.weight.toString());\n    }\n\n    const txHash = await this.executeWithActionBody({\n        namespace: \"main\",\n        name: \"insert_taxonomy\",\n        inputs: [\n          {\n            $data_provider: taxonomy.stream.dataProvider.getAddress(),\n            $stream_id: taxonomy.stream.streamId.getId(),\n            $child_data_providers: childDataProviders,\n            $child_stream_ids: childStreamIds,\n            $weights: weights,\n            $start_date: taxonomy.startDate\n          },\n        ],\n        types: {\n          $data_provider: DataType.Text,\n          $stream_id: DataType.Text,\n          $child_data_providers: DataType.TextArray,\n          $child_stream_ids: DataType.TextArray,\n          $weights: DataType.NumericArray(36,18),\n          $start_date: DataType.Int\n        }});\n\n    // Optional: insert into Postgres via neon connection if a connection string is provided\n    if (this.neonConnectionString) {\n      const pool = new Pool({ connectionString: this.neonConnectionString });\n\n      // parent info comes from this.locator\n      const parentProvider = taxonomy.stream.dataProvider.getAddress().toLowerCase();\n      const parentStreamId = taxonomy.stream.streamId.getId();\n      const startDateText = String(taxonomy.startDate);\n\n      for (const item of taxonomy.taxonomyItems) {\n        const childProvider = item.childStream.dataProvider.getAddress().toLowerCase();\n        const childStreamId = item.childStream.streamId.getId();\n        const weight = item.weight;\n\n        await pool.query(\n            `INSERT INTO taxonomies\n            (parent_data_provider, parent_stream_id,\n             child_data_provider,  child_stream_id,\n             weight, start_date)\n           VALUES ($1, $2, $3, $4, $5, $6)\n           ON CONFLICT ON CONSTRAINT unique_parent_child DO NOTHING`,\n            [\n              parentProvider,\n              parentStreamId,\n              childProvider,\n              childStreamId,\n              weight,\n              startDateText,\n            ],\n        );\n      }\n\n      await pool.end();\n      console.log(\"Successfully inserted taxonomy into Explorer DB\", {\n        parentStreamId,\n        childStreamId: childStreamIds,\n        weight: weights,\n        startDate: startDateText,\n      });\n    }\n\n\n    return txHash;\n  }\n\n  /**\n   * Creates a ComposedStream from a base Stream\n   * @param stream The base stream to convert\n   * @param neonConnectionString The Neon connection string\n   * @returns A ComposedStream instance\n   */\n  public static fromStream(stream: Action, neonConnectionString?: string): ComposedAction {\n    return new ComposedAction(\n      stream[\"kwilClient\"],\n      stream[\"kwilSigner\"],\n      neonConnectionString,\n    );\n  }\n}\n"],
+  "mappings": ";;;;;AAAA,SAA8B,aAAqB;AAKnD,SAAS,uBAAuB;AAChC,SAAS,gBAAgB;AACzB,SAAS,cAAc;AAEvB,OAAO,QAAQ;AADf,IAAO,WAAW,MAAM;AAExB,IAAM,EAAE,KAAK,IAAI;AAEV,IAAM,yBAAyB;AAqB/B,IAAM,iBAAN,MAAM,wBAAuB,OAAO;AAAA,EAGzC,YACE,YACA,YACA,sBACA;AACA,UAAM,YAAY,UAAU;AAP9B,wBAAU;AAQR,SAAK,uBAAuB;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,mBACX,QACwB;AAYxB,UAAM,SAAS,MAAM,KAAK;AAAA,MACtB;AAAA,MACA;AAAA,QACI,gBAAgB,OAAO,OAAO,aAAa,WAAW;AAAA,QACtD,YAAY,OAAO,OAAO,SAAS,MAAM;AAAA,QACzC,wBAAwB,OAAO;AAAA,MACnC;AAAA,IACJ;AAIA,WAAO,OACJ,SAAS,CAAC,YAAY;AACrB,YAAM,gBAAiD,QAAQ;AAAA,QAC7D,CAAC,KAAK,WAAW;AACf,gBAAM,eAAe,IAAI,IAAI,OAAO,WAAW,SAAS,CAAC,KAAK,CAAC;AAC/D,uBAAa,KAAK;AAAA,YAChB,aAAa;AAAA,cACX,UAAU,SAAS,WAAW,OAAO,eAAe,EAAE,MAAM;AAAA,cAC5D,cAAc,gBAAgB;AAAA,gBAC5B,OAAO;AAAA,cACT,EAAE,MAAM;AAAA,YACV;AAAA,YACA,QAAQ,OAAO;AAAA,UACjB,CAAC;AACD,cAAI,IAAI,OAAO,WAAW,SAAS,GAAG,YAAY;AAClD,iBAAO;AAAA,QACT;AAAA,QACA,oBAAI,IAAgC;AAAA,MACtC;AAEA,aAAO,MAAM,KAAK,cAAc,QAAQ,CAAC,EAAE;AAAA,QACzC,CAAC,CAAC,WAAWA,cAAa,OAAO;AAAA,UAC/B,QAAQ;AAAA,YACN,UAAU,SAAS,WAAW,QAAQ,CAAC,EAAE,SAAS,EAAE,MAAM;AAAA,YAC1D,cAAc,gBAAgB;AAAA,cAC5B,QAAQ,CAAC,EAAE;AAAA,YACb,EAAE,MAAM;AAAA,UACV;AAAA,UACA,eAAAA;AAAA,UACA,WAAW,OAAO,SAAS;AAAA,QAC7B;AAAA,MACF;AAAA,IACF,CAAC,EACA,MAAM;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,YACX,UACqC;AACrC,UAAM,qBAA+B,CAAC;AACtC,UAAM,iBAA2B,CAAC;AAClC,UAAM,UAAoB,CAAC;AAE3B,eAAW,QAAQ,SAAS,eAAe;AACzC,yBAAmB,KAAK,KAAK,YAAY,aACpC,WAAW,CAAC;AACjB,qBAAe,KAAK,KAAK,YAAY,SAAS,MAAM,CAAC;AACrD,cAAQ,KAAK,KAAK,OAAO,SAAS,CAAC;AAAA,IACrC;AAEA,UAAM,SAAS,MAAM,KAAK,sBAAsB;AAAA,MAC5C,WAAW;AAAA,MACX,MAAM;AAAA,MACN,QAAQ;AAAA,QACN;AAAA,UACE,gBAAgB,SAAS,OAAO,aAAa,WAAW;AAAA,UACxD,YAAY,SAAS,OAAO,SAAS,MAAM;AAAA,UAC3C,uBAAuB;AAAA,UACvB,mBAAmB;AAAA,UACnB,UAAU;AAAA,UACV,aAAa,SAAS;AAAA,QACxB;AAAA,MACF;AAAA,MACA,OAAO;AAAA,QACL,gBAAgB,SAAS;AAAA,QACzB,YAAY,SAAS;AAAA,QACrB,uBAAuB,SAAS;AAAA,QAChC,mBAAmB,SAAS;AAAA,QAC5B,UAAU,SAAS,aAAa,IAAG,EAAE;AAAA,QACrC,aAAa,SAAS;AAAA,MACxB;AAAA,IAAC,CAAC;AAGN,QAAI,KAAK,sBAAsB;AAC7B,YAAM,OAAO,IAAI,KAAK,EAAE,kBAAkB,KAAK,qBAAqB,CAAC;AAGrE,YAAM,iBAAiB,SAAS,OAAO,aAAa,WAAW,EAAE,YAAY;AAC7E,YAAM,iBAAiB,SAAS,OAAO,SAAS,MAAM;AACtD,YAAM,gBAAgB,OAAO,SAAS,SAAS;AAE/C,iBAAW,QAAQ,SAAS,eAAe;AACzC,cAAM,gBAAgB,KAAK,YAAY,aAAa,WAAW,EAAE,YAAY;AAC7E,cAAM,gBAAgB,KAAK,YAAY,SAAS,MAAM;AACtD,cAAM,SAAS,KAAK;AAEpB,cAAM,KAAK;AAAA,UACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAMA;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACJ;AAAA,MACF;AAEA,YAAM,KAAK,IAAI;AACf,cAAQ,IAAI,mDAAmD;AAAA,QAC7D;AAAA,QACA,eAAe;AAAA,QACf,QAAQ;AAAA,QACR,WAAW;AAAA,MACb,CAAC;AAAA,IACH;AAGA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAc,WAAW,QAAgB,sBAA+C;AACtF,WAAO,IAAI;AAAA,MACT,OAAO,YAAY;AAAA,MACnB,OAAO,YAAY;AAAA,MACnB;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": ["taxonomyItems"]
+}

package/dist/esm/contracts-api/deleteStream.mjs

@@ -0,0 +1,24 @@
+// src/contracts-api/deleteStream.ts
+async function deleteStream(input) {
+  try {
+    return await input.kwilClient.execute(
+      {
+        description: `TN SDK - Deleting stream: ${input.stream.streamId.getId()} from data provider: ${input.stream.dataProvider.getAddress()}`,
+        inputs: [{
+          $data_provider: input.stream.dataProvider.getAddress(),
+          $stream_id: input.stream.streamId.getId()
+        }],
+        name: "delete_stream",
+        namespace: "main"
+      },
+      input.kwilSigner,
+      input.synchronous
+    );
+  } catch (error) {
+    throw new Error(`Failed to delete stream: ${error}`);
+  }
+}
+export {
+  deleteStream
+};
+//# sourceMappingURL=deleteStream.mjs.map

package/dist/esm/contracts-api/deleteStream.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/contracts-api/deleteStream.ts"],
+  "sourcesContent": ["import {StreamId} from \"../util/StreamId\";\nimport {Kwil} from \"@kwilteam/kwil-js/dist/client/kwil\";\nimport {KwilSigner} from \"@kwilteam/kwil-js\";\nimport {TxReceipt} from \"@kwilteam/kwil-js/dist/core/tx\";\nimport {GenericResponse} from \"@kwilteam/kwil-js/dist/core/resreq\";\nimport {StreamLocator} from \"../types/stream\";\n\n/**\n * Input parameters for destroying a stream.\n */\nexport interface DestroyStreamInput {\n  stream: StreamLocator;\n  kwilClient: Kwil<any>;\n  kwilSigner: KwilSigner;\n  synchronous?: boolean;\n}\n\n/**\n * Output after deleting a stream.\n */\nexport interface DeleteStreamOutput {\n  receipt: TxReceipt;\n}\n\n/**\n * Delete a stream from TN.\n * @param input - The input parameters for destroying the stream.\n * @returns The transaction receipt of the destruction.\n */\nexport async function deleteStream(\n  input: DestroyStreamInput,\n): Promise<GenericResponse<TxReceipt>> {\n  try {\n    return await input.kwilClient.execute({\n          description: `TN SDK - Deleting stream: ${input.stream.streamId.getId()} from data provider: ${input.stream.dataProvider.getAddress()}`,\n          inputs: [{\n              $data_provider: input.stream.dataProvider.getAddress(),\n              $stream_id: input.stream.streamId.getId()\n          }],\n          name: \"delete_stream\",\n          namespace: \"main\"\n        },\n        input.kwilSigner,\n        input.synchronous,\n        )} catch (error) {\n    throw new Error(`Failed to delete stream: ${error}`);\n  }\n}"],
+  "mappings": ";AA6BA,eAAsB,aACpB,OACqC;AACrC,MAAI;AACF,WAAO,MAAM,MAAM,WAAW;AAAA,MAAQ;AAAA,QAChC,aAAa,6BAA6B,MAAM,OAAO,SAAS,MAAM,CAAC,wBAAwB,MAAM,OAAO,aAAa,WAAW,CAAC;AAAA,QACrI,QAAQ,CAAC;AAAA,UACL,gBAAgB,MAAM,OAAO,aAAa,WAAW;AAAA,UACrD,YAAY,MAAM,OAAO,SAAS,MAAM;AAAA,QAC5C,CAAC;AAAA,QACD,MAAM;AAAA,QACN,WAAW;AAAA,MACb;AAAA,MACA,MAAM;AAAA,MACN,MAAM;AAAA,IACN;AAAA,EAAC,SAAS,OAAO;AACrB,UAAM,IAAI,MAAM,4BAA4B,KAAK,EAAE;AAAA,EACrD;AACF;",
+  "names": []
+}

package/dist/esm/contracts-api/deployStream.mjs

@@ -1,38 +1,40 @@
 // src/contracts-api/deployStream.ts
-import { StreamType } from "./contractValues.mjs";
-import {
-  composedStreamTemplate,
-  primitiveStreamTemplate,
-  composedStreamTemplateUnix,
-  primitiveStreamTemplateUnix
-} from "../contracts/contractsContent.mjs";
+import pg from "pg";
+var { Pool } = pg;
 async function deployStream(input) {
   try {
-    const schema = await getContract(input.streamType, input.contractVersion);
-    schema.name = input.streamId.getId();
-    const txHash = await input.kwilClient.deploy(
+    const txHash = await input.kwilClient.execute(
       {
-        schema,
+        namespace: "main",
+        inputs: [{
+          $stream_id: input.streamId.getId(),
+          $stream_type: input.streamType
+        }],
+        name: "create_stream",
         description: `TN SDK - Deploying ${input.streamType} stream: ${input.streamId.getId()}`
       },
       input.kwilSigner,
       input.synchronous
     );
+    if (input.neonConnectionString) {
+      console.log("Neon connection detected, attempting to insert into DB...");
+      const signer = input.kwilSigner.signer;
+      const dataProvider = signer.address.toLowerCase();
+      const pool = new Pool({ connectionString: input.neonConnectionString });
+      await pool.query(
+        `INSERT INTO streams (data_provider, stream_id, type, stream_name, display_name, categories, owner_wallet, geography, tags)
+           VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)
+             ON CONFLICT (data_provider, stream_id) DO NOTHING`,
+        [dataProvider, input.streamId.getId(), input.streamType, input.streamId.getName(), input.streamId.getName(), "{External}", dataProvider, "Global", "{External}"]
+      );
+      await pool.end();
+      console.log("successfully inserted into Explorer DB", input.streamId.getName());
+    }
     return txHash;
   } catch (error) {
     throw new Error(`Failed to deploy stream: ${error}`);
   }
 }
-async function getContract(streamType, contractVersion) {
-  switch (streamType) {
-    case StreamType.Composed:
-      return contractVersion === 2 ? composedStreamTemplateUnix : composedStreamTemplate;
-    case StreamType.Primitive:
-      return contractVersion === 2 ? primitiveStreamTemplateUnix : primitiveStreamTemplate;
-    default:
-      throw new Error(`Unknown stream type: ${streamType}`);
-  }
-}
 export {
   deployStream
 };

package/dist/esm/contracts-api/deployStream.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/contracts-api/deployStream.ts"],
-  "sourcesContent": ["import { StreamType } from \"./contractValues\";\nimport { TxReceipt } from \"@kwilteam/kwil-js/dist/core/tx\";\nimport { Kwil } from \"@kwilteam/kwil-js/dist/client/kwil\";\nimport { CompiledKuneiform } from \"@kwilteam/kwil-js/dist/core/payload\";\nimport {\n  composedStreamTemplate,\n  primitiveStreamTemplate,\n  composedStreamTemplateUnix,\n  primitiveStreamTemplateUnix\n} from \"../contracts/contractsContent\";\nimport { GenericResponse } from \"@kwilteam/kwil-js/dist/core/resreq\";\nimport { KwilSigner } from \"@kwilteam/kwil-js\";\nimport { StreamId } from \"../util/StreamId\";\n\nexport interface DeployStreamInput {\n  streamId: StreamId;\n  streamType: StreamType;\n  kwilClient: Kwil<any>;\n  kwilSigner: KwilSigner;\n  synchronous?: boolean;\n  contractVersion?: number;\n}\n\nexport interface DeployStreamOutput {\n  receipt: TxReceipt;\n}\n\n/**\n * Deploys a stream to TN.\n * @param input - The input parameters for deploying the stream.\n * @returns The transaction hash of the deployment.\n */\nexport async function deployStream(\n  input: DeployStreamInput,\n): Promise<GenericResponse<TxReceipt>> {\n  try {\n    const schema = await getContract(input.streamType, input.contractVersion);\n\n    schema.name = input.streamId.getId();\n\n    const txHash = await input.kwilClient.deploy(\n      {\n        schema,\n        description: `TN SDK - Deploying ${input.streamType} stream: ${input.streamId.getId()}`,\n      },\n      input.kwilSigner,\n      input.synchronous,\n    );\n\n    return txHash;\n  } catch (error) {\n    throw new Error(`Failed to deploy stream: ${error}`);\n  }\n}\n\n/**\n * Returns the contract content based on the stream type.\n * @param streamType - The type of the stream.\n * @param contractVersion\n * @returns The contract content as a Uint8Array.\n */\nasync function getContract(streamType: StreamType, contractVersion?: number): Promise<CompiledKuneiform> {\n  switch (streamType) {\n    case StreamType.Composed:\n      return contractVersion === 2 ? composedStreamTemplateUnix : composedStreamTemplate;\n    case StreamType.Primitive:\n      return contractVersion === 2 ? primitiveStreamTemplateUnix : primitiveStreamTemplate;\n    default:\n      throw new Error(`Unknown stream type: ${streamType}`);\n  }\n}\n"],
-  "mappings": ";AAAA,SAAS,kBAAkB;AAI3B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAuBP,eAAsB,aACpB,OACqC;AACrC,MAAI;AACF,UAAM,SAAS,MAAM,YAAY,MAAM,YAAY,MAAM,eAAe;AAExE,WAAO,OAAO,MAAM,SAAS,MAAM;AAEnC,UAAM,SAAS,MAAM,MAAM,WAAW;AAAA,MACpC;AAAA,QACE;AAAA,QACA,aAAa,sBAAsB,MAAM,UAAU,YAAY,MAAM,SAAS,MAAM,CAAC;AAAA,MACvF;AAAA,MACA,MAAM;AAAA,MACN,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,4BAA4B,KAAK,EAAE;AAAA,EACrD;AACF;AAQA,eAAe,YAAY,YAAwB,iBAAsD;AACvG,UAAQ,YAAY;AAAA,IAClB,KAAK,WAAW;AACd,aAAO,oBAAoB,IAAI,6BAA6B;AAAA,IAC9D,KAAK,WAAW;AACd,aAAO,oBAAoB,IAAI,8BAA8B;AAAA,IAC/D;AACE,YAAM,IAAI,MAAM,wBAAwB,UAAU,EAAE;AAAA,EACxD;AACF;",
+  "sourcesContent": ["import {StreamType} from \"./contractValues\";\nimport {TxReceipt} from \"@kwilteam/kwil-js/dist/core/tx\";\nimport {Kwil} from \"@kwilteam/kwil-js/dist/client/kwil\";\nimport {KwilSigner} from \"@kwilteam/kwil-js\";\nimport {GenericResponse} from \"@kwilteam/kwil-js/dist/core/resreq\";\nimport {StreamId} from \"../util/StreamId\";\nimport pg from \"pg\";\nconst { Pool } = pg;\n\nexport interface DeployStreamInput {\n  streamId: StreamId;\n  streamType: StreamType;\n  kwilClient: Kwil<any>;\n  kwilSigner: KwilSigner;\n  synchronous?: boolean;\n  neonConnectionString?: string;\n}\n\nexport interface DeployStreamOutput {\n  receipt: TxReceipt;\n}\n\n/**\n * Deploys a stream to TN.\n * @param input - The input parameters for deploying the stream.\n * @returns The transaction hash of the deployment.\n */\nexport async function deployStream(\n  input: DeployStreamInput,\n): Promise<GenericResponse<TxReceipt>> {\n  try {\n      const txHash = await input.kwilClient.execute(\n        {\n            namespace: \"main\",\n            inputs: [{\n                $stream_id: input.streamId.getId(),\n                $stream_type: input.streamType,\n            }],\n            name: \"create_stream\",\n            description: `TN SDK - Deploying ${input.streamType} stream: ${input.streamId.getId()}`\n        },\n        input.kwilSigner,\n        input.synchronous,\n    );\n\n    // Optional: insert into Postgres via neon connection\n    if (input.neonConnectionString) {\n      console.log(\"Neon connection detected, attempting to insert into DB...\");\n\n      const signer: any = input.kwilSigner.signer;\n      const dataProvider = signer.address.toLowerCase();\n\n      const pool = new Pool({ connectionString: input.neonConnectionString });\n      await pool.query(\n          `INSERT INTO streams (data_provider, stream_id, type, stream_name, display_name, categories, owner_wallet, geography, tags)\n           VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)\n             ON CONFLICT (data_provider, stream_id) DO NOTHING`,\n          [dataProvider, input.streamId.getId(), input.streamType, input.streamId.getName(), input.streamId.getName(), '{External}', dataProvider, 'Global', '{External}'],\n      );\n      await pool.end();\n\n      console.log(\"successfully inserted into Explorer DB\", input.streamId.getName());\n    }\n\n    return txHash;\n  } catch (error) {\n    throw new Error(`Failed to deploy stream: ${error}`);\n  }\n}"],
+  "mappings": ";AAMA,OAAO,QAAQ;AACf,IAAM,EAAE,KAAK,IAAI;AAoBjB,eAAsB,aACpB,OACqC;AACrC,MAAI;AACA,UAAM,SAAS,MAAM,MAAM,WAAW;AAAA,MACpC;AAAA,QACI,WAAW;AAAA,QACX,QAAQ,CAAC;AAAA,UACL,YAAY,MAAM,SAAS,MAAM;AAAA,UACjC,cAAc,MAAM;AAAA,QACxB,CAAC;AAAA,QACD,MAAM;AAAA,QACN,aAAa,sBAAsB,MAAM,UAAU,YAAY,MAAM,SAAS,MAAM,CAAC;AAAA,MACzF;AAAA,MACA,MAAM;AAAA,MACN,MAAM;AAAA,IACV;AAGA,QAAI,MAAM,sBAAsB;AAC9B,cAAQ,IAAI,2DAA2D;AAEvE,YAAM,SAAc,MAAM,WAAW;AACrC,YAAM,eAAe,OAAO,QAAQ,YAAY;AAEhD,YAAM,OAAO,IAAI,KAAK,EAAE,kBAAkB,MAAM,qBAAqB,CAAC;AACtE,YAAM,KAAK;AAAA,QACP;AAAA;AAAA;AAAA,QAGA,CAAC,cAAc,MAAM,SAAS,MAAM,GAAG,MAAM,YAAY,MAAM,SAAS,QAAQ,GAAG,MAAM,SAAS,QAAQ,GAAG,cAAc,cAAc,UAAU,YAAY;AAAA,MACnK;AACA,YAAM,KAAK,IAAI;AAEf,cAAQ,IAAI,0CAA0C,MAAM,SAAS,QAAQ,CAAC;AAAA,IAChF;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,4BAA4B,KAAK,EAAE;AAAA,EACrD;AACF;",
   "names": []
 }

package/dist/esm/contracts-api/primitiveAction.mjs

@@ -0,0 +1,71 @@
+// src/contracts-api/primitiveAction.ts
+import { Utils } from "@kwilteam/kwil-js";
+import { Action } from "./action.mjs";
+var DataType = Utils.DataType;
+var PrimitiveAction = class _PrimitiveAction extends Action {
+  constructor(kwilClient, kwilSigner) {
+    super(kwilClient, kwilSigner);
+  }
+  /**
+   * Insert a record into the stream
+   * @param input of a single record to insert
+   * @returns Transaction receipt
+   */
+  async insertRecord(input) {
+    return await this.executeWithActionBody({
+      namespace: "main",
+      name: "insert_record",
+      inputs: [{
+        $data_provider: input.stream.dataProvider.getAddress(),
+        $stream_id: input.stream.streamId.getId(),
+        $event_time: input.eventTime,
+        $value: input.value
+      }],
+      types: {
+        $data_provider: DataType.Text,
+        $stream_id: DataType.Text,
+        $event_time: DataType.Int,
+        $value: DataType.Numeric(36, 18)
+      }
+    });
+  }
+  /**
+   * Inserts records into the stream
+   * @param inputs Array of records to insert
+   * @param synchronous If true, the transaction will be executed synchronously
+   * @returns Transaction receipt
+   */
+  async insertRecords(inputs, synchronous) {
+    return await this.executeWithActionBody({
+      namespace: "main",
+      name: "insert_records",
+      inputs: inputs.map((input) => ({
+        $data_provider: input.stream.dataProvider.getAddress(),
+        $stream_id: input.stream.streamId.getId(),
+        $event_time: input.eventTime,
+        $value: input.value
+      })),
+      types: {
+        $data_provider: DataType.TextArray,
+        $stream_id: DataType.TextArray,
+        $event_time: DataType.IntArray,
+        $value: DataType.NumericArray(36, 18)
+      }
+    }, synchronous);
+  }
+  /**
+   * Creates a PrimitiveStream from a base Stream
+   * @param stream The base stream to convert
+   * @returns A Promise that resolves to a PrimitiveStream instance
+   */
+  static fromStream(stream) {
+    return new _PrimitiveAction(
+      stream["kwilClient"],
+      stream["kwilSigner"]
+    );
+  }
+};
+export {
+  PrimitiveAction
+};
+//# sourceMappingURL=primitiveAction.mjs.map

package/dist/esm/contracts-api/primitiveAction.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/contracts-api/primitiveAction.ts"],
+  "sourcesContent": ["import {KwilSigner, NodeKwil, Utils, WebKwil} from \"@kwilteam/kwil-js\";\nimport {GenericResponse} from \"@kwilteam/kwil-js/dist/core/resreq\";\nimport {TxReceipt} from \"@kwilteam/kwil-js/dist/core/tx\";\nimport {StreamType} from \"./contractValues\";\nimport {Action} from \"./action\";\nimport {StreamLocator} from \"../types/stream\";\nimport DataType = Utils.DataType;\n\nconst ErrorStreamNotPrimitive = \"stream is not a primitive stream\";\n\nexport class PrimitiveAction extends Action {\n  constructor(\n    kwilClient: WebKwil | NodeKwil,\n    kwilSigner: KwilSigner,\n  ) {\n    super(kwilClient, kwilSigner);\n  }\n\n  /**\n   * Insert a record into the stream\n   * @param input of a single record to insert\n   * @returns Transaction receipt\n   */\n  public async insertRecord(\n      input: InsertRecordInput,\n  ): Promise<GenericResponse<TxReceipt>> {\n    return await this.executeWithActionBody({\n          namespace: 'main',\n          name: 'insert_record',\n          inputs: [{\n            $data_provider: input.stream.dataProvider.getAddress(),\n            $stream_id: input.stream.streamId.getId(),\n            $event_time: input.eventTime,\n            $value: input.value\n          }],\n          types: {\n            $data_provider: DataType.Text,\n            $stream_id: DataType.Text,\n            $event_time: DataType.Int,\n            $value: DataType.Numeric(36, 18)\n          }\n    })\n  }\n\n    /**\n     * Inserts records into the stream\n     * @param inputs Array of records to insert\n     * @param synchronous If true, the transaction will be executed synchronously\n     * @returns Transaction receipt\n     */\n    public async insertRecords(\n        inputs: InsertRecordInput[],\n        synchronous?: boolean,\n    ): Promise<GenericResponse<TxReceipt>> {\n      return await this.executeWithActionBody({\n        namespace: 'main',\n        name: 'insert_records',\n        inputs: inputs.map((input) => ({\n          $data_provider: input.stream.dataProvider.getAddress(),\n          $stream_id: input.stream.streamId.getId(),\n          $event_time: input.eventTime,\n          $value: input.value\n        })),\n        types: {\n          $data_provider: DataType.TextArray,\n          $stream_id: DataType.TextArray,\n          $event_time: DataType.IntArray,\n          $value: DataType.NumericArray(36, 18)\n        }\n      }, synchronous)\n    }\n\n  /**\n   * Creates a PrimitiveStream from a base Stream\n   * @param stream The base stream to convert\n   * @returns A Promise that resolves to a PrimitiveStream instance\n   */\n  public static fromStream(stream: Action): PrimitiveAction {\n    return new PrimitiveAction(\n        stream[\"kwilClient\"],\n        stream[\"kwilSigner\"],\n    );\n  }\n}\n\nexport interface InsertRecordInput {\n  stream: StreamLocator;\n  eventTime: number;\n  // value is a string to support arbitrary precision\n  value: string;\n}\n"],
+  "mappings": ";AAAA,SAA8B,aAAqB;AAInD,SAAQ,cAAa;AAErB,IAAO,WAAW,MAAM;AAIjB,IAAM,kBAAN,MAAM,yBAAwB,OAAO;AAAA,EAC1C,YACE,YACA,YACA;AACA,UAAM,YAAY,UAAU;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,aACT,OACmC;AACrC,WAAO,MAAM,KAAK,sBAAsB;AAAA,MAClC,WAAW;AAAA,MACX,MAAM;AAAA,MACN,QAAQ,CAAC;AAAA,QACP,gBAAgB,MAAM,OAAO,aAAa,WAAW;AAAA,QACrD,YAAY,MAAM,OAAO,SAAS,MAAM;AAAA,QACxC,aAAa,MAAM;AAAA,QACnB,QAAQ,MAAM;AAAA,MAChB,CAAC;AAAA,MACD,OAAO;AAAA,QACL,gBAAgB,SAAS;AAAA,QACzB,YAAY,SAAS;AAAA,QACrB,aAAa,SAAS;AAAA,QACtB,QAAQ,SAAS,QAAQ,IAAI,EAAE;AAAA,MACjC;AAAA,IACN,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQE,MAAa,cACT,QACA,aACmC;AACrC,WAAO,MAAM,KAAK,sBAAsB;AAAA,MACtC,WAAW;AAAA,MACX,MAAM;AAAA,MACN,QAAQ,OAAO,IAAI,CAAC,WAAW;AAAA,QAC7B,gBAAgB,MAAM,OAAO,aAAa,WAAW;AAAA,QACrD,YAAY,MAAM,OAAO,SAAS,MAAM;AAAA,QACxC,aAAa,MAAM;AAAA,QACnB,QAAQ,MAAM;AAAA,MAChB,EAAE;AAAA,MACF,OAAO;AAAA,QACL,gBAAgB,SAAS;AAAA,QACzB,YAAY,SAAS;AAAA,QACrB,aAAa,SAAS;AAAA,QACtB,QAAQ,SAAS,aAAa,IAAI,EAAE;AAAA,MACtC;AAAA,IACF,GAAG,WAAW;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,OAAc,WAAW,QAAiC;AACxD,WAAO,IAAI;AAAA,MACP,OAAO,YAAY;AAAA,MACnB,OAAO,YAAY;AAAA,IACvB;AAAA,EACF;AACF;",
+  "names": []
+}

package/dist/esm/index.common.mjs

@@ -3,14 +3,14 @@ import { StreamId } from "./util/StreamId.mjs";
 import { EthereumAddress } from "./util/EthereumAddress.mjs";
 import { visibility } from "./util/visibility.mjs";
 import { StreamType } from "./contracts-api/contractValues.mjs";
-import { Stream } from "./contracts-api/stream.mjs";
-import { PrimitiveStream } from "./contracts-api/primitiveStream.mjs";
-import { ComposedStream } from "./contracts-api/composedStream.mjs";
+import { Action } from "./contracts-api/action.mjs";
+import { PrimitiveAction } from "./contracts-api/primitiveAction.mjs";
+import { ComposedAction } from "./contracts-api/composedAction.mjs";
 export {
-  ComposedStream,
+  Action,
+  ComposedAction,
   EthereumAddress,
-  PrimitiveStream,
-  Stream,
+  PrimitiveAction,
   StreamId,
   StreamType,
   visibility

package/dist/esm/index.common.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.common.ts"],
-  "sourcesContent": ["// Core client types\nexport type { TNClientOptions } from \"./client/client\";\nexport type { SignerInfo as EthProvider } from \"./client/client\";\n\n// Stream types and interfaces\nexport type { StreamLocator } from \"./types/stream\";\nexport type { StreamRecord } from \"./contracts-api/stream\";\nexport type { GetRecordInput, GetFirstRecordInput } from \"./contracts-api/stream\";\nexport type { InsertRecordInput } from \"./contracts-api/primitiveStream\";\nexport type { TaxonomySet, TaxonomyItem } from \"./contracts-api/composedStream\";\n\n// Utility types and classes\nexport { StreamId } from \"./util/StreamId\";\nexport { EthereumAddress } from \"./util/EthereumAddress\";\nexport { visibility } from \"./util/visibility\";\nexport type { VisibilityEnum } from \"./util/visibility\";\n\n// Stream type constants\nexport { StreamType } from \"./contracts-api/contractValues\";\n\n// Base classes\nexport { Stream } from \"./contracts-api/stream\";\nexport { PrimitiveStream } from \"./contracts-api/primitiveStream\";\nexport { ComposedStream } from \"./contracts-api/composedStream\";\n\n"],
+  "sourcesContent": ["// Core client types\nexport type { TNClientOptions } from \"./client/client\";\nexport type { SignerInfo as EthProvider } from \"./client/client\";\n\n// Stream types and interfaces\nexport type { StreamLocator } from \"./types/stream\";\nexport type { StreamRecord } from \"./contracts-api/action\";\nexport type { GetRecordInput, GetFirstRecordInput } from \"./contracts-api/action\";\nexport type { InsertRecordInput } from \"./contracts-api/primitiveAction\";\nexport type { TaxonomySet, TaxonomyItem } from \"./contracts-api/composedAction\";\n\n// Utility types and classes\nexport { StreamId } from \"./util/StreamId\";\nexport { EthereumAddress } from \"./util/EthereumAddress\";\nexport { visibility } from \"./util/visibility\";\nexport type { VisibilityEnum } from \"./util/visibility\";\n\n// Stream type constants\nexport { StreamType } from \"./contracts-api/contractValues\";\n\n// Base classes\nexport { Action } from \"./contracts-api/action\";\nexport { PrimitiveAction } from \"./contracts-api/primitiveAction\";\nexport { ComposedAction } from \"./contracts-api/composedAction\";\n\n"],
   "mappings": ";AAYA,SAAS,gBAAgB;AACzB,SAAS,uBAAuB;AAChC,SAAS,kBAAkB;AAI3B,SAAS,kBAAkB;AAG3B,SAAS,cAAc;AACvB,SAAS,uBAAuB;AAChC,SAAS,sBAAsB;",
   "names": []
 }

package/dist/esm/types/transaction.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=transaction.mjs.map

package/dist/esm/types/transaction.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/esm/util/EthereumAddress.mjs

@@ -9,7 +9,6 @@ var EthereumAddress = class _EthereumAddress {
   constructor(address) {
     __publicField(this, "address");
     __publicField(this, "correctlyCreated", false);
-    address = address.toLowerCase();
     if (!address.startsWith("0x")) {
       address = "0x" + address;
     }

package/dist/esm/util/EthereumAddress.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/util/EthereumAddress.ts"],
-  "sourcesContent": ["import { ethers } from \"ethers\";\nimport { Either, left, right } from \"monads-io/either\";\n\nexport class EthereumAddress {\n  private readonly address: string;\n  private readonly correctlyCreated: boolean = false;\n\n  constructor(address: string) {\n    address = address.toLowerCase();\n    if (!address.startsWith(\"0x\")) {\n      address = \"0x\" + address;\n    }\n\n    if (!this.validateEthereumAddress(address)) {\n      throw new Error(\"Invalid Ethereum address\");\n    }\n\n    this.address = address;\n    this.correctlyCreated = true;\n  }\n\n  private validateEthereumAddress(address: string): boolean {\n    return /^(0x)?[0-9a-f]{40}$/i.test(address);\n  }\n\n  public getAddress(): string {\n    if (!this.correctlyCreated) {\n      throw new Error(\"EthereumAddress not correctly created\");\n    }\n\n    return this.address;\n  }\n\n  public getBytes(): Uint8Array {\n    return new TextEncoder().encode(this.getAddress());\n  }\n\n  public toJSON(): string {\n    return this.getAddress();\n  }\n\n  public static fromJSON(json: string): EthereumAddress {\n    return new EthereumAddress(json);\n  }\n\n  public static fromBytes(bytes: Uint8Array): Either<Error, EthereumAddress> {\n    try {\n      return right(new EthereumAddress(ethers.hexlify(bytes)));\n    } catch (e) {\n      return left(e as Error);\n    }\n  }\n\n  public static fromString(str: string): Either<Error, EthereumAddress> {\n    try {\n      return right(new EthereumAddress(str));\n    } catch (e) {\n      return left(e as Error);\n    }\n  }\n}\n\nif (import.meta.vitest) {\n  const { describe, it, expect } = import.meta.vitest;\n  describe(\"EthereumAddress\", () => {\n    it(\"should create a valid EthereumAddress with correct format\", () => {\n      const address = new EthereumAddress(\n        \"0x1234567890123456789012345678901234567890\",\n      );\n      expect(address.getAddress()).toBe(\n        \"0x1234567890123456789012345678901234567890\",\n      );\n    });\n\n    it(\"should throw an error for an invalid Ethereum address\", () => {\n      expect(() => new EthereumAddress(\"invalid_address\")).toThrow(\n        \"Invalid Ethereum address\",\n      );\n    });\n\n    it(\"should enforce lowercase addresses\", () => {\n      const mixedCaseAddress =\n        \"0xaaBbccDdEeff1234567890123456789012345678\".toLowerCase();\n      const address = new EthereumAddress(mixedCaseAddress);\n      expect(address.getAddress()).toBe(\n        \"0xaabbccddeeff1234567890123456789012345678\",\n      );\n    });\n\n    it(\"should correctly serialize and deserialize to/from JSON\", () => {\n      const originalAddress = \"0x1234567890123456789012345678901234567890\";\n      const address = new EthereumAddress(originalAddress);\n      const json = address.toJSON();\n      const deserializedAddress = EthereumAddress.fromJSON(json);\n      expect(deserializedAddress.getAddress()).toBe(originalAddress);\n    });\n  });\n}\n"],
-  "mappings": ";;;;;AAAA,SAAS,cAAc;AACvB,SAAiB,MAAM,aAAa;AAE7B,IAAM,kBAAN,MAAM,iBAAgB;AAAA,EAI3B,YAAY,SAAiB;AAH7B,wBAAiB;AACjB,wBAAiB,oBAA4B;AAG3C,cAAU,QAAQ,YAAY;AAC9B,QAAI,CAAC,QAAQ,WAAW,IAAI,GAAG;AAC7B,gBAAU,OAAO;AAAA,IACnB;AAEA,QAAI,CAAC,KAAK,wBAAwB,OAAO,GAAG;AAC1C,YAAM,IAAI,MAAM,0BAA0B;AAAA,IAC5C;AAEA,SAAK,UAAU;AACf,SAAK,mBAAmB;AAAA,EAC1B;AAAA,EAEQ,wBAAwB,SAA0B;AACxD,WAAO,uBAAuB,KAAK,OAAO;AAAA,EAC5C;AAAA,EAEO,aAAqB;AAC1B,QAAI,CAAC,KAAK,kBAAkB;AAC1B,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACzD;AAEA,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,WAAuB;AAC5B,WAAO,IAAI,YAAY,EAAE,OAAO,KAAK,WAAW,CAAC;AAAA,EACnD;AAAA,EAEO,SAAiB;AACtB,WAAO,KAAK,WAAW;AAAA,EACzB;AAAA,EAEA,OAAc,SAAS,MAA+B;AACpD,WAAO,IAAI,iBAAgB,IAAI;AAAA,EACjC;AAAA,EAEA,OAAc,UAAU,OAAmD;AACzE,QAAI;AACF,aAAO,MAAM,IAAI,iBAAgB,OAAO,QAAQ,KAAK,CAAC,CAAC;AAAA,IACzD,SAAS,GAAG;AACV,aAAO,KAAK,CAAU;AAAA,IACxB;AAAA,EACF;AAAA,EAEA,OAAc,WAAW,KAA6C;AACpE,QAAI;AACF,aAAO,MAAM,IAAI,iBAAgB,GAAG,CAAC;AAAA,IACvC,SAAS,GAAG;AACV,aAAO,KAAK,CAAU;AAAA,IACxB;AAAA,EACF;AACF;AAEA,IAAI,YAAY,QAAQ;AACtB,QAAM,EAAE,UAAU,IAAI,OAAO,IAAI,YAAY;AAC7C,WAAS,mBAAmB,MAAM;AAChC,OAAG,6DAA6D,MAAM;AACpE,YAAM,UAAU,IAAI;AAAA,QAClB;AAAA,MACF;AACA,aAAO,QAAQ,WAAW,CAAC,EAAE;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAED,OAAG,yDAAyD,MAAM;AAChE,aAAO,MAAM,IAAI,gBAAgB,iBAAiB,CAAC,EAAE;AAAA,QACnD;AAAA,MACF;AAAA,IACF,CAAC;AAED,OAAG,sCAAsC,MAAM;AAC7C,YAAM,mBACJ,6CAA6C,YAAY;AAC3D,YAAM,UAAU,IAAI,gBAAgB,gBAAgB;AACpD,aAAO,QAAQ,WAAW,CAAC,EAAE;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAED,OAAG,2DAA2D,MAAM;AAClE,YAAM,kBAAkB;AACxB,YAAM,UAAU,IAAI,gBAAgB,eAAe;AACnD,YAAM,OAAO,QAAQ,OAAO;AAC5B,YAAM,sBAAsB,gBAAgB,SAAS,IAAI;AACzD,aAAO,oBAAoB,WAAW,CAAC,EAAE,KAAK,eAAe;AAAA,IAC/D,CAAC;AAAA,EACH,CAAC;AACH;",
+  "sourcesContent": ["import { ethers } from \"ethers\";\nimport { Either, left, right } from \"monads-io/either\";\n\nexport class EthereumAddress {\n  private readonly address: string;\n  private readonly correctlyCreated: boolean = false;\n\n  constructor(address: string) {\n    if (!address.startsWith(\"0x\")) {\n      address = \"0x\" + address;\n    }\n\n    if (!this.validateEthereumAddress(address)) {\n      throw new Error(\"Invalid Ethereum address\");\n    }\n\n    this.address = address;\n    this.correctlyCreated = true;\n  }\n\n  private validateEthereumAddress(address: string): boolean {\n    return /^(0x)?[0-9a-f]{40}$/i.test(address);\n  }\n\n  public getAddress(): string {\n    if (!this.correctlyCreated) {\n      throw new Error(\"EthereumAddress not correctly created\");\n    }\n\n    return this.address;\n  }\n\n  public getBytes(): Uint8Array {\n    return new TextEncoder().encode(this.getAddress());\n  }\n\n  public toJSON(): string {\n    return this.getAddress();\n  }\n\n  public static fromJSON(json: string): EthereumAddress {\n    return new EthereumAddress(json);\n  }\n\n  public static fromBytes(bytes: Uint8Array): Either<Error, EthereumAddress> {\n    try {\n      return right(new EthereumAddress(ethers.hexlify(bytes)));\n    } catch (e) {\n      return left(e as Error);\n    }\n  }\n\n  public static fromString(str: string): Either<Error, EthereumAddress> {\n    try {\n      return right(new EthereumAddress(str));\n    } catch (e) {\n      return left(e as Error);\n    }\n  }\n}\n\nif (import.meta.vitest) {\n  const { describe, it, expect } = import.meta.vitest;\n  describe(\"EthereumAddress\", () => {\n    it(\"should create a valid EthereumAddress with correct format\", () => {\n      const address = new EthereumAddress(\n        \"0x1234567890123456789012345678901234567890\",\n      );\n      expect(address.getAddress()).toBe(\n        \"0x1234567890123456789012345678901234567890\",\n      );\n    });\n\n    it(\"should throw an error for an invalid Ethereum address\", () => {\n      expect(() => new EthereumAddress(\"invalid_address\")).toThrow(\n        \"Invalid Ethereum address\",\n      );\n    });\n\n    it(\"should enforce lowercase addresses\", () => {\n      const mixedCaseAddress =\n        \"0xaaBbccDdEeff1234567890123456789012345678\".toLowerCase();\n      const address = new EthereumAddress(mixedCaseAddress);\n      expect(address.getAddress()).toBe(\n        \"0xaabbccddeeff1234567890123456789012345678\",\n      );\n    });\n\n    it(\"should correctly serialize and deserialize to/from JSON\", () => {\n      const originalAddress = \"0x1234567890123456789012345678901234567890\";\n      const address = new EthereumAddress(originalAddress);\n      const json = address.toJSON();\n      const deserializedAddress = EthereumAddress.fromJSON(json);\n      expect(deserializedAddress.getAddress()).toBe(originalAddress);\n    });\n  });\n}\n"],
+  "mappings": ";;;;;AAAA,SAAS,cAAc;AACvB,SAAiB,MAAM,aAAa;AAE7B,IAAM,kBAAN,MAAM,iBAAgB;AAAA,EAI3B,YAAY,SAAiB;AAH7B,wBAAiB;AACjB,wBAAiB,oBAA4B;AAG3C,QAAI,CAAC,QAAQ,WAAW,IAAI,GAAG;AAC7B,gBAAU,OAAO;AAAA,IACnB;AAEA,QAAI,CAAC,KAAK,wBAAwB,OAAO,GAAG;AAC1C,YAAM,IAAI,MAAM,0BAA0B;AAAA,IAC5C;AAEA,SAAK,UAAU;AACf,SAAK,mBAAmB;AAAA,EAC1B;AAAA,EAEQ,wBAAwB,SAA0B;AACxD,WAAO,uBAAuB,KAAK,OAAO;AAAA,EAC5C;AAAA,EAEO,aAAqB;AAC1B,QAAI,CAAC,KAAK,kBAAkB;AAC1B,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACzD;AAEA,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,WAAuB;AAC5B,WAAO,IAAI,YAAY,EAAE,OAAO,KAAK,WAAW,CAAC;AAAA,EACnD;AAAA,EAEO,SAAiB;AACtB,WAAO,KAAK,WAAW;AAAA,EACzB;AAAA,EAEA,OAAc,SAAS,MAA+B;AACpD,WAAO,IAAI,iBAAgB,IAAI;AAAA,EACjC;AAAA,EAEA,OAAc,UAAU,OAAmD;AACzE,QAAI;AACF,aAAO,MAAM,IAAI,iBAAgB,OAAO,QAAQ,KAAK,CAAC,CAAC;AAAA,IACzD,SAAS,GAAG;AACV,aAAO,KAAK,CAAU;AAAA,IACxB;AAAA,EACF;AAAA,EAEA,OAAc,WAAW,KAA6C;AACpE,QAAI;AACF,aAAO,MAAM,IAAI,iBAAgB,GAAG,CAAC;AAAA,IACvC,SAAS,GAAG;AACV,aAAO,KAAK,CAAU;AAAA,IACxB;AAAA,EACF;AACF;AAEA,IAAI,YAAY,QAAQ;AACtB,QAAM,EAAE,UAAU,IAAI,OAAO,IAAI,YAAY;AAC7C,WAAS,mBAAmB,MAAM;AAChC,OAAG,6DAA6D,MAAM;AACpE,YAAM,UAAU,IAAI;AAAA,QAClB;AAAA,MACF;AACA,aAAO,QAAQ,WAAW,CAAC,EAAE;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAED,OAAG,yDAAyD,MAAM;AAChE,aAAO,MAAM,IAAI,gBAAgB,iBAAiB,CAAC,EAAE;AAAA,QACnD;AAAA,MACF;AAAA,IACF,CAAC;AAED,OAAG,sCAAsC,MAAM;AAC7C,YAAM,mBACJ,6CAA6C,YAAY;AAC3D,YAAM,UAAU,IAAI,gBAAgB,gBAAgB;AACpD,aAAO,QAAQ,WAAW,CAAC,EAAE;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,CAAC;AAED,OAAG,2DAA2D,MAAM;AAClE,YAAM,kBAAkB;AACxB,YAAM,UAAU,IAAI,gBAAgB,eAAe;AACnD,YAAM,OAAO,QAAQ,OAAO;AAC5B,YAAM,sBAAsB,gBAAgB,SAAS,IAAI;AACzD,aAAO,oBAAoB,WAAW,CAAC,EAAE,KAAK,eAAe;AAAA,IAC/D,CAAC;AAAA,EACH,CAAC;AACH;",
   "names": []
 }

package/dist/esm/util/StreamId.mjs

@@ -6,11 +6,13 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 import { sha256 } from "crypto-hash";
 import { Either } from "monads-io";
 var StreamId = class _StreamId {
-  constructor(id) {
+  constructor(id, name) {
     __publicField(this, "id");
     __publicField(this, "correctlyCreated", false);
+    __publicField(this, "name");
     this.id = id;
     this.correctlyCreated = true;
+    this.name = name;
   }
   getId() {
     if (!this.correctlyCreated) {
@@ -18,6 +20,9 @@ var StreamId = class _StreamId {
     }
     return this.id;
   }
+  getName() {
+    return this.name;
+  }
   validate() {
     return this.id.length === 32 && this.id.startsWith("st");
   }
@@ -33,7 +38,7 @@ var StreamId = class _StreamId {
     }
     const hash = await sha256(s);
     const streamIdStr = "st" + hash.slice(0, 30);
-    return new _StreamId(streamIdStr);
+    return new _StreamId(streamIdStr, s);
   }
   static fromString(s) {
     try {

package/dist/esm/util/StreamId.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/util/StreamId.ts"],
-  "sourcesContent": ["import { sha256 } from \"crypto-hash\";\nimport { Either } from \"monads-io\";\n\nexport class StreamId {\n  private readonly id: string;\n  private readonly correctlyCreated: boolean = false;\n\n  private constructor(id: string) {\n    this.id = id;\n    this.correctlyCreated = true;\n  }\n\n  public getId(): string {\n    if (!this.correctlyCreated) {\n      throw new Error(\"StreamId not correctly created\");\n    }\n\n    return this.id;\n  }\n\n  public validate(): boolean {\n    return this.id.length === 32 && this.id.startsWith(\"st\");\n  }\n\n  public toJSON(): string {\n    return this.getId();\n  }\n\n  public static fromJSON(json: string): StreamId {\n    return new StreamId(json);\n  }\n\n  public static async generate(s: string): Promise<StreamId> {\n    // If the string is already a valid StreamId, return it\n    if (s.length === 32 && s.startsWith(\"st\")) {\n      return new StreamId(s);\n    }\n\n    // Compute SHA-256 hash of the input string\n    const hash = await sha256(s);\n\n    // Take the first 30 characters of the hash and prepend \"st\"\n    const streamIdStr = \"st\" + hash.slice(0, 30);\n\n    return new StreamId(streamIdStr);\n  }\n\n  public static fromString(s: string): Either<Error, StreamId> {\n    try {\n      return Either.right(new StreamId(s));\n    } catch (e) {\n      return Either.left(e as Error);\n    }\n  }\n}\n\nif (import.meta.vitest) {\n  const { describe, it, expect } = import.meta.vitest;\n  describe(\"StreamId\", () => {\n    it(\"should generate a valid StreamId\", async () => {\n      const streamId = await StreamId.generate(\"cpi_india_1.1.01\");\n      expect(streamId.validate()).toBe(true);\n      expect(streamId.getId()).toBe(\"st39830c44932bc42a3bffef72310948\");\n    });\n  });\n}\n"],
-  "mappings": ";;;;;AAAA,SAAS,cAAc;AACvB,SAAS,cAAc;AAEhB,IAAM,WAAN,MAAM,UAAS;AAAA,EAIZ,YAAY,IAAY;AAHhC,wBAAiB;AACjB,wBAAiB,oBAA4B;AAG3C,SAAK,KAAK;AACV,SAAK,mBAAmB;AAAA,EAC1B;AAAA,EAEO,QAAgB;AACrB,QAAI,CAAC,KAAK,kBAAkB;AAC1B,YAAM,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAEA,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,WAAoB;AACzB,WAAO,KAAK,GAAG,WAAW,MAAM,KAAK,GAAG,WAAW,IAAI;AAAA,EACzD;AAAA,EAEO,SAAiB;AACtB,WAAO,KAAK,MAAM;AAAA,EACpB;AAAA,EAEA,OAAc,SAAS,MAAwB;AAC7C,WAAO,IAAI,UAAS,IAAI;AAAA,EAC1B;AAAA,EAEA,aAAoB,SAAS,GAA8B;AAEzD,QAAI,EAAE,WAAW,MAAM,EAAE,WAAW,IAAI,GAAG;AACzC,aAAO,IAAI,UAAS,CAAC;AAAA,IACvB;AAGA,UAAM,OAAO,MAAM,OAAO,CAAC;AAG3B,UAAM,cAAc,OAAO,KAAK,MAAM,GAAG,EAAE;AAE3C,WAAO,IAAI,UAAS,WAAW;AAAA,EACjC;AAAA,EAEA,OAAc,WAAW,GAAoC;AAC3D,QAAI;AACF,aAAO,OAAO,MAAM,IAAI,UAAS,CAAC,CAAC;AAAA,IACrC,SAAS,GAAG;AACV,aAAO,OAAO,KAAK,CAAU;AAAA,IAC/B;AAAA,EACF;AACF;AAEA,IAAI,YAAY,QAAQ;AACtB,QAAM,EAAE,UAAU,IAAI,OAAO,IAAI,YAAY;AAC7C,WAAS,YAAY,MAAM;AACzB,OAAG,oCAAoC,YAAY;AACjD,YAAM,WAAW,MAAM,SAAS,SAAS,kBAAkB;AAC3D,aAAO,SAAS,SAAS,CAAC,EAAE,KAAK,IAAI;AACrC,aAAO,SAAS,MAAM,CAAC,EAAE,KAAK,kCAAkC;AAAA,IAClE,CAAC;AAAA,EACH,CAAC;AACH;",
+  "sourcesContent": ["import { sha256 } from \"crypto-hash\";\nimport { Either } from \"monads-io\";\n\nexport class StreamId {\n  private readonly id: string;\n  private readonly correctlyCreated: boolean = false;\n  private readonly name?: string;\n\n  private constructor(id: string, name?: string) {\n    this.id = id;\n    this.correctlyCreated = true;\n    this.name = name;\n  }\n\n  public getId(): string {\n    if (!this.correctlyCreated) {\n      throw new Error(\"StreamId not correctly created\");\n    }\n\n    return this.id;\n  }\n\n  public getName(): string | undefined {\n    return this.name;\n  }\n\n  public validate(): boolean {\n    return this.id.length === 32 && this.id.startsWith(\"st\");\n  }\n\n  public toJSON(): string {\n    return this.getId();\n  }\n\n  public static fromJSON(json: string): StreamId {\n    return new StreamId(json);\n  }\n\n  public static async generate(s: string): Promise<StreamId> {\n    // If the string is already a valid StreamId, return it\n    if (s.length === 32 && s.startsWith(\"st\")) {\n      return new StreamId(s);\n    }\n\n    // Compute SHA-256 hash of the input string\n    const hash = await sha256(s);\n\n    // Take the first 30 characters of the hash and prepend \"st\"\n    const streamIdStr = \"st\" + hash.slice(0, 30);\n\n    return new StreamId(streamIdStr, s);\n  }\n\n  public static fromString(s: string): Either<Error, StreamId> {\n    try {\n      return Either.right(new StreamId(s));\n    } catch (e) {\n      return Either.left(e as Error);\n    }\n  }\n}\n\nif (import.meta.vitest) {\n  const { describe, it, expect } = import.meta.vitest;\n  describe(\"StreamId\", () => {\n    it(\"should generate a valid StreamId\", async () => {\n      const streamId = await StreamId.generate(\"cpi_india_1.1.01\");\n      expect(streamId.validate()).toBe(true);\n      expect(streamId.getId()).toBe(\"st39830c44932bc42a3bffef72310948\");\n    });\n  });\n}\n"],
+  "mappings": ";;;;;AAAA,SAAS,cAAc;AACvB,SAAS,cAAc;AAEhB,IAAM,WAAN,MAAM,UAAS;AAAA,EAKZ,YAAY,IAAY,MAAe;AAJ/C,wBAAiB;AACjB,wBAAiB,oBAA4B;AAC7C,wBAAiB;AAGf,SAAK,KAAK;AACV,SAAK,mBAAmB;AACxB,SAAK,OAAO;AAAA,EACd;AAAA,EAEO,QAAgB;AACrB,QAAI,CAAC,KAAK,kBAAkB;AAC1B,YAAM,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAEA,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,UAA8B;AACnC,WAAO,KAAK;AAAA,EACd;AAAA,EAEO,WAAoB;AACzB,WAAO,KAAK,GAAG,WAAW,MAAM,KAAK,GAAG,WAAW,IAAI;AAAA,EACzD;AAAA,EAEO,SAAiB;AACtB,WAAO,KAAK,MAAM;AAAA,EACpB;AAAA,EAEA,OAAc,SAAS,MAAwB;AAC7C,WAAO,IAAI,UAAS,IAAI;AAAA,EAC1B;AAAA,EAEA,aAAoB,SAAS,GAA8B;AAEzD,QAAI,EAAE,WAAW,MAAM,EAAE,WAAW,IAAI,GAAG;AACzC,aAAO,IAAI,UAAS,CAAC;AAAA,IACvB;AAGA,UAAM,OAAO,MAAM,OAAO,CAAC;AAG3B,UAAM,cAAc,OAAO,KAAK,MAAM,GAAG,EAAE;AAE3C,WAAO,IAAI,UAAS,aAAa,CAAC;AAAA,EACpC;AAAA,EAEA,OAAc,WAAW,GAAoC;AAC3D,QAAI;AACF,aAAO,OAAO,MAAM,IAAI,UAAS,CAAC,CAAC;AAAA,IACrC,SAAS,GAAG;AACV,aAAO,OAAO,KAAK,CAAU;AAAA,IAC/B;AAAA,EACF;AACF;AAEA,IAAI,YAAY,QAAQ;AACtB,QAAM,EAAE,UAAU,IAAI,OAAO,IAAI,YAAY;AAC7C,WAAS,YAAY,MAAM;AACzB,OAAG,oCAAoC,YAAY;AACjD,YAAM,WAAW,MAAM,SAAS,SAAS,kBAAkB;AAC3D,aAAO,SAAS,SAAS,CAAC,EAAE,KAAK,IAAI;AACrC,aAAO,SAAS,MAAM,CAAC,EAAE,KAAK,kCAAkC;AAAA,IAClE,CAAC;AAAA,EACH,CAAC;AACH;",
   "names": []
 }