Documentation

DAR artifacts This directory records binary inputs and outputs that affect reproducibility, SCU compatibility, and operator vetting. - released/ contains immutable OpenZeppelin production DARs copied from tagged GitHub Releases. - vendor/ contains verified third-party DAR dependencies used for

Released OpenZeppelin DARs This directory contains the exact, checksummed production DARs attached to OpenZeppelin GitHub Releases, organized as: <package-name>/<package-version>/<package-name>-<package-version>.dar

Daml contract source - OpenZeppelin/canton-contracts/examples/licensing-app-v1-test/daml/Example/LicensingV1SandboxTest.daml module Example.LicensingV1SandboxTest where import Daml.Script (Script, script) import qualified Example.LicensingV1Test as App import qualified Example.LicensingV1Sec

Daml contract source - OpenZeppelin/canton-contracts/examples/licensing-app-v1-test/daml/Example/LicensingV1SecurityTest.daml module Example.LicensingV1SecurityTest where import DA.Assert ((===)) import DA.Date (Month(Jan), date) import DA.Foldable (forA_) import DA.Time (time) import qualif

Daml contract source - OpenZeppelin/canton-contracts/examples/licensing-app-v1-test/daml/Example/LicensingV1Test.daml module Example.LicensingV1Test where import DA.Assert ((===)) import Daml.Script import Example.LicensingV1 import qualified Example.LicensingV1.Policy as Policy import quali

Daml contract source - OpenZeppelin/canton-contracts/examples/licensing-app-v1/daml/Example/LicensingV1.daml -- | Integration example for OpenZeppelin.ScopedAuthorizationGrantV1. -- Example-only 0.x contracts; no upgrade compatibility is promised. module Example.LicensingV1 where import DA.F

Daml contract source - OpenZeppelin/canton-contracts/examples/licensing-app-v1/daml/Example/LicensingV1/Policy.daml -- | Authorization policy for the licensing application. module Example.LicensingV1.Policy where import qualified OpenZeppelin.ScopedAuthorizationGrantV1 as SAG data LicensingP

