Merge pull request #121 from phaazon/misc/idl-docs

First pass of fixing and documenting the IDL files.

Author: hadronized

core/idl/bitcoin/addresses.djinni

@@ -1,20 +1,34 @@
-
+# Strategy used to compute the amount of fees of transactions.
+#
+# This basically gives the unit in which the fee amount will be expressed.
 BitcoinLikeFeePolicy = enum {
     PER_BYTE;
     PER_KBYTE;
 }
 
+# Bitcoin network parameters.
 BitcoinLikeNetworkParameters = record {
+    # Name of the network.
     Identifier: string;
+    # Version of the Pay To Public Hash standard.
     P2PKHVersion: binary;
+    # Version of the Pay To Script Hash standard.
     P2SHVersion: binary;
+    # Version of the Extended Public Key standard.
     XPUBVersion: binary;
+    # Policy to use when expressing fee amount.
     FeePolicy: BitcoinLikeFeePolicy;
+    # Minimal amount a UTXO should have before being considered BTC dust.
     DustAmount: i64;
+    # Constant prefix to prepend all signature messages.
     MessagePrefix: string;
+    # Are transactions encoded with timestamp?
     UsesTimestampedTransaction: bool;
+    # Delay applied to all timestamps. Used to debounce transactions.
     TimestampDelay: i64;
+    # Bitcoin signature flag indicating what part of a transaction a signature signs.
     SigHash: binary;
+    # Addition BIPs enabled for this network.
     AdditionalBIPs: list<string>;
 }
 
@@ -43,10 +57,16 @@ BitcoinLikeAddress = interface +c {
     isP2PKH(): bool;
 }
 
+# The xPUB definition for Bitcoin.
 BitcoinLikeExtendedPublicKey = interface +c {
+    # Derive an address from an xPUB and a path.
     derive(path: string): BitcoinLikeAddress;
+    # Derive a public key from an xPUB and a path.
     derivePublicKey(path: string): binary;
+    # Derive a shorten version of a public key (SHA256 + RIPEMD160) from an xPUB and a path.
     deriveHash160(path: string): binary;
+    # Get the xPUB in base 58.
     toBase58(): string;
+    # Get the root path of the xPUB.
     getRootPath(): string;
-}
+}