List of Classes - Revision history

FellowTraveler: chaumian

2013-09-18T23:41:56Z

chaumian

FellowTraveler: updated otpseudonym

2013-06-24T16:51:31Z

updated otpseudonym

FellowTraveler: finished out the descriptions for the various library classes.

2013-06-24T16:20:47Z

finished out the descriptions for the various library classes.

FellowTraveler: fixed newlines

2013-06-21T11:33:46Z

fixed newlines

FellowTraveler: updated with more descriptions for the newer classes

2013-06-21T11:32:04Z

updated with more descriptions for the newer classes

Show changes

FellowTraveler: added spacing

2013-06-18T00:19:17Z

added spacing

FellowTraveler: added more classes to the list (not done)

2013-06-17T11:55:13Z

added more classes to the list (not done)

Show changes

FellowTraveler: removed old link

2013-06-13T19:26:59Z

removed old link

Cryptoman at 16:34, 11 June 2013

2013-06-11T16:34:21Z

Cryptoman: Created page with "Open Transactions is, at its core, a class library. I hope to have documentation for all these classes sometime soon. In the meantime, be sure to read the [[API|detailed note..."

2013-06-11T16:33:12Z

Created page with "Open Transactions is, at its core, a class library. I hope to have documentation for all these classes sometime soon. In the meantime, be sure to read the [[API|detailed note..."

New page

Open Transactions is, at its core, a class library. I hope to have documentation for all these classes sometime soon.

In the meantime, be sure to read the [[API|detailed notes on the API]] and the [[Use Cases]] for the API.

USER / PSEUDONYM
 '''OTPseudonym''' -- Primarily a key pair. (Public/private keys.) Used as an identity; also manages lists of request numbers and transaction numbers for that identity on various OT servers. Often used for signing and verifying signatures on contracts. ''A pseudonym may have many asset accounts. A pseudonym may be registered on multiple servers.''
 '''OTIdentifier''' -- A 256-bit hash, usually of a public key or a contract, displayed as Base62. (The Nym's ID is a hash of his public key. An Asset Type's ID is the hash of its asset contract. The Server ID is a hash of the server contract. Etc.)

CONTRACTS / INSTRUMENTS
 '''OTContract''' -- Most other classes are derived from this one. Contains the actual XML contents, as well as various data values that were loaded from those contents, including public keys. Also contains a list of signatures.
 '''OTScriptable''' -- Derived from OTContract, but enables scriptable clauses. Also contains a list of parties (each with agents and asset accounts) as well as a list of bylaws (each with scripted clauses, internal state, hooks, callbacks, etc.)
 '''OTServerContract''' -- Derived from OTContract. Specific to an OT server.
 '''OTAssetContract''' -- Derived from OTContract. Specific to an ASSET TYPE. (May be registered on multiple servers.)
 '''OTBasket''' -- Used in basket currencies. Derived from OTContract.
 '''OTInstrument''' -- Has a date range, a server ID, and an asset ID. Derived from OTScriptable.
 '''OTTrackable''' -- Has a transaction number, user ID, and an asset account ID. Derived from OTInstrument.
 '''OTCheque''' -- A financial instrument. Derived from OTTrackable.
 '''OTCronItem''' -- Derived from OTTrackable. OT has a central "Cron" object which runs recurring tasks, known as CronItems.
 '''OTAgreement''' -- Derived from OTCronItem. It has a recipient and recipient asset account.
 '''OTPaymentPlan''' -- Derived from OTAgreement. Allows merchants and customers to set up recurring payments. (Cancel anytime, with a receipt going to both inboxes.)
 '''OTOffer''' -- Derived from OTInstrument. An OTMarket has a list of these.
 '''OTTrade''' -- Derived from OTCronItem. These correspond to offers on the market. Anytime an offer processes on the market against another offer (a "trade") then the quantities are updated here and saved as the latest cron receipt (with a copy going to your inbox, along with a copy of your original signed market offer.)
 '''OTSmartContract''' -- Derived from OTCronItem. All CronItems are actually derived from OTScriptable already (through OTTrackable/OTInstrument). But OTSmartContract is the first/only Cron Item specifically designed to take full advantage of both the cron system AND the scriptable system in conjunction with each other. Currently OTSmartContract is the only actual server-side scripting on OT.

