update deriveAddress docstring, fix const name

vacuumlabs · Sep 15, 2020 · 385608c · 385608c
1 parent da5bbb3
commit 385608c
Showing 1 changed file with 25 additions and 5 deletions.
diff --git a/src/Ada.js b/src/Ada.js
@@ -128,7 +128,7 @@ const MetadataCodes = {
 
 const TxOutputTypeCodes = {
   SIGN_TX_OUTPUT_TYPE_ADDRESS: 1,
-  SIGN_TX_OUTPUT_TYPE_PATH: 2
+  SIGN_TX_OUTPUT_TYPE_ADDRESS_PARAMS: 2
 }
 
 export const ErrorCodes = {
@@ -138,6 +138,7 @@ export const ErrorCodes = {
   ERR_REJECTED_BY_USER: 0x6e09,
   ERR_REJECTED_BY_POLICY: 0x6e10,
   ERR_DEVICE_LOCKED: 0x6e11,
+  ERR_UNSUPPORTED_ADDRESS_TYPE: 0x6e12,
 
   // Not thrown by ledger-app-cardano itself but other apps
   ERR_CLA_NOT_SUPPORTED: 0x6e00
@@ -154,7 +155,8 @@ const ErrorMsgs = {
   [ErrorCodes.ERR_REJECTED_BY_POLICY]:
     "Action rejected by Ledger's security policy",
   [ErrorCodes.ERR_DEVICE_LOCKED]: "Device is locked",
-  [ErrorCodes.ERR_CLA_NOT_SUPPORTED]: "Wrong Ledger app"
+  [ErrorCodes.ERR_CLA_NOT_SUPPORTED]: "Wrong Ledger app",
+  [ErrorCodes.ERR_UNSUPPORTED_ADDRESS_TYPE]: "Unsupported address type"
 };
 
 export const getErrorDescription = (statusCode: number) => {
@@ -371,10 +373,28 @@ export default class Ada {
    * @throws 5002 - The path provided is less than 5 indexes
    * @throws 5003 - Some of the indexes is not a number
    *
+   * TODO update error codes
+   *
+   * @example
+   * const { address } = await ada.deriveAddress(
+   *   0b1000, // byron address
+   *   764824073,
+   *   [ HARDENED | 44, HARDENED | 1815, HARDENED | 1, 0, 5 ],
+   *   null
+   *   null
+   *   null
+   * );
+   *
    * @example
-   * const { address } = await ada.deriveAddress([ HARDENED + 44, HARDENED + 1815, HARDENED + 1, 0, 5 ]);
+   * const { address } = await ada.deriveAddress(
+   *   0b0000, // base address
+   *   0x00,
+   *   [ HARDENED | 1852, HARDENED | 1815, HARDENED | 0, 0, 5 ],
+   *   [ HARDENED | 1852, HARDENED | 1815, HARDENED | 0, 2, 0 ]
+   *   null
+   *   null
+   * );
    *
-   * TODO update this
    */
   async deriveAddress(
       addressTypeNibble: number,
@@ -535,7 +555,7 @@ export default class Ada {
 
       const data = Buffer.concat([
         utils.amount_to_buf(amountStr),
-        utils.uint8_to_buf(TxOutputTypeCodes.SIGN_TX_OUTPUT_TYPE_PATH),
+        utils.uint8_to_buf(TxOutputTypeCodes.SIGN_TX_OUTPUT_TYPE_ADDRESS_PARAMS),
         cardano.serializeAddressInfo(
           addressTypeNibble,
           addressTypeNibble == AddressTypeNibbles.BYRON ? protocolMagic : networkId,