@open-captable-protocol/canton 0.0.28 → 0.0.30

package/README.md

@@ -0,0 +1,189 @@
+# OCP Canton SDK
+
+A TypeScript SDK for interacting with the Open CapTable Protocol (OCP) on Canton blockchain.
+
+## Installation
+
+```bash
+npm install @open-captable-protocol/canton
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { OcpClient } from '@open-captable-protocol/canton';
+
+const client = new OcpClient();
+```
+
+### Issuer Operations
+
+#### Get Issuer as OCF Object
+
+Retrieve an issuer contract by ID and convert it to the Open Cap Table Coalition (OCF) format.
+
+```typescript
+import { OcpClient } from '@open-captable-protocol/canton';
+
+const client = new OcpClient();
+
+// Get issuer as OCF object
+const result = await client.issuer.getIssuerAsOcf({
+  contractId: "1234567890abcdef"
+});
+
+console.log(result.issuer);
+// {
+//   object_type: "ISSUER",
+//   legal_name: "My Company Inc.",
+//   country_of_formation: "US",
+//   formation_date: "2020-01-15",
+//   // ... other fields according to OCF schema
+// }
+```
+
+The returned object follows the [OCF Issuer schema](https://schema.opencaptablecoalition.com/v/1.2.0/objects/Issuer.schema.json).
+
+#### Create Issuer
+
+```typescript
+const result = await client.issuer.createIssuer({
+  issuerAuthorizationContractDetails: {
+    contractId: "auth_contract_id",
+    createdEventBlob: "serialized_blob",
+    synchronizerId: "sync_id",
+    templateId: "template_id"
+  },
+  featuredAppRightContractDetails: {
+    contractId: "featured_contract_id",
+    createdEventBlob: "serialized_blob",
+    synchronizerId: "sync_id",
+    templateId: "template_id"
+  },
+  issuerParty: "issuer_party_id",
+  issuerData: {
+    legal_name: "My Company Inc.",
+    country_of_formation: "US",
+    formation_date: "2020-01-15"
+  }
+});
+```
+
+#### Update Issuer Data
+
+```typescript
+const result = await client.issuer.updateIssuerData({
+  issuerContractId: "issuer_contract_id",
+  newIssuerData: {
+    legal_name: "Updated Company Name",
+    country_of_formation: "US"
+  }
+});
+```
+
+#### Authorize Issuer
+
+```typescript
+const result = await client.issuer.authorizeIssuer({
+  issuer: "issuer_party_id"
+});
+```
+
+### Company Valuation Report Operations
+
+#### Create Company Valuation Report
+
+```typescript
+const result = await client.companyValuationReport.createCompanyValuationReport({
+  companyId: "company123",
+  companyValuation: "1000000",
+  observers: ["observer1", "observer2"],
+  featuredAppRightContractDetails: {
+    contractId: "featured_contract_id",
+    createdEventBlob: "serialized_blob",
+    synchronizerId: "sync_id",
+    templateId: "template_id"
+  }
+});
+```
+
+#### Update Company Valuation
+
+```typescript
+const result = await client.companyValuationReport.updateCompanyValuation({
+  companyValuationReportContractId: "report_contract_id",
+  newCompanyValuation: "1500000"
+});
+```
+
+#### Add Observers to Company Valuation Report
+
+```typescript
+const result = await client.companyValuationReport.addObserversToCompanyValuationReport({
+  companyValuationReportContractId: "report_contract_id",
+  added: ["new_observer1", "new_observer2"]
+});
+```
+
+## Scripts
+
+The SDK includes several utility scripts for common operations:
+
+### Get Issuer as OCF
+
+```bash
+npm run script:get-issuer-ocf <issuer-contract-id>
+```
+
+Or set the environment variable:
+```bash
+export ISSUER_CONTRACT_ID="your_contract_id"
+npm run script:get-issuer-ocf
+```
+
+### Create Issuer
+
+```bash
+npm run script:create-issuer <issuer-auth-contract-id> <legal-name> <country-of-formation> <issuer-auth-created-event-blob> <issuer-auth-synchronizer-id> <issuer-party-id> <featured-app-right-contract-id> <featured-app-right-created-event-blob> <featured-app-right-synchronizer-id> <featured-app-right-template-id>
+```
+
+### Authorize Issuer
+
+```bash
+npm run script:authorize <issuer-party-id>
+```
+
+## OCF Schema Compliance
+
+The `getIssuerAsOcf` function returns data that conforms to the [Open Cap Table Coalition Issuer schema](https://schema.opencaptablecoalition.com/v/1.2.0/objects/Issuer.schema.json). The function handles the conversion from DAML types to OCF format, including:
+
+- Converting DAML `Optional<T>` types to JavaScript `T | undefined`
+- Mapping field names from DAML conventions to OCF schema requirements
+- Ensuring all required fields are present
+- Using the contract ID as the OCF object ID
+
+## Development
+
+### Build
+
+```bash
+npm run build
+```
+
+### Development Mode
+
+```bash
+npm run dev
+```
+
+### Clean
+
+```bash
+npm run clean
+```
+
+## License
+
+MIT

package/dist/OcpClient.d.ts

@@ -1,11 +1,12 @@
 import { ClientConfig } from '@fairmint/canton-node-sdk';
-import { AuthorizeIssuerParams, AuthorizeIssuerResult, CreateIssuerParams, CreateIssuerResult, UpdateIssuerDataParams, UpdateIssuerDataResult, CreateCompanyValuationReportParams, CreateCompanyValuationReportResult, UpdateCompanyValuationParams, UpdateCompanyValuationResult, AddObserversToCompanyValuationReportParams, AddObserversToCompanyValuationReportResult } from './functions';
+import { AuthorizeIssuerParams, AuthorizeIssuerResult, CreateIssuerParams, CreateIssuerResult, UpdateIssuerDataParams, UpdateIssuerDataResult, GetIssuerAsOcfParams, GetIssuerAsOcfResult, CreateCompanyValuationReportParams, CreateCompanyValuationReportResult, UpdateCompanyValuationParams, UpdateCompanyValuationResult, AddObserversToCompanyValuationReportParams, AddObserversToCompanyValuationReportResult } from './functions';
 export declare class OcpClient {
     private client;
     issuer: {
         authorizeIssuer: (params: AuthorizeIssuerParams) => Promise<AuthorizeIssuerResult>;
         createIssuer: (params: CreateIssuerParams) => Promise<CreateIssuerResult>;
         updateIssuerData: (params: UpdateIssuerDataParams) => Promise<UpdateIssuerDataResult>;
+        getIssuerAsOcf: (params: GetIssuerAsOcfParams) => Promise<GetIssuerAsOcfResult>;
     };
     companyValuationReport: {
         createCompanyValuationReport: (params: CreateCompanyValuationReportParams) => Promise<CreateCompanyValuationReportResult>;

package/dist/OcpClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OcpClient.d.ts","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAmB,qBAAqB,EAAE,qBAAqB,EAAe,kBAAkB,EAAE,kBAAkB,EAAoB,sBAAsB,EAAE,sBAAsB,EAAgC,kCAAkC,EAAE,kCAAkC,EAAyB,4BAA4B,EAAE,4BAA4B,EAAyC,0CAA0C,EAAE,0CAA0C,EAAE,MAAM,aAAa,CAAC;AAE3gB,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAsB;IAE7B,MAAM,EAAE;QACb,eAAe,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACnF,YAAY,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC1E,gBAAgB,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;KACvF,CAAC;IAEK,sBAAsB,EAAE;QAC7B,4BAA4B,EAAE,CAC5B,MAAM,EAAE,kCAAkC,KACvC,OAAO,CAAC,kCAAkC,CAAC,CAAC;QACjD,sBAAsB,EAAE,CACtB,MAAM,EAAE,4BAA4B,KACjC,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAC3C,oCAAoC,EAAE,CACpC,MAAM,EAAE,0CAA0C,KAC/C,OAAO,CAAC,0CAA0C,CAAC,CAAC;KAC1D,CAAC;gBAEU,MAAM,CAAC,EAAE,YAAY;CAmBlC"}
+{"version":3,"file":"OcpClient.d.ts","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAmB,qBAAqB,EAAE,qBAAqB,EAAe,kBAAkB,EAAE,kBAAkB,EAAoB,sBAAsB,EAAE,sBAAsB,EAAkB,oBAAoB,EAAE,oBAAoB,EAAgC,kCAAkC,EAAE,kCAAkC,EAAyB,4BAA4B,EAAE,4BAA4B,EAAyC,0CAA0C,EAAE,0CAA0C,EAAE,MAAM,aAAa,CAAC;AAEvkB,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAsB;IAE7B,MAAM,EAAE;QACb,eAAe,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACnF,YAAY,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC1E,gBAAgB,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACtF,cAAc,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;KACjF,CAAC;IAEK,sBAAsB,EAAE;QAC7B,4BAA4B,EAAE,CAC5B,MAAM,EAAE,kCAAkC,KACvC,OAAO,CAAC,kCAAkC,CAAC,CAAC;QACjD,sBAAsB,EAAE,CACtB,MAAM,EAAE,4BAA4B,KACjC,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAC3C,oCAAoC,EAAE,CACpC,MAAM,EAAE,0CAA0C,KAC/C,OAAO,CAAC,0CAA0C,CAAC,CAAC;KAC1D,CAAC;gBAEU,MAAM,CAAC,EAAE,YAAY;CAoBlC"}

package/dist/OcpClient.js

@@ -9,7 +9,8 @@ class OcpClient {
         this.issuer = {
             authorizeIssuer: (params) => (0, functions_1.authorizeIssuer)(this.client, params),
             createIssuer: (params) => (0, functions_1.createIssuer)(this.client, params),
-            updateIssuerData: (params) => (0, functions_1.updateIssuerData)(this.client, params)
+            updateIssuerData: (params) => (0, functions_1.updateIssuerData)(this.client, params),
+            getIssuerAsOcf: (params) => (0, functions_1.getIssuerAsOcf)(this.client, params)
         };
         this.companyValuationReport = {
             createCompanyValuationReport: (params) => (0, functions_1.createCompanyValuationReport)(this.client, params),

package/dist/OcpClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"OcpClient.js","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":";;;AAAA,+DAA8E;AAC9E,2CAA2gB;AAE3gB,MAAa,SAAS;IAqBpB,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,CAAC,MAAM,GAAG;YACZ,eAAe,EAAE,CAAC,MAA6B,EAAE,EAAE,CAAC,IAAA,2BAAe,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YACxF,YAAY,EAAE,CAAC,MAA0B,EAAE,EAAE,CAAC,IAAA,wBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC/E,gBAAgB,EAAE,CAAC,MAA8B,EAAE,EAAE,CAAC,IAAA,4BAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;SAC5F,CAAC;QAEF,IAAI,CAAC,sBAAsB,GAAG;YAC5B,4BAA4B,EAAE,CAAC,MAA0C,EAAE,EAAE,CAC3E,IAAA,wCAA4B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YACnD,sBAAsB,EAAE,CAAC,MAAoC,EAAE,EAAE,CAC/D,IAAA,kCAAsB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC7C,oCAAoC,EAAE,CACpC,MAAkD,EAClD,EAAE,CAAC,IAAA,gDAAoC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;SAC/D,CAAC;IACJ,CAAC;CACF;AAxCD,8BAwCC"}
+{"version":3,"file":"OcpClient.js","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":";;;AAAA,+DAA8E;AAC9E,2CAAukB;AAEvkB,MAAa,SAAS;IAsBpB,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,CAAC,MAAM,GAAG;YACZ,eAAe,EAAE,CAAC,MAA6B,EAAE,EAAE,CAAC,IAAA,2BAAe,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YACxF,YAAY,EAAE,CAAC,MAA0B,EAAE,EAAE,CAAC,IAAA,wBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC/E,gBAAgB,EAAE,CAAC,MAA8B,EAAE,EAAE,CAAC,IAAA,4BAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC3F,cAAc,EAAE,CAAC,MAA4B,EAAE,EAAE,CAAC,IAAA,0BAAc,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;SACtF,CAAC;QAEF,IAAI,CAAC,sBAAsB,GAAG;YAC5B,4BAA4B,EAAE,CAAC,MAA0C,EAAE,EAAE,CAC3E,IAAA,wCAA4B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YACnD,sBAAsB,EAAE,CAAC,MAAoC,EAAE,EAAE,CAC/D,IAAA,kCAAsB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC7C,oCAAoC,EAAE,CACpC,MAAkD,EAClD,EAAE,CAAC,IAAA,gDAAoC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;SAC/D,CAAC;IACJ,CAAC;CACF;AA1CD,8BA0CC"}

package/dist/functions/issuer/createIssuer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createIssuer.d.ts","sourceRoot":"","sources":["../../../src/functions/issuer/createIssuer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAGhE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,kCAAkC,EAAE,eAAe,CAAC;IACpD,uEAAuE;IACvE,+BAA+B,EAAE,eAAe,CAAC;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC;CACvD;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CAoD7B"}
+{"version":3,"file":"createIssuer.d.ts","sourceRoot":"","sources":["../../../src/functions/issuer/createIssuer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAGhE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,kCAAkC,EAAE,eAAe,CAAC;IACpD,uEAAuE;IACvE,+BAA+B,EAAE,eAAe,CAAC;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC;CACvD;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CAiD7B"}

package/dist/functions/issuer/createIssuer.js

@@ -79,9 +79,6 @@ async function createIssuer(client, params) {
         throw new Error('Expected CreatedTreeEvent not found');
     }
     const issuerContractId = created.CreatedTreeEvent.value.contractId;
-    const issuerContractEvents = await client.getEventsByContractId({
-        contractId: issuerContractId
-    });
     return {
         contractId: issuerContractId,
         updateId: response.transactionTree.updateId

package/dist/functions/issuer/createIssuer.js.map

@@ -1 +1 @@
-{"version":3,"file":"createIssuer.js","sourceRoot":"","sources":["../../../src/functions/issuer/createIssuer.ts"],"names":[],"mappings":";;AA2DA,oCAuDC;AAlHD,6FAAoE;AAGpE,mEAA4E;AAkB5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACI,KAAK,UAAU,YAAY,CAChC,MAA2B,EAC3B,MAA0B;IAE1B,+CAA+C;IAC/C,MAAM,eAAe,GAA2D;QAC9E,WAAW,EAAE,MAAM,CAAC,UAAU;KAC/B,CAAC;IAEF,wDAAwD;IACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC;QAC5D,KAAK,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3B,QAAQ,EAAE;YACR;gBACE,eAAe,EAAE;oBACf,UAAU,EAAE,yCAAQ,CAAC,YAAY,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,UAAU;oBACpF,UAAU,EAAE,MAAM,CAAC,kCAAkC,CAAC,UAAU;oBAChE,MAAM,EAAE,cAAc;oBACtB,cAAc,EAAE,eAAe;iBAChC;aACF;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,UAAU,EAAE,MAAM,CAAC,kCAAkC,CAAC,UAAU;gBAChE,UAAU,EAAE,MAAM,CAAC,kCAAkC,CAAC,UAAU;gBAChE,gBAAgB,EAAE,MAAM,CAAC,kCAAkC,CAAC,gBAAgB;gBAC5E,cAAc,EAAE,MAAM,CAAC,kCAAkC,CAAC,cAAc;aACzE;YACD;gBACE,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;gBAC7D,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;gBAC7D,gBAAgB,EAAE,MAAM,CAAC,+BAA+B,CAAC,gBAAgB;gBACzE,cAAc,EAAE,MAAM,CAAC,+BAA+B,CAAC,cAAc;aACtE;SACF;KACF,CAA4C,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAA,+CAA4B,EAC1C,QAAQ,EACR,yCAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAC/C,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;IACnE,MAAM,oBAAoB,GAAG,MAAM,MAAM,CAAC,qBAAqB,CAAC;QAC9D,UAAU,EAAE,gBAAgB;KAC7B,CAAC,CAAA;IAEF,OAAO;QACL,UAAU,EAAE,gBAAgB;QAC5B,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,QAAQ;KAC5C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"createIssuer.js","sourceRoot":"","sources":["../../../src/functions/issuer/createIssuer.ts"],"names":[],"mappings":";;AA2DA,oCAoDC;AA/GD,6FAAoE;AAGpE,mEAA4E;AAkB5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACI,KAAK,UAAU,YAAY,CAChC,MAA2B,EAC3B,MAA0B;IAE1B,+CAA+C;IAC/C,MAAM,eAAe,GAA2D;QAC9E,WAAW,EAAE,MAAM,CAAC,UAAU;KAC/B,CAAC;IAEF,wDAAwD;IACxD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC;QAC5D,KAAK,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3B,QAAQ,EAAE;YACR;gBACE,eAAe,EAAE;oBACf,UAAU,EAAE,yCAAQ,CAAC,YAAY,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,UAAU;oBACpF,UAAU,EAAE,MAAM,CAAC,kCAAkC,CAAC,UAAU;oBAChE,MAAM,EAAE,cAAc;oBACtB,cAAc,EAAE,eAAe;iBAChC;aACF;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,UAAU,EAAE,MAAM,CAAC,kCAAkC,CAAC,UAAU;gBAChE,UAAU,EAAE,MAAM,CAAC,kCAAkC,CAAC,UAAU;gBAChE,gBAAgB,EAAE,MAAM,CAAC,kCAAkC,CAAC,gBAAgB;gBAC5E,cAAc,EAAE,MAAM,CAAC,kCAAkC,CAAC,cAAc;aACzE;YACD;gBACE,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;gBAC7D,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;gBAC7D,gBAAgB,EAAE,MAAM,CAAC,+BAA+B,CAAC,gBAAgB;gBACzE,cAAc,EAAE,MAAM,CAAC,+BAA+B,CAAC,cAAc;aACtE;SACF;KACF,CAA4C,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAA,+CAA4B,EAC1C,QAAQ,EACR,yCAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAC/C,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;IAEnE,OAAO;QACL,UAAU,EAAE,gBAAgB;QAC5B,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,QAAQ;KAC5C,CAAC;AACJ,CAAC"}

package/dist/functions/issuer/getIssuerAsOcf.d.ts

@@ -0,0 +1,70 @@
+import { LedgerJsonApiClient } from '@fairmint/canton-node-sdk';
+/**
+ * OCF Issuer object according to the Open Cap Table Coalition schema
+ * @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/Issuer.schema.json
+ */
+export interface OcfIssuer {
+    object_type: 'ISSUER';
+    legal_name: string;
+    dba?: string;
+    formation_date?: string;
+    country_of_formation: string;
+    country_subdivision_of_formation?: string;
+    tax_ids?: Array<{
+        tax_id_type: string;
+        tax_id: string;
+    }>;
+    email?: string;
+    phone?: string;
+    address?: {
+        line1?: string;
+        line2?: string;
+        city?: string;
+        state?: string;
+        postal_code?: string;
+        country?: string;
+    };
+    initial_shares_authorized?: string | number;
+    id?: string;
+    comments?: string[];
+}
+export interface GetIssuerAsOcfParams {
+    /** Contract ID of the Issuer contract to retrieve */
+    contractId: string;
+}
+export interface GetIssuerAsOcfResult {
+    /** The OCF Issuer object */
+    issuer: OcfIssuer;
+    /** The original contract ID */
+    contractId: string;
+}
+/**
+ * Retrieve an issuer contract by ID and return it as an OCF JSON object
+ *
+ * This function fetches the issuer contract data from the ledger and transforms it
+ * into the Open Cap Table Coalition (OCF) format according to the official schema.
+ *
+ * @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/Issuer.schema.json
+ *
+ * @example
+ * ```typescript
+ * const result = await getIssuerAsOcf(client, {
+ *   contractId: "1234567890abcdef"
+ * });
+ *
+ * console.log(result.issuer);
+ * // {
+ * //   object_type: "ISSUER",
+ * //   legal_name: "My Company Inc.",
+ * //   country_of_formation: "US",
+ * //   formation_date: "2020-01-15",
+ * //   // ... other fields
+ * // }
+ * ```
+ *
+ * @param client - The ledger JSON API client
+ * @param params - Parameters for retrieving the issuer
+ * @returns Promise resolving to the OCF Issuer object
+ */
+export declare function getIssuerAsOcf(client: LedgerJsonApiClient, params: GetIssuerAsOcfParams): Promise<GetIssuerAsOcfResult>;
+//# sourceMappingURL=getIssuerAsOcf.d.ts.map

package/dist/functions/issuer/getIssuerAsOcf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getIssuerAsOcf.d.ts","sourceRoot":"","sources":["../../../src/functions/issuer/getIssuerAsOcf.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,QAAQ,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAC1C,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,yBAAyB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,4BAA4B;IAC5B,MAAM,EAAE,SAAS,CAAC;IAClB,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,oBAAoB,CAAC,CAgE/B"}

package/dist/functions/issuer/getIssuerAsOcf.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIssuerAsOcf = getIssuerAsOcf;
+/**
+ * Retrieve an issuer contract by ID and return it as an OCF JSON object
+ *
+ * This function fetches the issuer contract data from the ledger and transforms it
+ * into the Open Cap Table Coalition (OCF) format according to the official schema.
+ *
+ * @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/Issuer.schema.json
+ *
+ * @example
+ * ```typescript
+ * const result = await getIssuerAsOcf(client, {
+ *   contractId: "1234567890abcdef"
+ * });
+ *
+ * console.log(result.issuer);
+ * // {
+ * //   object_type: "ISSUER",
+ * //   legal_name: "My Company Inc.",
+ * //   country_of_formation: "US",
+ * //   formation_date: "2020-01-15",
+ * //   // ... other fields
+ * // }
+ * ```
+ *
+ * @param client - The ledger JSON API client
+ * @param params - Parameters for retrieving the issuer
+ * @returns Promise resolving to the OCF Issuer object
+ */
+async function getIssuerAsOcf(client, params) {
+    // Get the events for the Issuer contract
+    const eventsResponse = await client.getEventsByContractId({
+        contractId: params.contractId
+    });
+    if (!eventsResponse.created?.createdEvent?.createArgument) {
+        throw new Error('Invalid contract events response: missing created event or create argument');
+    }
+    const createArgument = eventsResponse.created.createdEvent.createArgument;
+    // Type guard to ensure we have the expected issuer data structure
+    function hasIssuerData(arg) {
+        return typeof arg === 'object' &&
+            arg !== null &&
+            'issuer_data' in arg &&
+            typeof arg.issuer_data === 'object';
+    }
+    if (!hasIssuerData(createArgument)) {
+        throw new Error('Issuer data not found in contract create argument');
+    }
+    const issuerData = createArgument.issuer_data;
+    // Helper function to convert DAML Optional to JavaScript undefined
+    const toUndefined = (value) => value === null ? undefined : value;
+    // Transform DAML issuer data to OCF format
+    const ocfIssuer = {
+        object_type: 'ISSUER',
+        legal_name: issuerData.legal_name || '',
+        country_of_formation: issuerData.country_of_formation || '',
+        // Optional fields
+        ...(issuerData.dba && { dba: issuerData.dba }),
+        ...(issuerData.formation_date && { formation_date: issuerData.formation_date }),
+        ...(issuerData.country_subdivision_of_formation && {
+            country_subdivision_of_formation: issuerData.country_subdivision_of_formation
+        }),
+        ...(issuerData.tax_ids && { tax_ids: issuerData.tax_ids }),
+        ...(issuerData.email && { email: issuerData.email }),
+        ...(issuerData.phone && { phone: issuerData.phone }),
+        ...(issuerData.address && {
+            address: {
+                ...(issuerData.address.line1 && { line1: toUndefined(issuerData.address.line1) }),
+                ...(issuerData.address.line2 && { line2: toUndefined(issuerData.address.line2) }),
+                ...(issuerData.address.city && { city: toUndefined(issuerData.address.city) }),
+                ...(issuerData.address.state && { state: toUndefined(issuerData.address.state) }),
+                ...(issuerData.address.postal_code && { postal_code: toUndefined(issuerData.address.postal_code) }),
+                ...(issuerData.address.country && { country: toUndefined(issuerData.address.country) })
+            }
+        }),
+        ...(issuerData.initial_shares_authorized && {
+            initial_shares_authorized: issuerData.initial_shares_authorized
+        }),
+        // Use contract ID as the OCF object ID
+        id: params.contractId
+    };
+    return {
+        issuer: ocfIssuer,
+        contractId: params.contractId
+    };
+}
+//# sourceMappingURL=getIssuerAsOcf.js.map

package/dist/functions/issuer/getIssuerAsOcf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getIssuerAsOcf.js","sourceRoot":"","sources":["../../../src/functions/issuer/getIssuerAsOcf.ts"],"names":[],"mappings":";;AAyEA,wCAmEC;AA/FD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,cAAc,CAClC,MAA2B,EAC3B,MAA4B;IAE5B,yCAAyC;IACzC,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,qBAAqB,CAAC;QACxD,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC,CAAC;IAEH,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC;IAE1E,kEAAkE;IAClE,SAAS,aAAa,CAAC,GAAY;QACjC,OAAO,OAAO,GAAG,KAAK,QAAQ;YACvB,GAAG,KAAK,IAAI;YACZ,aAAa,IAAI,GAAG;YACpB,OAAQ,GAAW,CAAC,WAAW,KAAK,QAAQ,CAAC;IACtD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,UAAU,GAAG,cAAc,CAAC,WAAW,CAAC;IAE9C,mEAAmE;IACnE,MAAM,WAAW,GAAG,CAAI,KAAe,EAAiB,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;IAE9F,2CAA2C;IAC3C,MAAM,SAAS,GAAc;QAC3B,WAAW,EAAE,QAAQ;QACrB,UAAU,EAAE,UAAU,CAAC,UAAU,IAAI,EAAE;QACvC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,IAAI,EAAE;QAC3D,kBAAkB;QAClB,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC;QAC9C,GAAG,CAAC,UAAU,CAAC,cAAc,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,cAAc,EAAE,CAAC;QAC/E,GAAG,CAAC,UAAU,CAAC,gCAAgC,IAAI;YACjD,gCAAgC,EAAE,UAAU,CAAC,gCAAgC;SAC9E,CAAC;QACF,GAAG,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC;QAC1D,GAAG,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;QACpD,GAAG,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;QACpD,GAAG,CAAC,UAAU,CAAC,OAAO,IAAI;YACxB,OAAO,EAAE;gBACP,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjF,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjF,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9E,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjF,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACnG,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;aACxF;SACF,CAAC;QACF,GAAG,CAAC,UAAU,CAAC,yBAAyB,IAAI;YAC1C,yBAAyB,EAAE,UAAU,CAAC,yBAAyB;SAChE,CAAC;QACF,uCAAuC;QACvC,EAAE,EAAE,MAAM,CAAC,UAAU;KACtB,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC"}

package/dist/functions/issuer/index.d.ts

@@ -1,4 +1,5 @@
 export * from './authorizeIssuer';
 export * from './createIssuer';
 export * from './updateIssuerData';
+export * from './getIssuerAsOcf';
 //# sourceMappingURL=index.d.ts.map

package/dist/functions/issuer/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/issuer/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/issuer/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/dist/functions/issuer/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./authorizeIssuer"), exports);
 __exportStar(require("./createIssuer"), exports);
 __exportStar(require("./updateIssuerData"), exports);
+__exportStar(require("./getIssuerAsOcf"), exports);
 //# sourceMappingURL=index.js.map

package/dist/functions/issuer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/issuer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/issuer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,mDAAiC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-captable-protocol/canton",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "A TypeScript SDK for interacting with the Open CapTable Protocol (OCP) Factory contract on Canton blockchain",
   "license": "MIT",
   "main": "dist/index.js",
@@ -13,7 +13,8 @@
     "dev": "tsc --watch",
     "clean": "rm -rf dist",
     "script:authorize": "ts-node scripts/authorizeIssuer.ts",
-    "script:create-issuer": "ts-node scripts/createIssuer.ts"
+    "script:create-issuer": "ts-node scripts/createIssuer.ts",
+    "script:get-issuer-ocf": "ts-node scripts/getIssuerAsOcf.ts"
   },
   "dependencies": {
     "@daml/ledger": "^2.10.2",