Use Cases - Revision history

FellowTraveler: removed bold

2015-07-08T22:47:03Z

removed bold

FellowTraveler: typo

2015-07-08T22:46:33Z

typo

FellowTraveler: updated a bit

2015-07-08T22:46:15Z

updated a bit

FellowTraveler: chaumian

2013-09-18T23:40:14Z

chaumian

Cryptoman at 15:01, 10 June 2013

2013-06-10T15:01:44Z

Cryptoman at 15:01, 10 June 2013

2013-06-10T15:01:10Z

Cryptoman at 14:52, 10 June 2013

2013-06-10T14:52:26Z

Cryptoman at 14:49, 10 June 2013

2013-06-10T14:49:21Z

Show changes

Cryptoman at 14:34, 10 June 2013

2013-06-10T14:34:36Z

Show changes

Cryptoman at 14:23, 10 June 2013

2013-06-10T14:23:58Z

@@ Line 1: / Line 1: @@
 Anytime you need to do something, use the high-level API to do it (OT_ME.) Only if you can't find the function you are looking for, should you next resort to the low-level API (OTAPI.) And remember, you can always the copy the code you need from the test GUI, [http://github.com/Open-Transactions/Moneychanger Moneychanger].
-'''What does this mean for you? It means you no longer have to worry about synchronizing request numbers, or harvesting transaction numbers, or comparing inbox hashes, or downloading your nymbox, or dropped messages, or timeouts, or retries, etc!''' Instead, you use simple functions like '''send_transfer''' or '''withdraw_cash.''' The high-level API manages everything else behind the scenes. And any sample code you need can be copied right out of Moneychanger's code.
+What does this mean for you? It means you no longer have to worry about synchronizing request numbers, or harvesting transaction numbers, or comparing inbox hashes, or downloading your nymbox, or dropped messages, or timeouts, or retries, etc! Instead, you use simple functions like '''send_transfer''' or '''withdraw_cash.''' The high-level API manages everything else behind the scenes. And any sample code you need can be copied right out of Moneychanger's code.
 -----

