Documentation for the current opentxs protocol. The transport is described in Transport.
The directory content/doctypes/ contains descriptions of
the XML structures that are created by opentxs. The format is described in
Document Types.
- Base Document Type
<Contract> - Document Type
<notaryProviderContract> - Document Type
<digitalAssetContract> - Document Type
<OTuser> - Document Type
<OTmessage> - Document Type
<accountLedger> - Document Type
<transaction> - Document Type
<item> - Document Type
<assetAccount>
The files in the directory content/docs/ summarize the
parsing, serialization and transport methods in opentxs.
- OTASCIIArmor
- OTContract
- Description of Client sending to Server
- Description of Server receiving from Client
Significant changes to the code follow a process using MEP documents
(Monetas Enhancement Proposals), stored in the mep
directory.
The documentation can be rendered offline by means of the
Hugo static generator, v. 0.12 or greater. Install it, run
the hugo command in the top level directory of the repo, and a static website
will be generated in the public directory.
You can also run the hugo server command and point a browser at
http://localhost:1313/.
FIXME: links among documents are currently broken in the rendered website.
All documentation is written in Markdown. To help readability of text and diffs please hard-wrap text at 72 chars, and code blocks at 79.
Please use links to commit hashes, not to branches (hit the y key if you are
looking at a file on Github to get a stable link).