DIGITAL CASH
 '''OTMint''' -- There is a different mint for each asset type, plus a new version of that mint replaces the old version, whenever a new series of the currency is rotated in. (This is necessary to allow the server operator to occasionally destroy the spent token database, which would otherwise continue growing forever, with the operator forced to maintain it forever.)
 '''OTToken''' -- A basic unit of untraceable digital cash. Tokens have denominations (1, 5, 10, 25, 100, etc) and OTToken works together with OTMint. All of the Lucre code in OT resides in these two classes. (Coin, Bank, PublicBank, etc.)
 '''OTPurse''' -- Since an OTToken can only have a set denominational amount (1, 5, 10, etc), it is necessary to carry purses full of tokens, in order to withdraw exactly the correct amount that you require (such as 8734, or 98, or 139, etc.) Thus, OT users will more commonly interact with purses than with actual tokens.

NUMBERED ACCOUNTS / SIGNED RECEIPTS
 '''OTTransactionType''' -- This is the base class for OTLedger, OTTransaction, OTItem, and OTAccount. Derived from OTContract.
 '''OTLedger''' -- Contains a list of transactions. Used in messages, and also used for inbox/outbox.
 '''OTTransaction''' -- The basic transactional unit, including a transaction number(s), and a list of transaction items.
 '''OTItem''' -- OTTransaction contains a list of these. (Usually two.) There might be a withdrawal item and a balance agreement item. Or a deposit item and a balance agreement item. Or a transfer item and a balance agreement item. Etc. (All transactions require a balance agreement.)
 '''OTAccount''' -- The class that handles the intermediary file for account balances.

