-
Notifications
You must be signed in to change notification settings - Fork 19
docs(canton): align with new canton-specs and canton-contracts repo structure #228
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
54021fa
6145334
5ebf104
74ff23a
61fbcd9
cb782ac
0b632a7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,10 +32,11 @@ OpenZeppelin's Canton library is distributed as Daml packages: each primitive is | |
| ```bash | ||
| git clone https://github.com/OpenZeppelin/canton-contracts.git | ||
| cd canton-contracts | ||
| dpm install package | ||
| dpm build --all | ||
| ``` | ||
|
|
||
| Each package's DAR lands in its own `.daml/dist/` directory (for example `pausable/.daml/dist/oz-pausable-0.1.0.dar`). | ||
| Library packages live under `packages/`, grouped by category (`packages/access/` for authorization and ownership, `packages/security/` for operational security). Each package's DAR lands in its own `.daml/dist/` directory (for example `packages/security/pausable-v1/.daml/dist/openzeppelin-pausable-v1-0.1.0.dar`). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since we'll be removing these packages from cc @ericnordelo
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you confirm the actual destination? I checked Either way, I think it's worth stating this explicitly in the |
||
|
|
||
| **2. Declare them as data-dependencies.** In your project's `daml.yaml`, reference the built DARs under `data-dependencies` (not `dependencies`, which is for the SDK's own libraries): | ||
|
|
||
|
|
@@ -48,9 +49,9 @@ dependencies: | |
| - daml-prim | ||
| - daml-stdlib | ||
| data-dependencies: | ||
| - ../canton-contracts/access-control/.daml/dist/oz-access-control-0.1.0.dar | ||
| - ../canton-contracts/ownable/.daml/dist/oz-ownable-0.1.0.dar | ||
| - ../canton-contracts/pausable/.daml/dist/oz-pausable-0.1.0.dar | ||
| - ../canton-contracts/packages/access/access-control-v1/.daml/dist/openzeppelin-access-control-v1-0.1.0.dar | ||
| - ../canton-contracts/packages/access/ownable-v1/.daml/dist/openzeppelin-ownable-v1-0.1.0.dar | ||
| - ../canton-contracts/packages/security/pausable-v1/.daml/dist/openzeppelin-pausable-v1-0.1.0.dar | ||
|
pepebndc marked this conversation as resolved.
Outdated
|
||
| build-options: | ||
| - --target=2.1 | ||
| ``` | ||
|
|
@@ -60,7 +61,7 @@ Adjust the paths to wherever you cloned the repo, and pin the exact versions fro | |
| **3. Import and build.** Import the modules you declared and build your project: | ||
|
|
||
| ```daml | ||
| import OpenZeppelin.Pausable | ||
| import OpenZeppelin.PausableV1 | ||
| ``` | ||
|
|
||
| ```bash | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| title: OpenZeppelin for Canton | ||
| --- | ||
|
|
||
| OpenZeppelin is building a suite of secure, reusable building blocks for the [Canton Network](https://www.canton.network/), the privacy-enabled network of applications built on [Daml](https://www.digitalasset.com/developers). This section is the home for OpenZeppelin's Canton documentation: the general-purpose library, the settlement primitive, and the Reference Implementations that show how they fit together. | ||
| OpenZeppelin is building a suite of secure, reusable building blocks for the [Canton Network](https://www.canton.network/), the privacy-enabled network of applications built on [Daml](https://docs.digitalasset.com/). This section is the home for OpenZeppelin's Canton documentation: the general-purpose library, the settlement primitive, and the Reference Implementations that show how they fit together. | ||
|
|
||
| <Callout type="info"> | ||
| The Canton ecosystem stack is under active development. Components are labelled | ||
|
|
@@ -21,7 +21,7 @@ Foundational Daml modules that other packages and applications compose on top of | |
|
|
||
| ## Settlement | ||
|
|
||
| - **[Settlement (CIP-112)](/canton/settlement)**: An experimental, interface-shaped settlement engine for atomic multi-leg, value-moving delivery-versus-payment, aligned with the Canton Token Standard. | ||
| - **[Settlement (CIP-112)](/canton/settlement)**: An experimental, interface-shaped settlement engine for atomic multi-leg, value-moving delivery-versus-payment, aligned with the Canton Token Standard. Developed as executable research in [`OpenZeppelin/canton-specs`](https://github.com/OpenZeppelin/canton-specs). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Aren't we moving this to
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. for now it's still in specs... will re-align when moved |
||
|
|
||
| ## Reference Implementations | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.