root / trunk / standards / protocol-containers.txt

***********************
* Protocol Containers *
***********************

This document gives the containers for all complex data formats used in
opencoin, including certificates, coins, blanks, and obfuscate blanks.

The format is
Name1 = {
    ContentName1 = Value1
    ContentName2 = Value2
    ContentName3 = Value3
    
    ExtraName1 = Value4
    ExtraName2 = Value5
}

ContentNames and ExtraNames are always seperated by a blank line.
ContentNames are required to be in all formats. ExtraNames are optional.

When refering to a part of a structure, Name1.ContentName1 refers to the
value of ContentName1 in Name1. Similarily, ContentName2 refers to the
value of ContentName2 in the same structure.

A special identifier, ContentPart is the combination of all ContentNames.

The identifier names in ContentNames and ExtraNames cannot be the same as
any other identifier.

---------------------------------------------------

================
= Certificates =
================

Currency Description Document (CCD) =
{
    standard identifier         = http://opencoin.org/OpenCoinProtocol/1.0
    currency identifier         = http://opencent.net/OpenCent
    short currency identifier   = OC 
    issuer service location     = opencoin://issuer.opencent.net:8002
    denominations               = ['1', '2', '5', ...] #list of strings
    issuer cipher suite         = HASH-ALG, SIGN-ALG, BLINDING-ALG
    options                     = list(options) | list()
    issuer public master key    = base64(pM)

    issuer                      = hash(pM)
    signature                   = base64(sig(sM,hash(content part)))
}


Mint Key =
{
    key identifier      = base64(hash(pP))
    currency identifier = http://opencent.net/OpenCent
    denomination        = denomination
    not_before          = TIME(...)
    key_not_after       = TIME(...)
    token_not_after     = TIME(...)
    public key          = base64(pP)

    issuer              = hash(pM)
    signature           = base64(sig(sM, hash(content part)))
}


---------------------------------------------------

==================
= Coins & Blanks =
==================

Blank = 
{
    standard identifier     = http://opencoin.org/OpenCoinProtocol/1.0
    currency identifier     = http://opencent.net/OpenCent 
    denomination            = denomination
    key identifier          = base64(hash((pP))
    serial                  = base64(128bit random number)
}


Coin = 
{
    standard identifier     = http://opencoin.org/OpenCoinProtocol/1.0
    currency identifier     = http://opencent.net/OpenCent 
    denomination            = denomination
    key identifier          = base64(hash(pP))
    serial                  = base64(128bit random number)
    
    signature               = base64(sig(pP, content part))
}