diff --git a/annotated.html b/annotated.html index aa3491c..891fc8a 100644 --- a/annotated.html +++ b/annotated.html @@ -5,7 +5,7 @@ -oc-mint: Class List +oc-issuer: Class List @@ -21,8 +21,8 @@ -
oc-mint -  0.0.1 +
oc-issuer +  0.0.2
@@ -71,7 +71,7 @@ $(function() {  CBigInt  CBlind  CBlindSignature - CCDD + CCDDCurrency description document  CCDDC  ▼CCoin  CPayload @@ -82,7 +82,7 @@ $(function() {  CModel  CPublicKey  CRequestCDDC - CRequestCDDSerial + CRequestCDDCSerial  CRequestMint  CRequestMKCs  CRequestRedeem @@ -90,7 +90,7 @@ $(function() {  CRequestResume  CResponse  CResponseCDDC - CResponseCDDSerial + CResponseCDDCSerial  CResponseDelay  CResponseMint  CResponseMKCs diff --git a/big__int_8hpp_source.html b/big__int_8hpp_source.html index f6aebe4..05af9c1 100644 --- a/big__int_8hpp_source.html +++ b/big__int_8hpp_source.html @@ -5,7 +5,7 @@ -oc-mint: src/big_int.hpp Source File +oc-issuer: src/big_int.hpp Source File @@ -21,8 +21,8 @@ -
oc-mint -  0.0.1 +
oc-issuer +  0.0.2
diff --git a/classDefaultModel-members.html b/classDefaultModel-members.html index 6215ddb..ee8d3c7 100644 --- a/classDefaultModel-members.html +++ b/classDefaultModel-members.html @@ -5,7 +5,7 @@ -oc-mint: Member List +oc-issuer: Member List @@ -21,8 +21,8 @@ -
oc-mint -  0.0.1 +
oc-issuer +  0.0.2
@@ -70,12 +70,12 @@ $(function() {

This is the complete list of members for DefaultModel, including all inherited members.

- - - - - - + + + + + +
DefaultModel() (defined in DefaultModel)DefaultModelinline
getCDDC(unsigned int cdd_serial) override (defined in DefaultModel)DefaultModelinlinevirtual
getCurrentCDDC() override (defined in DefaultModel)DefaultModelinlinevirtual
getMKCs(const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids) override (defined in DefaultModel)DefaultModelinlinevirtual
getModel(const std::string &backend_name) (defined in Model)Modelstatic
mint(const std::string &transaction_reference, const std::vector< Blind > &blinds) override (defined in DefaultModel)DefaultModelinlinevirtual
redeem(const std::vector< Coin > &coins) override (defined in DefaultModel)DefaultModelinlinevirtual
getCDDC(unsigned int cdd_serial) overrideDefaultModelinlinevirtual
getCurrentCDDC() overrideDefaultModelinlinevirtual
getMKCs(const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids) overrideDefaultModelinlinevirtual
getModel(const std::string &backend_name)Modelstatic
mint(const std::string &transaction_reference, const std::vector< Blind > &blinds) overrideDefaultModelinlinevirtual
redeem(const std::vector< Coin > &coins) overrideDefaultModelinlinevirtual
~Model() (defined in Model)Modelinlinevirtual
diff --git a/classDefaultModel.html b/classDefaultModel.html index f78d710..03a87b5 100644 --- a/classDefaultModel.html +++ b/classDefaultModel.html @@ -5,7 +5,7 @@ -oc-mint: DefaultModel Class Reference +oc-issuer: DefaultModel Class Reference @@ -21,8 +21,8 @@ -
oc-mint -  0.0.1 +
oc-issuer +  0.0.2
@@ -90,32 +90,214 @@ Collaboration diagram for DefaultModel:
- + - + - + - + - +

Public Member Functions

-tl::expected< CDDC *, bool > getCDDC (unsigned int cdd_serial) override
tl::expected< CDDC *, bool > getCDDC (unsigned int cdd_serial) override
 
-tl::expected< CDDC *, bool > getCurrentCDDC () override
tl::expected< CDDC *, bool > getCurrentCDDC () override
 
-std::vector< BlindSignature > mint (const std::string &transaction_reference, const std::vector< Blind > &blinds) override
std::vector< BlindSignature > mint (const std::string &transaction_reference, const std::vector< Blind > &blinds) override
 
-const std::vector< MintKeyCert > getMKCs (const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids) override
const std::vector< MintKeyCert > getMKCs (const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids) override
 
-bool redeem (const std::vector< Coin > &coins) override
bool redeem (const std::vector< Coin > &coins) override
 
- +

Additional Inherited Members

- Static Public Member Functions inherited from Model
-static std::unique_ptr< Model > getModel (const std::string &backend_name)
static std::unique_ptr< Model > getModel (const std::string &backend_name)
 

Detailed Description

this is for now our sample model

-
The documentation for this class was generated from the following file:

Member Function Documentation

+ +

◆ getCDDC()

+ +
+
+ + + + + +
+ + + + + + + + +
tl::expected<CDDC *, bool> DefaultModel::getCDDC (unsigned int cdd_serial)
+ 		+inlineoverridevirtual
+
+

return the CurrencyDocumentDescription certifikate for a specific serial version number of it. see spec

Returns
returns a pointer to the CDDC if successful, false otherwise
+ +

Implements Model.

+ +
+
+ +

◆ getCurrentCDDC()

+ +
+
+ + + + + +
+ + + + + + + +
tl::expected<CDDC *, bool> DefaultModel::getCurrentCDDC ()
+ 		+inlineoverridevirtual
+
+

return the CurrencyDocumentDescription certifikate see spec

Returns
returns a pointer to the CDDC if successful, false otherwise
+ +

Implements Model.

+ +
+
+ +

◆ getMKCs()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
const std::vector<MintKeyCert> DefaultModel::getMKCs (const std::vector< unsigned int > & denominations,
const std::vector< BigInt > & mint_key_ids 
)
+ 		+inlineoverridevirtual
+
+

return the MintKey certificates for a given list of denominations and mint key ids

+
Parameters
+ + + +
denominations
mint_key_ids
+
+
+
Returns
mint key certificates for given denominations and mint_key_ids
+ +

Implements Model.

+ +
+
+ +

◆ mint()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::vector<BlindSignature> DefaultModel::mint (const std::string & transaction_reference,
const std::vector< Blind > & blinds 
)
+ 		+inlineoverridevirtual
+
+

returns the vector of blind signatures for a given vector of blinds

+
Parameters
+ + + +
transaction_referencereference to a transaction (send from client)
blindsthe vector of blinds to sign
+
+
+
Returns
+ +

Implements Model.

+ +
+
+ +

◆ redeem()

+ +
+
+ + + + + +
+ + + + + + + + +
bool DefaultModel::redeem (const std::vector< Coin > & coins)
+ 		+inlineoverridevirtual
+
+

redeem valid coins into real money

+
Parameters
+ + +
coinsthe coins to redeem
+
+
+
Returns
true if successful, false on error
+ +

Implements Model.

+ +
+
+
The documentation for this class was generated from the following file:
diff --git a/classModel-members.html b/classModel-members.html index 1f72b28..c0e58c2 100644 --- a/classModel-members.html +++ b/classModel-members.html @@ -5,7 +5,7 @@ -oc-mint: Member List +oc-issuer: Member List @@ -21,8 +21,8 @@ -
oc-mint -  0.0.1 +
oc-issuer +  0.0.2
@@ -69,12 +69,12 @@ $(function() {

This is the complete list of members for Model, including all inherited members.

- - - - - - + + + + + +
getCDDC(unsigned int cdd_serial)=0 (defined in Model)Modelpure virtual
getCurrentCDDC()=0 (defined in Model)Modelpure virtual
getMKCs(const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids)=0 (defined in Model)Modelpure virtual
getModel(const std::string &backend_name) (defined in Model)Modelstatic
mint(std::string const &transaction_reference, const std::vector< Blind > &blinds)=0 (defined in Model)Modelpure virtual
redeem(const std::vector< Coin > &coins)=0 (defined in Model)Modelpure virtual
getCDDC(unsigned int cdd_serial)=0Modelpure virtual
getCurrentCDDC()=0Modelpure virtual
getMKCs(const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids)=0Modelpure virtual
getModel(const std::string &backend_name)Modelstatic
mint(std::string const &transaction_reference, const std::vector< Blind > &blinds)=0Modelpure virtual
redeem(const std::vector< Coin > &coins)=0Modelpure virtual
~Model() (defined in Model)Modelinlinevirtual
diff --git a/classModel.html b/classModel.html index 9696c78..c15796a 100644 --- a/classModel.html +++ b/classModel.html @@ -5,7 +5,7 @@ -oc-mint: Model Class Reference +oc-issuer: Model Class Reference @@ -21,8 +21,8 @@ -
oc-mint -  0.0.1 +
oc-issuer +  0.0.2
@@ -82,28 +82,243 @@ Inheritance diagram for Model:
- + - + - + - + - +

Public Member Functions

-virtual tl::expected< CDDC *, bool > getCDDC (unsigned int cdd_serial)=0
virtual tl::expected< CDDC *, bool > getCDDC (unsigned int cdd_serial)=0
 
-virtual tl::expected< CDDC *, bool > getCurrentCDDC ()=0
virtual tl::expected< CDDC *, bool > getCurrentCDDC ()=0
 
-virtual const std::vector< MintKeyCert > getMKCs (const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids)=0
virtual const std::vector< MintKeyCert > getMKCs (const std::vector< unsigned int > &denominations, const std::vector< BigInt > &mint_key_ids)=0
 
-virtual std::vector< BlindSignature > mint (std::string const &transaction_reference, const std::vector< Blind > &blinds)=0
virtual std::vector< BlindSignature > mint (std::string const &transaction_reference, const std::vector< Blind > &blinds)=0
 
-virtual bool redeem (const std::vector< Coin > &coins)=0
virtual bool redeem (const std::vector< Coin > &coins)=0
 
- +

Static Public Member Functions

-static std::unique_ptr< Model > getModel (const std::string &backend_name)
static std::unique_ptr< Model > getModel (const std::string &backend_name)
 
+

Member Function Documentation

+ +

◆ getCDDC()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual tl::expected<CDDC *, bool> Model::getCDDC (unsigned int cdd_serial)
+ 		+pure virtual
+
+

return the CurrencyDocumentDescription certifikate for a specific serial version number of it. see spec

Returns
returns a pointer to the CDDC if successful, false otherwise
+ +

Implemented in DefaultModel.

+ +
+
+ +

◆ getCurrentCDDC()

+ +
+
+ + + + + +
+ + + + + + + +
virtual tl::expected<CDDC *, bool> Model::getCurrentCDDC ()
+ 		+pure virtual
+
+

return the CurrencyDocumentDescription certifikate see spec

Returns
returns a pointer to the CDDC if successful, false otherwise
+ +

Implemented in DefaultModel.

+ +
+
+ +

◆ getMKCs()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual const std::vector<MintKeyCert> Model::getMKCs (const std::vector< unsigned int > & denominations,
const std::vector< BigInt > & mint_key_ids 
)
+ 		+pure virtual
+
+

return the MintKey certificates for a given list of denominations and mint key ids

+
Parameters
+ + + +
denominations
mint_key_ids
+
+
+
Returns
mint key certificates for given denominations and mint_key_ids
+ +

Implemented in DefaultModel.

+ +
+
+ +

◆ getModel()

+ +
+
+ + + + + +
+ + + + + + + + +
std::unique_ptr< Model > Model::getModel (const std::string & backend_name)
+ 		+static
+
+

factory function returning a concrete backend for Opencoin API handling. based on backend_name a concrete backend will be returned or in case of error null.

Parameters
+ + +
backend_name
+
+
+
Returns
pointer to backend instance or null on invalid backend name
+ +
+
+ +

◆ mint()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual std::vector<BlindSignature> Model::mint (std::string const & transaction_reference,
const std::vector< Blind > & blinds 
)
+ 		+pure virtual
+
+

returns the vector of blind signatures for a given vector of blinds

+
Parameters
+ + + +
transaction_referencereference to a transaction (send from client)
blindsthe vector of blinds to sign
+
+
+
Returns
+ +

Implemented in DefaultModel.

+ +
+
+ +

◆ redeem()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool Model::redeem (const std::vector< Coin > & coins)
+ 		+pure virtual
+
+

redeem valid coins into real money

+
Parameters
+ + +
coinsthe coins to redeem
+
+
+
Returns
true if successful, false on error
+ +

Implemented in DefaultModel.

+ +
+
The documentation for this class was generated from the following files: