@fairmint/open-captable-protocol-daml-js 0.3.25 → 0.3.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,5 +1,74 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Open Cap Table Protocol DAML
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This repository implements the
|
|
4
|
+
[Open Cap Format (OCF)](https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF) as DAML
|
|
5
|
+
contracts for Canton. It also publishes generated JavaScript bindings and the built OpenCapTable DAR
|
|
6
|
+
as
|
|
7
|
+
[`@fairmint/open-captable-protocol-daml-js`](https://www.npmjs.com/package/@fairmint/open-captable-protocol-daml-js).
|
|
4
8
|
|
|
5
|
-
|
|
9
|
+
## Install and use the package
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @fairmint/open-captable-protocol-daml-js
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
The browser-safe root entry point exports the generated OpenCapTable namespace, bundled DAML/Splice
|
|
16
|
+
dependencies, and the three entry-point template IDs:
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
import { Fairmint, OCP_TEMPLATES } from '@fairmint/open-captable-protocol-daml-js';
|
|
20
|
+
|
|
21
|
+
const { OpenCapTable } = Fairmint;
|
|
22
|
+
const capTableTemplateId = OCP_TEMPLATES.capTable;
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The package also exposes stable subpaths for deployment metadata and the DAR:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import factoryIds from '@fairmint/open-captable-protocol-daml-js/ocp-factory-contract-id.json';
|
|
29
|
+
import {
|
|
30
|
+
getOpenCapTableDarPath,
|
|
31
|
+
resolveOpenCapTableDarPath,
|
|
32
|
+
} from '@fairmint/open-captable-protocol-daml-js/openCapTableDarPath';
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The DAR itself is exported at `@fairmint/open-captable-protocol-daml-js/opencaptable.dar`. Check
|
|
36
|
+
[`package.json`](https://github.com/Fairmint/open-captable-protocol-daml/blob/main/package.json) for
|
|
37
|
+
the complete export map and
|
|
38
|
+
[`scripts/test-imports.ts`](https://github.com/Fairmint/open-captable-protocol-daml/blob/main/scripts/test-imports.ts)
|
|
39
|
+
for the executable package-surface contract. `resolveOpenCapTableDarPath` checks
|
|
40
|
+
`OPEN_CAP_TABLE_DAR_PATH`, then the packaged DAR, then optional local-checkout paths; see its
|
|
41
|
+
[`source and options`](https://github.com/Fairmint/open-captable-protocol-daml/blob/main/scripts/npm-published-lib/openCapTableDarPath.ts)
|
|
42
|
+
for exact resolution behavior.
|
|
43
|
+
|
|
44
|
+
## Public documentation
|
|
45
|
+
|
|
46
|
+
The public [GitHub wiki](https://github.com/Fairmint/open-captable-protocol-daml/wiki) is the
|
|
47
|
+
canonical guide for contract architecture, OCF validation, development, testing, DAR backup, and
|
|
48
|
+
release policy. The active package's
|
|
49
|
+
[`daml.yaml`](https://github.com/Fairmint/open-captable-protocol-daml/blob/main/OpenCapTable-v34/daml.yaml),
|
|
50
|
+
[`multi-package.yaml`](https://github.com/Fairmint/open-captable-protocol-daml/blob/main/multi-package.yaml),
|
|
51
|
+
[`package.json`](https://github.com/Fairmint/open-captable-protocol-daml/blob/main/package.json),
|
|
52
|
+
and [`scripts/`](https://github.com/Fairmint/open-captable-protocol-daml/tree/main/scripts) remain
|
|
53
|
+
the source of truth for current versions, dependencies, and automation.
|
|
54
|
+
|
|
55
|
+
## Build and validate
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
git submodule update --init --recursive
|
|
59
|
+
npm install
|
|
60
|
+
scripts/install-dpm-sdks.sh
|
|
61
|
+
npm run build
|
|
62
|
+
npm test
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
When generated bindings or the published npm surface are affected, also run:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm run codegen
|
|
69
|
+
npm run verify-package
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
See
|
|
73
|
+
[Development and Testing](https://github.com/Fairmint/open-captable-protocol-daml/wiki/Development-and-Testing)
|
|
74
|
+
for the generated-file boundary and specialized checks.
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
* Node `fs`; not re-exported from the package root so browser/Next bundles stay valid).
|
|
4
4
|
*
|
|
5
5
|
* @remarks
|
|
6
|
-
* User-facing documentation for
|
|
7
|
-
*
|
|
6
|
+
* User-facing documentation for the packaged DAR and local development lives in the public wiki:
|
|
7
|
+
* https://github.com/Fairmint/open-captable-protocol-daml/wiki/Development-and-Testing
|
|
8
8
|
*/
|
|
9
9
|
/** Env var: absolute or cwd-relative path to a `.dar` file; checked first when set. */
|
|
10
10
|
export declare const OPEN_CAP_TABLE_DAR_PATH_ENV: "OPEN_CAP_TABLE_DAR_PATH";
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
* Node `fs`; not re-exported from the package root so browser/Next bundles stay valid).
|
|
5
5
|
*
|
|
6
6
|
* @remarks
|
|
7
|
-
* User-facing documentation for
|
|
8
|
-
*
|
|
7
|
+
* User-facing documentation for the packaged DAR and local development lives in the public wiki:
|
|
8
|
+
* https://github.com/Fairmint/open-captable-protocol-daml/wiki/Development-and-Testing
|
|
9
9
|
*/
|
|
10
10
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
11
11
|
if (k2 === undefined) k2 = k;
|
|
@@ -151,7 +151,7 @@ function resolveOpenCapTableDarPath(options) {
|
|
|
151
151
|
hints.push('No DAR at ../open-captable-protocol-daml/published-dars/OpenCapTable.dar.');
|
|
152
152
|
}
|
|
153
153
|
else {
|
|
154
|
-
hints.push('Tip: set OPEN_CAP_TABLE_DAR_PATH, or pass siblingSearchFrom / siblingDarPath for monorepo
|
|
154
|
+
hints.push('Tip: set OPEN_CAP_TABLE_DAR_PATH, or pass siblingSearchFrom / siblingDarPath for monorepo development.');
|
|
155
155
|
}
|
|
156
156
|
const msg = [base, hints.length ? ` ${hints.join(' ')}` : ''].join('');
|
|
157
157
|
if (packagedCause instanceof Error) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openCapTableDarPath.js","sourceRoot":"","sources":["../scripts/npm-published-lib/openCapTableDarPath.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+EH,wDASC;AAYD,gEAmDC;AArJD,uCAAyB;AACzB,2CAA6B;AAE7B,uFAAuF;AAC1E,QAAA,2BAA2B,GAAG,yBAAkC,CAAC;AAE9E;;;;GAIG;AACU,QAAA,iCAAiC,GAAG,oBAA6B,CAAC;AAE/E;;;GAGG;AACH,MAAM,4BAA4B,GAAG;IACnC,IAAI;IACJ,6BAA6B;IAC7B,gBAAgB;IAChB,kBAAkB;CACV,CAAC;AAeX,SAAS,cAAc;IACrB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,mCAA2B,CAAC,EAAE,IAAI,EAAE,CAAC;IAC7D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;IAC/E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,GAAG,mCAA2B,8BAA8B,QAAQ,UAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CACrG,CAAC;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,uBAAuB,CAAC,OAA0C;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;IAC/C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,SAAS,iBAAiB,CAAC,iBAAyB;IAClD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,4BAA4B,CAAC,CAAC;IAC1E,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IACjF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,iCAAiC,OAAO,IAAI;YAC1C,yGAAyG,CAC5G,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,0BAA0B,CAAC,OAA2C;IACpF,MAAM,IAAI,GAAG,OAAO,IAAI,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC;IAC9C,IAAI,SAAS,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,EAAE,EAAE,CAAC;QAChF,MAAM,IAAI,KAAK,CACb,iHAAiH,CAClH,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,sBAAsB,EAAE,CAAC;IAClC,CAAC;IAAC,OAAO,aAAa,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;QAC5C,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,aAAa,YAAY,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC5F,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,KAAK,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;QAC1F,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CACR,
|
|
1
|
+
{"version":3,"file":"openCapTableDarPath.js","sourceRoot":"","sources":["../scripts/npm-published-lib/openCapTableDarPath.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+EH,wDASC;AAYD,gEAmDC;AArJD,uCAAyB;AACzB,2CAA6B;AAE7B,uFAAuF;AAC1E,QAAA,2BAA2B,GAAG,yBAAkC,CAAC;AAE9E;;;;GAIG;AACU,QAAA,iCAAiC,GAAG,oBAA6B,CAAC;AAE/E;;;GAGG;AACH,MAAM,4BAA4B,GAAG;IACnC,IAAI;IACJ,6BAA6B;IAC7B,gBAAgB;IAChB,kBAAkB;CACV,CAAC;AAeX,SAAS,cAAc;IACrB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,mCAA2B,CAAC,EAAE,IAAI,EAAE,CAAC;IAC7D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;IAC/E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,GAAG,mCAA2B,8BAA8B,QAAQ,UAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CACrG,CAAC;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,uBAAuB,CAAC,OAA0C;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;IAC/C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,SAAS,iBAAiB,CAAC,iBAAyB;IAClD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,4BAA4B,CAAC,CAAC;IAC1E,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IACjF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,iCAAiC,OAAO,IAAI;YAC1C,yGAAyG,CAC5G,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,0BAA0B,CAAC,OAA2C;IACpF,MAAM,IAAI,GAAG,OAAO,IAAI,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC;IAC9C,IAAI,SAAS,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,EAAE,EAAE,CAAC;QAChF,MAAM,IAAI,KAAK,CACb,iHAAiH,CAClH,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,sBAAsB,EAAE,CAAC;IAClC,CAAC;IAAC,OAAO,aAAa,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;QAC5C,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,aAAa,YAAY,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC5F,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,KAAK,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;QAC1F,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CACR,wGAAwG,CACzG,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvE,IAAI,aAAa,YAAY,KAAK,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,GAAG,CAA6B,CAAC;YACvD,GAAG,CAAC,KAAK,GAAG,aAAa,CAAC;YAC1B,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fairmint/open-captable-protocol-daml-js",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.26",
|
|
4
4
|
"description": "Open CapTable Protocol (OpenCapTable-v34) DAML contracts with generated JavaScript bindings. Other Fairmint DAML packages live in @fairmint/daml-js.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"daml",
|