Licensing app V1 A licensor uses scoped authorization grants to let an operator issue licenses. The package imports the library through data-dependencies. Policy.daml defines the permission type and issuance scope; [LicensingV1.daml](daml/Example/Licen

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/registry-test/daml/OpenZeppelin/Examples/Pausable/RegistryTest.daml -- | Tests for Registry: a pause that records its reason, and an unpause -- that clears it. module OpenZeppelin.Examples.Pausable.RegistryTest where im

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/registry/daml/OpenZeppelin/Examples/Pausable/Registry.daml -- | Adoption of Pausable by a registry that serves -- CIP-0112 metadata. -- -- pauseReason and pauseUntil are fields of the registry. The flip choices -- s

Pausable Registry Example Adoption of Pausable by a registry that serves CIP-0112 metadata. The pause records why it is in force, in the same transaction as the flip. | Field | Value | |---|---| | Package | pausable-registry-example | | Module | OpenZeppelin.Examples.Pausable.Registry | | Te

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/retrofit-test/daml/OpenZeppelin/Examples/Pausable/RetrofitTest.daml -- | A template that adopts Pausable in its next SCU version, exercised -- through both package versions. module OpenZeppelin.Examples.Pausable.Retrofi

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/retrofit-v1-0/daml/OpenZeppelin/Examples/Pausable/Retrofit.daml -- | The template before it adopts Pausable: version 1.0.0. module OpenZeppelin.Examples.Pausable.Retrofit where template Account with admin : Party holder

Pausable Retrofit Baseline Version 1.0.0 of the account template used by the Pausable retrofit example. It supports withdrawals without a pause switch. Version 1.1.0 adds the Pausable interface and guards through Smart Contract Upgrade. The shared [retrofit-test](../retr

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/retrofit-v1-1/daml/OpenZeppelin/Examples/Pausable/Retrofit.daml module OpenZeppelin.Examples.Pausable.Retrofit where import DA.Optional (fromOptional) import OpenZeppelin.Api.PausableV1 (Pausable, PausableView (..)) impor

Pausable Retrofit Example A template that adopts Pausable in its next Smart Contract Upgrade (SCU) version. retrofit-v1-0 is version 1.0.0, without the switch. This package is version 1.1.0, which adds the flag and the interface instance. | Field | Value | |---|---| | P

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/vault-test/daml/OpenZeppelin/Examples/Pausable/VaultTest.daml -- | Tests for Vault: normal operation, an emergency stop, and the return to -- normal operation. module OpenZeppelin.Examples.Pausable.VaultTest where impor

Daml contract source - OpenZeppelin/canton-contracts/examples/pausable/vault/daml/OpenZeppelin/Examples/Pausable/Vault.daml -- | Minimal adoption of Pausable: a vault holding a -- balance for one owner, with an emergency stop that the admin controls. -- -- Adopting Pausable takes one tem

Pausable Vault Example Minimal adoption of Pausable: a vault that holds a balance for one owner, with an emergency stop that the admin controls. | Field | Value | |---|---| | Package | pausable-vault-example | | Module | OpenZeppelin.Examples.Pausable.Vault | | Tests | OpenZeppelin.Examples

Examples Integration examples show how to use the library in Daml applications. Each example builds separately and imports the library DAR through data-dependencies. Each example has a sibling -test package for Daml Script tests. See CONTRIBUTING.md for build and test com

Daml contract source - OpenZeppelin/canton-contracts/examples/token/token-cip112-custom-test/daml/OpenZeppelin/Examples/Token/Cip112/Custom/Test.daml -- | Drives OpenZeppelin.Examples.Token.Cip112.Custom through the Token Standard V2 interfaces and checks -- each consumer addition: the aud

Daml contract source - OpenZeppelin/canton-contracts/examples/token/token-cip112-custom/daml/OpenZeppelin/Examples/Token/Cip112/Custom.daml -- | A compliance-grade token that owns every template it deploys and reuses -- the OpenZeppelin CIP-0112 workflows unchanged. It depends on the types a

Custom token example A compliance-grade token that owns every template it deploys (MyHolding, MyTransferInstruction, MyAllocation, MyRules) and reuses the OpenZeppelin CIP-0112 workflows unchanged. It depends on openzeppelin-token-cip112-types-v1 and openzeppelin-token-cip112-utils onl

Daml contract source - OpenZeppelin/canton-contracts/examples/token/token-cip112-trading-test/daml/OpenZeppelin/Examples/Token/Cip112/Trading.daml -- | Integration demo for openzeppelin-token-cip112-v1, driven through the -- Token Standard V2 interfaces the way a wallet or settlement app d

Token CIP-0112 Trading Example Minimal integration of openzeppelin-token-cip112-v1: an exchange settling trades between two traders, driven entirely through the Token Standard V2 interfaces the way a wallet or settlement app drives any compliant registry. | Field | Value | |---|---| | Package |

Daml contract source - OpenZeppelin/canton-contracts/examples/treasury-rbac-v1-test/daml/Example/TreasuryRbacV1SandboxTest.daml module Example.TreasuryRbacV1SandboxTest where import Daml.Script (Script, script) import qualified Example.TreasuryRbacV1Test as App import qualified Example.Treas

Daml contract source - OpenZeppelin/canton-contracts/examples/treasury-rbac-v1-test/daml/Example/TreasuryRbacV1SecurityTest.daml module Example.TreasuryRbacV1SecurityTest where import DA.Assert ((===)) import DA.Date (Month(Jan), date) import DA.Foldable (forA_) import DA.Time (addRelTime, h

Daml contract source - OpenZeppelin/canton-contracts/examples/treasury-rbac-v1-test/daml/Example/TreasuryRbacV1Test.daml module Example.TreasuryRbacV1Test where import DA.Assert ((===)) import DA.Foldable (forA_) import Daml.Script import Example.TreasuryRbacV1 import qualified Example.Treas

Daml contract source - OpenZeppelin/canton-contracts/examples/treasury-rbac-v1/daml/Example/TreasuryRbacV1.daml -- | Application-specific treasury RBAC built from scoped authorization grants. -- Example-only 0.x contracts; migration and payment-ID uniqueness belong to the application. module

Daml contract source - OpenZeppelin/canton-contracts/examples/treasury-rbac-v1/daml/Example/TreasuryRbacV1/RolePolicy.daml -- | Role and authorization policy for the treasury application. module Example.TreasuryRbacV1.RolePolicy where import qualified OpenZeppelin.ScopedAuthorizationGrantV1