CRYPTO UTILITY CLASSES
 '''OTEnvelope''' -- Encrypts/decrypts a piece of data (usually an OTASCIIArmor) using a Nym's private and public keys.
 '''OTPassword''' -- OT is endeavoring to use secure password storage in RAM.
 '''OTSymmetricKey''' -- For password-based crypto.
 '''OTAsymmetricKey''' -- An OTPseudonym has a public/private key pair.
 '''OTSignature''' -- An OTContract has a list of these.
 '''OTASCIIArmor''' -- Takes string or binary data, and then packs it, compresses it, base-64 encodes it, and returns as a base64-encoded string. Derived from OTString.
 '''OTSignedFile''' -- Uses a Nym to sign any content, and then stores it as an OT contract, including the file path information inside the contract as well.
 '''OTCachedKey''' -- The private keys of the Nyms in the wallet are encrypted to the cached master key (as their "passphrase".) The cached key itself is randomly generated and then kept encrypted to a symmetric key from a key derivation algorithm (from the user's passphrase.) It uses threads to erase the cleartext portion of the cached key after X seconds have passed. The user will be forced to enter his passphrase again after X seconds.
 '''OTCrypto''' -- I've started the process of moving all OpenSSL-specific code into "OTCryptoOpenSSL" which is derived from OTCrypto and accessed as OTCrypto::It(). This will make it easier, in the future, to swap other crypto libs in and out of OT.
 '''OTKeyring''' -- If configured to do so, OT will cache the derived key (used in OTCachedKey, above, to unlock the actual cached master key) using the system keyring. Currently supporting: gnome-keyring, Mac Keychain, KDE KWallet, and Windows DPAPI.

We should always endeavor to use standard protected memory APIs and authentication agents (such as gpg-agent and ssh-agent.) We will endeavor to use our own crypto as a separate layer, wherever possible. We will endeavor to use random memory layout, and code obfuscation, stack smashing protection, static and dynamic analysis, clean out the buffer overflows etc. Security never stops!

CLIENT
 '''OTClient''' -- The primary class on the client side.
 '''OTServerConnection''' -- Manages the client's connection to a specific OT server.
 '''OTWallet''' -- Manages client-side list of Nyms, Asset Contracts, Server Contracts, and Accounts.

SERVER
 '''OTServer''' -- The main class for the OT transaction server (transaction.exe).
 '''OTClientConnection''' -- Manages a single client connection to that server.
 '''OTCron''' -- Manages a list of Cron Items (that process their terms on a regular basis, including payment plans, market trades, and who knows, maybe someday: Ripple orders.)
 '''OTMarket''' -- Manages a list of active offers, and processes trades between them. There may be many markets on any given OTServer. Derived from OTContract.

FOR THE PROTOCOL
 '''OTMessage''' -- Derived from OTContract.
 '''OTMessageBuffer''' -- Contains a list of OTMessages.
 '''OTPayload''' -- Derived from OTData.

BASIC DATA TYPES
 '''OTData''' -- The base class for binary data in OT. (Like OTString, except for binary data.)
 '''OTString''' -- The basic string class for OT. (In the C++ language, the standard classes aren't meant to be used as "first class" classes, but need to be wrapped. OTString is built around its interface with other classes in the OT library, and it is easy to swap the internal string code later, without impacting anything else.)
 '''OTStringXML''' -- Derived from OTString. Used in conjunction with the XML library that OT currently uses for its XML contracts. (irrxml.)

@@ Line 64: / Line 64: @@
 DIGITAL CASH
 <br>'''OTMint''' -- There is a different mint for each asset type, plus a new version of that mint replaces the old version, whenever a new series of the currency is rotated in. (This is necessary to allow the server operator to occasionally destroy the spent token database, which would otherwise continue growing forever, with the operator forced to maintain it forever.)
-<br>'''OTToken''' -- A basic unit of untraceable digital cash. Tokens have denominations (1, 5, 10, 25, 100, etc) and OTToken works together with OTMint. All of the Lucre code in OT resides in these two classes. (Coin, Bank, PublicBank, etc.)
+<br>'''OTToken''' -- A basic unit of chaumian digital cash. Tokens have denominations (1, 5, 10, 25, 100, etc) and OTToken works together with OTMint. All of the Lucre code in OT resides in these two classes. (Coin, Bank, PublicBank, etc.)
 <br>'''OTPurse''' -- Since an OTToken can only have a set denominational amount (1, 5, 10, etc), it is necessary to carry purses full of tokens, in order to withdraw exactly the correct amount that you require (such as 8734, or 98, or 139, etc.) Thus, OT users will more commonly interact with purses than with actual tokens.
 <br>'''OTMint_Lucre	''' -- While OTMint is the abstract interface, this is the actual implementation for the token mint (using Lucre.)

@@ Line 19: / Line 19: @@
 USER / PSEUDONYM
-<br>'''OTPseudonym''' -- Primarily a key pair. (Public/private keys.) Used as an identity; also manages lists of request numbers and transaction numbers for that identity on various OT servers. Often used for signing and verifying signatures on contracts. ''A pseudonym may have many asset accounts. A pseudonym may be registered on multiple servers.''
+<br>'''OTPseudonym''' -- Used as an identity. Each user wallet may contain multiple Nyms. Each Nym may be registered at multiple servers. When contracts are signed or verified, it is the Nym performing these actions. Each Nym has master credentials, which issue sub-credentials, which contain key pairs for signing, encryption, and authentication. OTPseudonym also manages lists of request numbers and transaction numbers for that identity on various OT servers. A pseudonym may own many asset accounts.
 <br>'''OTIdentifier''' -- A 256-bit hash, usually of a public key or a contract, displayed as Base62. (The Nym's ID is a hash of his public key. An Asset Type's ID is the hash of its asset contract. The Server ID is a hash of the server contract. Etc.)
 <br>'''OTCredential''' -- This is the base class for credentials.

@@ Line 77: / Line 77: @@
 <br>'''OTItem''' -- OTTransaction contains a list of these. (Usually two.) There might be a withdrawal item and a balance agreement item. Or a deposit item and a balance agreement item. Or a transfer item and a balance agreement item. Etc. (All transactions require a balance agreement.)
 <br>'''OTAccount''' -- The class that handles the intermediary file for account balances.
-<br>'''OTAcctFunctor''' --
+<br>'''OTAcctFunctor''' -- Abstract base class for any operation that can be performed across a range of asset accounts.
-<br>'''OTAcctFunctor_PayDividend''' --
+<br>'''OTAcctFunctor_PayDividend''' -- Used for paying a dividend to shareholders. It iterates across all the asset accounts of a certain share type, and for each, sends a payment cheque to the account owner.
 ----------
@@ Line 143: / Line 143: @@
 <br>'''OTPayload''' -- Derived from OTData.
 <br>'''OTMessage''' -- Derived from OTContract.
-<br>'''OTMessageBuffer''' -- Contains a list of OTMessages.
+<br>'''OTMessageBuffer''' -- Contains a list of incoming OTMessages.
-<br>'''OTMessageOutbuffer''' -- Contains a list of outgoing messages.
+<br>'''OTMessageOutbuffer''' -- Contains a list of sent messages.
 ----------
@@ Line 156: / Line 156: @@
 DATABASE
-<br>'''OTDB::Storage''' --
+<br>'''OTDB::Storage''' -- The storage context (Abstract base class.)
-<br>'''OTDB::StorageFS''' --
+<br>'''OTDB::StorageFS''' -- Storage context (filesystem implementation.)
-<br>'''OTDB::Storable''' --
+<br>'''OTDB::Storable''' -- All "storable" objects are derived from this class. The OTDB::Storage class can save/retrieve these objects.
-<br>'''OTDB::OTPacker''' --
+<br>'''OTDB::OTPacker''' -- Abstract base class for the packer, which is used to pack storables before they are written to storage. Currently there are msgpack and protobuf implementations for this interface. (Protobuf being the one that is mostly used these days.)
-<br>'''OTDB::PackedBuffer''' --
+<br>'''OTDB::PackedBuffer''' -- The output from OTPacker that's written to local storage. Upon retrieval, this is the object that is unpacked in order to produce the original storable.
-<br>'''OTDB::OTDBString''' --
+<br>'''OTDB::OTDBString''' -- OTDB::Storage often writes/reads strings to/from local storage. This is the string storable.
-<br>'''OTDB::Blob''' --
+<br>'''OTDB::Blob''' -- OTDB::Storage often writes/reads blobs (Binary Large Objects) to/from local storage. This is the blob storable.
-<br>'''OTDB::StringMap''' --
+<br>'''OTDB::StringMap''' -- OTDB::Storage often writes/reads string maps (key/value pairs) to/from local storage. This is the string map storable.

@@ Line 6: / Line 6: @@
 HIGH-LEVEL API
 <br>'''OT_ME''' -- The ''high-level API,'' as used from C++. Used for sending messages back and forth with an OT server.
 <br>'''OTMadeEasy''' -- A SWIG wrapper for the high-level API. Used for all other languages, such as Python, C Sharp, PHP, etc.
@@ Line 13: / Line 12: @@
 LOW-LEVEL API
 <br>'''OT_API''' -- A C++ class that provides the ''lowest-level API'' (as a wrapper around this class library.)
 <br>'''OTAPI_Wrap''' -- The ''low-level API,'' as used in C++.
@@ Line 21: / Line 19: @@
 USER / PSEUDONYM
 <br>'''OTPseudonym''' -- Primarily a key pair. (Public/private keys.) Used as an identity; also manages lists of request numbers and transaction numbers for that identity on various OT servers. Often used for signing and verifying signatures on contracts. ''A pseudonym may have many asset accounts. A pseudonym may be registered on multiple servers.''
 <br>'''OTIdentifier''' -- A 256-bit hash, usually of a public key or a contract, displayed as Base62. (The Nym's ID is a hash of his public key. An Asset Type's ID is the hash of its asset contract. The Server ID is a hash of the server contract. Etc.)
@@ Line 34: / Line 31: @@
 UTILITY CLASSES
 <br>'''OTLog''' -- The OT logging class. Verbosity defaults to 0 but you can change it in the config file (up to level 5.)
 <br>'''OTCleanup''' -- This class is used to making sure specific objects are destroyed when it goes out of scope. (So we don't have to worry about cleanup for every single exist path from a function -- we know it will cleanup no matter how the function returns.)
@@ Line 48: / Line 44: @@
 CONTRACTS / INSTRUMENTS
 <br>'''OTContract''' -- Most other classes are derived from this one. Contains the actual XML contents, as well as various data values that were loaded from those contents, including public keys. Also contains a list of signatures.
 <br>'''OTScriptable''' -- Derived from OTContract, but enables scriptable clauses. Also contains a list of parties (each with agents and asset accounts) as well as a list of bylaws (each with scripted clauses, internal state, hooks, callbacks, etc.)
@@ Line 68: / Line 63: @@
 DIGITAL CASH
 <br>'''OTMint''' -- There is a different mint for each asset type, plus a new version of that mint replaces the old version, whenever a new series of the currency is rotated in. (This is necessary to allow the server operator to occasionally destroy the spent token database, which would otherwise continue growing forever, with the operator forced to maintain it forever.)
 <br>'''OTToken''' -- A basic unit of untraceable digital cash. Tokens have denominations (1, 5, 10, 25, 100, etc) and OTToken works together with OTMint. All of the Lucre code in OT resides in these two classes. (Coin, Bank, PublicBank, etc.)
@@ Line 78: / Line 72: @@
 NUMBERED ACCOUNTS / SIGNED RECEIPTS
 <br>'''OTTransactionType''' -- This is the base class for OTLedger, OTTransaction, OTItem, and OTAccount. Derived from OTContract.
 <br>'''OTLedger''' -- Contains a list of transactions. Used in messages, and also used for inbox/outbox.
@@ Line 90: / Line 83: @@
 CRYPTO UTILITY CLASSES
 <br>'''OTEnvelope''' -- Encrypts/decrypts a piece of data (usually an OTASCIIArmor) using a Nym's private and public keys.
 <br>'''OTPassword''' -- OT is endeavoring to use secure password storage in RAM.
@@ Line 114: / Line 106: @@
 SCRIPTING
 <br>'''OTScript''' -- The abstract base class for scripting in OT.
 <br>'''OTScriptChai''' -- Derived from OTScript. This contains the actual implementation where OT makes chaiscript-specific calls. New languages are very easy to add. If you wanted to add, say, Lua, just make a copy of OTScriptChai called OTScriptLua, and code it to use Lua calls instead of chai calls (done.)
@@ Line 121: / Line 112: @@
 SMART CONTRACTS
 <br>'''OTStash''' -- A stash is like an account hidden inside a smart contract. Smart contracts are able to ''"stash"'' funds internally, for use in scripts such as escrow and server wiring.
 <br>'''OTStashItem''' -- Used by OTStash. (Each named stash has a different storage account for each asset type.)
@@ Line 134: / Line 124: @@
 CLIENT
 <br>'''OTClient''' -- The primary class on the client side.
 <br>'''OTServerConnection''' -- Manages the client's connection to a specific OT server.
@@ Line 144: / Line 133: @@
 SERVER
 <br>'''OTServer''' -- The main class for the OT transaction server (transaction.exe).
 <br>'''OTClientConnection''' -- Manages a single client connection to that server.
@@ Line 153: / Line 141: @@
 FOR THE PROTOCOL
 <br>'''OTPayload''' -- Derived from OTData.
 <br>'''OTMessage''' -- Derived from OTContract.
@@ Line 162: / Line 149: @@
 BASIC DATA TYPES
 <br>'''OTData''' -- The base class for binary data in OT. (Like OTString, except for binary data.)
 <br>'''OTString''' -- The basic string class for OT. (In the C++ language, the standard classes aren't meant to be used as &quot;first class&quot; classes, but need to be wrapped. OTString is built around its interface with other classes in the OT library, and it is easy to swap the internal string code later, without impacting anything else.)
@@ Line 170: / Line 156: @@
 DATABASE
 <br>'''OTDB::Storage''' --
 <br>'''OTDB::StorageFS''' --

@@ Line 9: / Line 9: @@
 <br>'''OTAPI_Wrap''' -- The ''low-level API,'' as used in C++.
 <br>'''OTAPI_Basic''' -- The ''low-level API,'' as used in all other languages.
 USER / PSEUDONYM
@@ Line 20: / Line 22: @@
 <br>'''OTSubkey''' --
 <br>'''OTMasterkey''' --
 UTILITY CLASSES
@@ Line 31: / Line 35: @@
 <br>'''OTAcctList''' --
 <br>'''OTAmount''' --
 CONTRACTS / INSTRUMENTS
@@ Line 48: / Line 54: @@
 <br>'''OTSmartContract''' -- Derived from OTCronItem. All CronItems are actually derived from OTScriptable already (through OTTrackable/OTInstrument). But OTSmartContract is the first/only Cron Item specifically designed to take full advantage of both the cron system AND the scriptable system in conjunction with each other. Currently OTSmartContract is the only actual server-side scripting on OT.
 <br>'''OTPayment''' -- A useful wrapper class for generalizing instruments like OTCheque, OTSmartContract, OTPaymentPlan, and OTPurse.
 DIGITAL CASH
@@ Line 55: / Line 63: @@
 <br>'''OTMint_Lucre	''' -- While OTMint is the abstract interface, this is the actual implementation for the token mint (using Lucre.)
 <br>'''OTToken_Lucre''' -- While OTToken is the abstract interface, this is the actual implementation for blinded tokens (using Lucre.)
 NUMBERED ACCOUNTS / SIGNED RECEIPTS
@@ Line 64: / Line 74: @@
 <br>'''OTAcctFunctor''' --
 <br>'''OTAcctFunctor_PayDividend''' --
 CRYPTO UTILITY CLASSES
@@ Line 84: / Line 96: @@
 We should always endeavor to use standard protected memory APIs and authentication agents (such as gpg-agent and ssh-agent.) We will endeavor to use our own crypto as a separate layer, wherever possible. We will endeavor to use random memory layout, and code obfuscation, stack smashing protection, static and dynamic analysis, clean out the buffer overflows etc. Security never stops!
 SCRIPTING
 <br>'''OTScript''' --
 <br>'''OTScriptChai''' --
 SMART CONTRACTS
@@ Line 98: / Line 114: @@
 <br>'''OTPartyAccount''' --
 <br>'''OTAgent''' --
 CLIENT
@@ Line 105: / Line 123: @@
 <br>'''OTCallback''' --
 <br>'''OTCaller	''' --
 SERVER
@@ Line 111: / Line 131: @@
 <br>'''OTCron''' -- Manages a list of Cron Items (that process their terms on a regular basis, including payment plans, market trades, and who knows, maybe someday: Ripple orders.)
 <br>'''OTMarket''' -- Manages a list of active offers, and processes trades between them. There may be many markets on any given OTServer. Derived from OTContract.
 FOR THE PROTOCOL
@@ Line 117: / Line 139: @@
 <br>'''OTMessageBuffer''' -- Contains a list of OTMessages.
 <br>'''OTMessageOutbuffer''' -- Contains a list of outgoing messages.
 BASIC DATA TYPES
@@ Line 122: / Line 146: @@
 <br>'''OTString''' -- The basic string class for OT. (In the C++ language, the standard classes aren't meant to be used as &quot;first class&quot; classes, but need to be wrapped. OTString is built around its interface with other classes in the OT library, and it is easy to swap the internal string code later, without impacting anything else.)
 <br>'''OTStringXML''' -- Derived from OTString. Used in conjunction with the XML library that OT currently uses for its XML contracts. (irrxml.)
 DATABASE

@@ Line 1: / Line 1: @@
 Open Transactions is, at its core, a class library. I hope to have documentation for all these classes sometime soon.
-In the meantime, be sure to read the [[API|detailed notes on the API]] and the [[Use Cases]] for the API.
+In the meantime, be sure to read the [[API|detailed notes on the API]].
 <br>USER / PSEUDONYM