Skip to content

feat(contract): add contract 1.0 model #197

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.

Sign up for GitHub

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

Open
niallroche wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(contract): add contract 1.0 model #197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions src/accordproject/contract@1.0.0.cto
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

concerto version "^3.0.0"

namespace org.accordproject.contract@1.0.0

import org.accordproject.crypto@1.0.0.ContentHash from https://models.accordproject.org/crypto/crypto@1.0.0.cto

/**
* The role of a named artifact within a template archive.
*/
enum TemplateArtifactRole {
o LOGIC
o MODEL
o GRAMMAR
o PROSE
o DOCUMENTATION
o TEST
o RESOURCE
o CUSTOM
}

/**
* A named, hash-addressed artifact contained in a template archive.
*
* For executable logic, name and path can identify an entry point such as
* "logic.ts" while language and runtime describe how it is executed. The
* content hash ensures that an evaluation can identify the exact artifact,
* independently of the archive-level hash.
*/
concept TemplateArtifact {
o String name
o TemplateArtifactRole role
o String customRole optional
o String path
o String language optional
o String runtime optional
o Boolean entryPoint default=false
o ContentHash contentHash
}

/**
* A reference to the immutable template archive used to create an agreement.
*
* archiveHash commits to the complete archive. artifactManifestHash commits to
* the canonical manifest of named artifacts when the archive supplies one.
* Profiles which populate artifacts should define the manifest canonicalization
* and require the list to agree with artifactManifestHash.
*/
concept TemplateReference {
Comment thread
mttrbrts marked this conversation as resolved.
o String identifier
o String version
o ContentHash archiveHash
o ContentHash artifactManifestHash optional
o TemplateArtifact[] artifacts optional
}

/**
* Portable provenance for an instantiated agreement.
*
* agreementId maps to Contract.contractId when the complete Contract asset is
* available. clauseId and clauseHash identify a specific originating clause
* when a downstream record needs finer-grained provenance.
*/
concept AgreementReference {
Comment thread
mttrbrts marked this conversation as resolved.
o String agreementId
o ContentHash agreementHash
o TemplateReference template
o String clauseId optional
o ContentHash clauseHash optional
}

/**
* Contract data for an instantiated agreement.
*
* agreementHash commits to the canonical agreement representation, excluding
* the agreementHash property itself. template identifies the reusable archive
* from which the agreement was created.
*/
abstract asset Contract identified by contractId {
o String contractId
o ContentHash agreementHash
o TemplateReference template
}

/**
* An identifiable clause in a contract.
*/
abstract asset Clause identified by clauseId {
o String clauseId
o ContentHash clauseHash optional

@mttrbrts mttrbrts Aug 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing Template reference?

@niallroche niallroche Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes—good catch @mttrbrts , although I want to distinguish a clause’s source template from an enclosing contract template.
As in our current model a clause may be authored independently, maintained in a clause bank, and reused by multiple contract templates. A clause should therefore optionally identify its own source template rather than inherit provenance from whichever contract happens to use it.
Here is what I propose:

abstract asset Clause identified by clauseId {
  o String clauseId
  o ContentHash clauseHash optional
  o TemplateReference sourceTemplate optional
}

I have added sourceTemplate that identifies an independently versioned clause template or archive when one exists. It does not identify the contract templates that subsequently incorporate the clause.
The field is optional because a standalone or directly authored clause may not have been produced from a template at all. In serialised data, the property would be omitted rather than represented as null.

A contract template that consumes a banked clause should record that composition in its own manifest or composition metadata. I don't think it makes sense for a reusable clause should not maintain a changing list of every template that uses it. We could maybe build some tooling to aggregate this if needed

}