← Older revision		Revision as of 22:46, 8 July 2015
Line 1:		Line 1:
−	* With that as your guide, a general rule of thumb is this: Anytime you need to do something, use the high-level API to do it (OT_ME.) Only if you can't find the function you are looking for, should you next resort to the low-level API (OTAPI.) And remember, you can always the copy the code you need from the test GUI, [http://github.com/Open-Transactions/Moneychanger Moneychanger].	+	Anytime you need to do something, use the high-level API to do it (OT_ME.) Only if you can't find the function you are looking for, should you next resort to the low-level API (OTAPI.) And remember, you can always the copy the code you need from the test GUI, [http://github.com/Open-Transactions/Moneychanger Moneychanger].

	'''What does this mean for you? It means you no longer have to worry about synchronizing request numbers, or harvesting transaction numbers, or comparing inbox hashes, or downloading your nymbox, or dropped messages, or timeouts, or retries, etc!''' Instead, you use simple functions like '''send_transfer''' or '''withdraw_cash.''' The high-level API manages everything else behind the scenes. And any sample code you need can be copied right out of Moneychanger's code.		'''What does this mean for you? It means you no longer have to worry about synchronizing request numbers, or harvesting transaction numbers, or comparing inbox hashes, or downloading your nymbox, or dropped messages, or timeouts, or retries, etc!''' Instead, you use simple functions like '''send_transfer''' or '''withdraw_cash.''' The high-level API manages everything else behind the scenes. And any sample code you need can be copied right out of Moneychanger's code.

@@ Line 1: / Line 1: @@
-THE LATEST SCOOP
+* With that as your guide, a general rule of thumb is this: Anytime you need to do something, use the high-level API to do it (OT_ME.) Only if you can't find the function you are looking for, should you next resort to the low-level API (OTAPI.) And remember, you can always the copy the code you need from the test GUI, [http://github.com/Open-Transactions/Moneychanger Moneychanger].
-* OT now has a high-level API for all languages! (Via SWIG.) See the [https://github.com/FellowTraveler/Open-Transactions/blob/master/include/otapi/OTMadeEasy.h OTMadeEasy] class, as well as the sample scripts provided in [https://github.com/FellowTraveler/Open-Transactions/blob/master/scripts/demo/php/php_ot_test.php PHP], [https://github.com/FellowTraveler/Open-Transactions/blob/master/scripts/demo/python/python_ot_test.py Python] and [https://github.com/FellowTraveler/Open-Transactions/blob/master/scripts/demo/csharp/Main.cs C-Sharp].
+'''What does this mean for you? It means you no longer have to worry about synchronizing request numbers, or harvesting transaction numbers, or comparing inbox hashes, or downloading your nymbox, or dropped messages, or timeouts, or retries, etc!''' Instead, you use simple functions like '''send_transfer''' or '''withdraw_cash.''' The high-level API manages everything else behind the scenes. And any sample code you need can be copied right out of Moneychanger's code.
-'''What does this mean for you? It means you no longer have to worry about synchronizing request numbers, or harvesting transaction numbers, or comparing inbox hashes, or downloading your nymbox, or dropped messages, or timeouts, or retries, etc!''' Instead, you use simple functions like '''send_transfer''' or '''withdraw_cash.''' The high-level API manages everything else behind the scenes.
+-----
 -----

@@ Line 28: / Line 28: @@
 * '''Send a Message''' to another user (via the server, encrypted to the recipient's public key.)
 * '''Deposit a cheque'''
-* '''Withdraw cash''' . . . . &lt;==== UNTRACEABLE DIGITAL CASH!!
+* '''Withdraw cash''' . . . . &lt;==== CHAUMIAN DIGITAL CASH!!
 * '''Deposit cash'''
 * Withdraw Voucher
@@ Line 246: / Line 246: @@
 </pre>
-'''Withdraw cash''' Alice's wallet first makes sure she has the latest public mint file, by calling <code>OT_API_getMint()</code>. (Note: if the mint she already has is within its valid date range, there's no need to do this.) (Note: If she does call getMint, Alice needs to check the server reply and make sure it was successful before continuing with the withdrawal. The public mint keys are necessary for cash withdrawal.) Alice then withdraws from her asset account, by messaging server: <code>OT_API_notarizeWithdrawal()</code> Server replies with untraceable cash, which is stored in the purse folder in local storage.
+'''Withdraw cash''' Alice's wallet first makes sure she has the latest public mint file, by calling <code>OT_API_getMint()</code>. (Note: if the mint she already has is within its valid date range, there's no need to do this.) (Note: If she does call getMint, Alice needs to check the server reply and make sure it was successful before continuing with the withdrawal. The public mint keys are necessary for cash withdrawal.) Alice then withdraws from her asset account, by messaging server: <code>OT_API_notarizeWithdrawal()</code> Server replies with chaumian cash, which is stored in the purse folder in local storage.
 Here is the full Java implementation of Withdraw Cash:

@@ Line 560: / Line 560: @@
 I will be very responsive to developer needs and questions regarding the OT API, so I encourage you to play with the software and contact me anytime.
-See also: [[API|The OT low-level API]]<br>
+See also:<br>
 [[Install|Installation]] <br>
 [https://github.com/FellowTraveler/Open-Transactions/wiki/opentxs opentxs command-line tool]

@@ Line 441: / Line 441: @@
 '''Exchange Digital Assets in/out of a Basket Currency (from your Asset Accounts)''' First, call <code>OT_API_GenerateBasketExchange()</code> to setup the exchange. You'll need to know the basket's asset type, and you'll need to have an existing asset account of that type. You will also set the &quot;transfer multiple&quot; in that call. What's the transfer multiple? Remember the ratio above: &quot;10 Clams equals a basket of 5 dollars, 3 Euro, and 20 Bitcoin&quot;
-Here are examples of the transfer multiple:
+Here are examples of the transfer multiple: <br>
-&quot;10 Clams == 5 USD, 3 EUR, 20 BIT&quot; (Transfer multiple: 1)
+&quot;10 Clams == 5 USD, 3 EUR, 20 BIT&quot; (Transfer multiple: 1) <br>
-&quot;20 Clams == 10 USD, 6 EUR, 40 BIT&quot; (Transfer multiple: 2)
+&quot;20 Clams == 10 USD, 6 EUR, 40 BIT&quot; (Transfer multiple: 2) <br>
-&quot;30 Clams == 15 USD, 9 EUR, 60 BIT&quot; (Transfer multiple: 3)
+&quot;30 Clams == 15 USD, 9 EUR, 60 BIT&quot; (Transfer multiple: 3) <br>
-&quot;40 Clams == 20 USD, 12 EUR, 80 BIT&quot; (Transfer multiple: 4)
+&quot;40 Clams == 20 USD, 12 EUR, 80 BIT&quot; (Transfer multiple: 4) <br>
-&quot;50 Clams == 25 USD, 15 EUR, 100 BIT&quot; (Transfer multiple: 5)
+&quot;50 Clams == 25 USD, 15 EUR, 100 BIT&quot; (Transfer multiple: 5)<br>
 Next, call <code>OT_API_AddBasketExchangeItem()</code> for each currency type in the basket. You will need to to pass the asset account ID for an existing asset account, for each currency type (since you are converting in or out, from your basket account, to your asset accounts.) Therefore you will call this function once for USD, once for EUR, and once for BIT, in that example, passing in your USD asset acct ID, your EUR asset acct ID, and your Bitcoin asset account ID.
@@ Line 459: / Line 459: @@
 '''PROCESSING YOUR INBOX'''
-'''Process the Receipts and Pending Transfers in your Inbox''' If you wish, call <code>OT_API_getInbox()</code> to grab the latest inbox from the server. In the high-level API, this is often just automated for you, but nevertheless, check out the dl_acct_files.ot script. See also show_inbox.ot, etc.
+'''Process the Receipts and Pending Transfers in your Inbox''' <br>
 During this time, your user has the opportunity to peruse the inbox, and to decide which transactions therein he wishes to accept or reject. Usually the inbox is display on the screen, then the user selects various items to accept or reject, and then the user clicks &quot;Process Inbox&quot; and then you do this:
-Then call <code>OT_API_Ledger_CreateResponse()</code> in order to create a 'response' ledger for that inbox, which will be sent to the server to signal your responses to the various inbox transactions. Then call <code>OT_API_Ledger_GetCount()</code> (pass it the inbox) to find out how many transactions are inside of it. Use that count to LOOP through them... Use <code>OT_API_Ledger_GetTransactionByIndex()</code> to grab each transaction as you iterate through the inbox. (There are various introspection functions you can use in the API here if you wish to display the inbox items on the screen for the user...) Next call <code>OT_API_Transaction_CreateResponse()</code> for each transaction in the inbox, to create a response to it, accepting or rejecting it. This function creates the response and adds it to the response ledger. Next, call <code>OT_API_Ledger_FinalizeResponse()</code> which will create a ''Balance Agreement'' for the ledger. Finally, call <code>OT_API_processInbox()</code> to send your message to the server and process the various items. (See the accept_inbox.ot script.)
+Then call <code>OT_API_Ledger_CreateResponse()</code> in order to create a 'response' ledger for that inbox, which will be sent to the server to signal your responses to the various inbox transactions. <br>Then call <code>OT_API_Ledger_GetCount()</code> (pass it the inbox) to find out how many transactions are inside of it. Use that count to LOOP through them...
 If the message was successful, then use <code>OT_API_Message_GetBalanceAgreementSuccess()</code> and <code>OT_API_Message_GetTransactionSuccess()</code> to see just ''how'' successful.
@@ Line 478: / Line 483: @@
 '''Issue a [[Markets|Market]] Offer'''
-Call this function: <code>OT_API_issueMarketOffer()</code> (That's the low-level one. See create_offer.ot script for the high-level version.) Call <code>OT_API_Message_GetSuccess</code> to find out if the message was a SUCCESS or FAILURE. If the message was successful, then use <code>OT_API_Message_GetBalanceAgreementSuccess()</code> and <code>OT_API_Message_GetTransactionSuccess()</code> as described above in the ''deposit cash'' instructions. See the OTScript and Java versions of these calls.
+Call this function: <code>OT_API_issueMarketOffer()</code><br>
 Once an offer goes onto the market, multiple trades may occur between it and the other offers on the market. (According to the rules in the offers.) Receipts will process into the respective parties' inboxes after each trade.
@@ Line 484: / Line 493: @@
 '''Cancel a Market Offer''' Use <code>OT_API_cancelNymMarketOffer</code> to remove an offer from a market. If the message was successful, then use <code>OT_API_Message_GetBalanceAgreementSuccess()</code> and <code>OT_API_Message_GetTransactionSuccess()</code>
-'''Retrieving Market Data from OT Server:''' <code>OT_API_getMarketList</code> retrieves a list of all the markets available on a specific server, and details for each market. If the server call is a success, the data will be retrieved from the OT server, and written to local storage using the OT Storage API, at this path or key (inside your data_folder location): <code>markets/SERVER_ID/market_data.bin</code> If you want to verify whether the data is now available in local storage (after a successful call to getMarketList), your code would look like this: <code>if (otapi.Exists(&quot;markets&quot;, serverID, &quot;market_data.bin&quot;)) bFoundFile = true;</code>
+'''Retrieving Market Data from OT Server:''' <code>OT_API_getMarketList</code> retrieves a list of all the markets available on a specific server, and details for each market. If the server call is a success, the data will be retrieved from the OT server, and written to local storage using the OT Storage API, at this path or key (inside your data_folder location): <code>markets/SERVER_ID/market_data.bin</code> <br>
 Here is some Java code that reads the market list object from local storage, assuming bFoundFile is true:
@@ Line 549: / Line 560: @@
 I will be very responsive to developer needs and questions regarding the OT API, so I encourage you to play with the software and contact me anytime.
-See also: [[API|The OT low-level API]][[Install|Installation]] &quot;opentxs command-line tool&quot;:https://github.com/FellowTraveler/Open-Transactions/wiki/opentxs
+See also: [[API|The OT low-level API]]<br>
 [[List of Classes|The OT C++ class library]]
-''Diagrams:'' ''[[http://billstclair.com/ot/ot-diagram.jpg|Architecture Overview]]'', ''[[http://billstclair.com/ot/OT-Anon-CashOnly.jpg|Fully-Anonymous]]'' (cash only), and ''[[http://billstclair.com/ot/OT-Pseudonym-Instruments.jpg|Pseudo-Anonymous]]'' (using accounts).
+''Diagrams:'' '''[http://billstclair.com/ot/ot-diagram.jpg Architecture Overview]''', '''[http://billstclair.com/ot/OT-Anon-CashOnly.jpg Fully-Anonymous]''' (cash only), and '''[http://billstclair.com/ot/OT-Pseudonym-Instruments.jpg Pseudo-Anonymous]''' (using accounts).

@@ Line 437: / Line 437: @@
 '''Create a new Basket Currency''' First, invent the basket in your head. Give it name: ''&quot;Clams.&quot;''
-Next, give it a ratio in terms of other existing currencies: ''&quot;10 Clams equals a basket of 5 dollars, 3 Euro, and 20 Bitcoin&quot;'' Call <code>OT_API_GenerateBasketCreation()</code> to begin creating the basket. The ''&quot;10 Clams&quot;'' from above is set here. Next, call <code>OT_API_AddBasketCreationItem()</code> for EACH currency in the basket. In the above example, I would call this function 3 times, in order to set the ''&quot;5 dollars&quot;'' the ''&quot;3 Euro&quot;'' and the ''&quot;20 Bitcoin&quot;'' from above. Now that the basket has been defined, call <code>OT_API_issueBasket()</code> to actually create the basket currency on the server. (Now you have created a new asset type--a basket--which the server will control. Any user may now create accounts using this type! And from there, they can write cheques, withdraw cash, trade on markets, etc. the same as with any other asset type.)
+Next, give it a ratio in terms of other existing currencies: ''&quot;10 Clams equals a basket of 5 dollars, 3 Euro, and 20 Bitcoin&quot;.'' Call <code>OT_API_GenerateBasketCreation()</code> to begin creating the basket. The ''&quot;10 Clams&quot;'' from above is set here. Next, call <code>OT_API_AddBasketCreationItem()</code> for EACH currency in the basket. In the above example, I would call this function 3 times, in order to set the ''&quot;5 dollars&quot;'' the ''&quot;3 Euro&quot;'' and the ''&quot;20 Bitcoin&quot;'' from above. Now that the basket has been defined, call <code>OT_API_issueBasket()</code> to actually create the basket currency on the server. (Now you have created a new asset type--a basket--which the server will control. Any user may now create accounts using this type! And from there, they can write cheques, withdraw cash, trade on markets, etc. the same as with any other asset type.)
 '''Exchange Digital Assets in/out of a Basket Currency (from your Asset Accounts)''' First, call <code>OT_API_GenerateBasketExchange()</code> to setup the exchange. You'll need to know the basket's asset type, and you'll need to have an existing asset account of that type. You will also set the &quot;transfer multiple&quot; in that call. What's the transfer multiple? Remember the ratio above: &quot;10 Clams equals a basket of 5 dollars, 3 Euro, and 20 Bitcoin&quot;
-Here are examples of the transfer multiple: &quot;10 Clams == 5 USD, 3 EUR, 20 BIT&quot; (Transfer multiple: 1) &quot;20 Clams == 10 USD, 6 EUR, 40 BIT&quot; (Transfer multiple: 2) &quot;30 Clams == 15 USD, 9 EUR, 60 BIT&quot; (Transfer multiple: 3) &quot;40 Clams == 20 USD, 12 EUR, 80 BIT&quot; (Transfer multiple: 4) &quot;50 Clams == 25 USD, 15 EUR, 100 BIT&quot; (Transfer multiple: 5)
+Here are examples of the transfer multiple:
 Next, call <code>OT_API_AddBasketExchangeItem()</code> for each currency type in the basket. You will need to to pass the asset account ID for an existing asset account, for each currency type (since you are converting in or out, from your basket account, to your asset accounts.) Therefore you will call this function once for USD, once for EUR, and once for BIT, in that example, passing in your USD asset acct ID, your EUR asset acct ID, and your Bitcoin asset account ID.

@@ Line 127: / Line 127: @@
+             }
          }</pre>
-'''Change the wallet's label for any server/asset type/account/nym'''
+'''Change the wallet's label for any server/asset type/account/nym'''<br>
-(This is only a client-side label, for display purposes only.)
+(This is only a client-side label, for display purposes only.)<br>
-<code>OT_API_SetNym_Name()</code>
+<code>OT_API_SetNym_Name()</code><br>
-<code>OT_API_SetAccountWallet_Name()</code>
+<code>OT_API_SetAccountWallet_Name()</code> <br>
-<code>OT_API_SetAssetType_Name()</code>
+<code>OT_API_SetAssetType_Name()</code> <br>
-<code>OT_API_SetServer_Name()</code>
+<code>OT_API_SetServer_Name()</code><br>