upgrading README with code examples

thandal · Mar 14, 2017 · 46887fd · 46887fd
1 parent eace0a3
commit 46887fd
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -33,10 +33,6 @@ mvn install
 
 ## Command line
 
-```
-
-```
-
 #### Stamp
 
 Create timestamp `README.md.ots` from this `README.md` with the aid of a remote calendar.
@@ -89,6 +85,50 @@ $ java -jar target/OtsCli.jar upgrade examples/incomplete.txt.ots
 Timestamp has been successfully upgraded!
 ```
 
+## From code
+
+#### Stamp and Info
+
+Create timestamp with the aid of remote calendars.
+
+```java
+FileInputStream fis = new FileInputStream(file);
+byte[] stampResult = OpenTimestamps.stamp(fis);
+String infoResult = OpenTimestamps.info(byteOts);
+System.out.println(infoResult);
+```
+
+#### Verify
+
+Verify the timestamp attestations.
+
+```java
+byte[] file = Utils.hexToBytes("48656c6c6f20576f726c64210a");
+byte[] fileOts = Utils.hexToBytes("004f70656e54696d657374616d7073000050726f6f6600bf89e2e884e89294010803ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab34003f1c8010100000001e482f9d32ecc3ba657b69d898010857b54457a90497982ff56f97c4ec58e6f98010000006b483045022100b253add1d1cf90844338a475a04ff13fc9e7bd242b07762dea07f5608b2de367022000b268ca9c3342b3769cdd062891317cdcef87aac310b6855e9d93898ebbe8ec0121020d8e4d107d2b339b0050efdd4b4a09245aa056048f125396374ea6a2ab0709c6ffffffff026533e605000000001976a9140bf057d40fbba6744862515f5b55a2310de5772f88aca0860100000000001976a914f00688ac000000000808f120a987f716c533913c314c78e35d35884cac943fa42cac49d2b2c69f4003f85f880808f120dec55b3487e1e3f722a49b55a7783215862785f4a3acb392846019f71dc64a9d0808f120b2ca18f485e080478e025dab3d464b416c0e1ecb6629c9aefce8c8214d0424320808f02011b0e90661196ff4b0813c3eda141bab5e91604837bdf7a0c9df37db0e3a11980808f020c34bc1a4a1093ffd148c016b1e664742914e939efabe4d3d356515914b26d9e20808f020c3e6e7c38c69f6af24c2be34ebac48257ede61ec0a21b9535e4443277be306460808f1200798bf8606e00024e5d5d54bf0c960f629dfb9dad69157455b6f2652c0e8de810808f0203f9ada6d60baa244006bb0aad51448ad2fafb9d4b6487a0999cff26b91f0f5360808f120c703019e959a8dd3faef7489bb328ba485574758e7091f01464eb65872c975c80808f020cbfefff513ff84b915e3fed6f9d799676630f8364ea2a6c7557fad94a5b5d7880808f1200be23709859913babd4460bbddf8ed213e7c8773a4b1face30f8acfdf093b7050808000588960d73d7190103f7ef15");
+Long result = OpenTimestamps.verify(fileOts,file);
+if(timestamp==null){
+    System.out.println("Pending or Bad attestation");
+}else {
+    System.out.println("Success! Bitcoin attests data existed as of "+ new Date(timestamp*1000) );
+}
+```
+
+Variable `file` created from the hex representation of the file `test/hello-world.txt.ots` while `fileOts` contains `test/hello-world.txt` 
+
+#### Upgrade
+
+Upgrade incomplete remote calendar timestamps to be indipendently verifiable.
+
+```java
+byte[] ots = Utils.hexToBytes("004f70656e54696d657374616d7073000050726f6f6600bf89e2e884e89294010805c4f616a8e5310d19d938cfd769864d7f4ccdc2ca8b479b10af83564b097af9f010e754bf93806a7ebaa680ef7bd0114bf408f010b573e8850cfd9e63d1f043fbb6fc250e08f10457cfa5c4f0086fb1ac8d4e4eb0e70083dfe30d2ef90c8e2e2d68747470733a2f2f616c6963652e6274632e63616c656e6461722e6f70656e74696d657374616d70732e6f7267");
+byte[] upgradedOts = OpenTimestamps.upgrade(ots);
+if(Arrays.equals(ots, upgradedOts)) {
+   System.out.println("Timestamp not upgraded"); 
+} else {
+   System.out.println("Timestamp upgraded");
+}
+```
+
 ## Testing
 
 ```

diff --git a/src/main/java/com/eternitywall/OtsCli.java b/src/main/java/com/eternitywall/OtsCli.java
@@ -135,11 +135,11 @@ private static void stamp(String argsFile, List<String> calendarsUrl, Integer m)
 
             File file = new File(argsFile);
             fis = new FileInputStream(file);
-            byte[] infoResult = OpenTimestamps.stamp(fis,calendarsUrl,m);
-            //System.out.println(Utils.bytesToHex(infoResult));
+            byte[] stampResult = OpenTimestamps.stamp(fis,calendarsUrl,m);
+            //System.out.println(Utils.bytesToHex(stampResult));
 
             String argsOts = argsFile + ".ots";
-            Files.write(Paths.get(argsOts), infoResult);
+            Files.write(Paths.get(argsOts), stampResult);
             System.out.println("The timestamp proof '" + argsOts + "' has been created!");
 
         } catch (IOException e) {
@@ -190,7 +190,7 @@ public static void upgrade (String argsOts) {
             byte[] byteOts = Files.readAllBytes(pathOts);
             byte[] upgradeResult = OpenTimestamps.upgrade(byteOts);
             if(Arrays.equals(byteOts, upgradeResult)) {
-                System.out.println("Timestamp is already complete");
+                System.out.println("Timestamp not upgraded");
             } else {
                 byte[] byteBak = Files.readAllBytes(pathOts);
                 Path pathBak = Paths.get(argsOts+".bak");