Feature: Add MayaChain (CACAO)

examples/sandbox/index.html

@@ -227,7 +227,13 @@ <h4>Arkeo</h4>
       <button class="button button-outline" id="arkeoAddClaim">Add Claim</button>
       <input type="text" id="arkeoResults" />
     </div>
-
+    <div class="container">
+      <h4>MAYAChain</h4>
+      <h5>Native MAYA</h5>
+      <button class="button button-outline" id="mayachainAddr">Address</button>
+      <button class="button button-outline" id="mayachainTx">Tx</button>
+      <input type="text" id="mayachainNativeResults" />
+    </div>
     <div class="container">
       <h4>THORChain</h4>
       <h5>Native RUNE</h5>

examples/sandbox/index.ts

@@ -52,6 +52,7 @@ import * as dogeTxJson from "./json/dogeTx.json";
 import { eip712, txs } from "./json/ethereum/ethTx.json";
 import { openSeaListNFTMessage } from "./json/ethereum/OpenSea-ethSignTypedDataV4.json";
 import * as ltcTxJson from "./json/ltcTx.json";
+import { mayachainUnsignedTx } from "./json/mayachainTx.json";
 import {
   osmosisDelegateTx,
   osmosisIBCTransferTx,
@@ -72,7 +73,6 @@ import {
   thorchainRouterAbi,
   thorchainUnsignedTx,
 } from "./json/thorchainTx.json";
-
 const keyring = new core.Keyring();
 
 const portisAppId = "ff763d3d-9e34-45a1-81d1-caa39b9c64f9";
@@ -1269,7 +1269,59 @@ $cosmosIBCTransfer.on("click", async (e) => {
     $cosmosResults.val(label + " does not support Cosmos");
   }
 });
+/*
+ * MAYAChain
+ */
+const $mayachainAddr = $("#mayachainAddr");
+const $mayachainTx = $("#mayachainTx");
+const $mayachainNativeResults = $("#mayachainNativeResults");
 
+$mayachainAddr.on("click", async (e) => {
+  e.preventDefault();
+  if (!wallet) {
+    $mayachainNativeResults.val("No wallet?");
+    return;
+  }
+  // eslint-disable-next-line no-console
+  console.log(core);
+  if (true) {
+    const { addressNList } = wallet.mayachainGetAccountPaths({ accountIdx: 0 })[0];
+    const result = await wallet.mayachainGetAddress({
+      addressNList,
+      showDisplay: false,
+    });
+    await wallet.mayachainGetAddress({
+      addressNList,
+      showDisplay: true,
+    });
+    $mayachainNativeResults.val(result);
+  } else {
+    const label = await wallet.getLabel();
+    $mayachainNativeResults.val(label + " does not support THORChain");
+  }
+});
+$mayachainTx.on("click", async (e) => {
+  e.preventDefault();
+  if (!wallet) {
+    $mayachainNativeResults.val("No wallet?");
+    return;
+  }
+  if (true) {
+    // eslint-disable-next-line no-console
+    console.log("mayachainUnsignedTx: ", mayachainUnsignedTx);
+    const res = await wallet.mayachainSignTx({
+      addressNList: core.bip32ToAddressNList(`m/44'/931'/0'/0/0`),
+      chain_id: "mayachain-mainnet-v1",
+      account_number: "6359",
+      sequence: "15",
+      tx: mayachainUnsignedTx,
+    });
+    $mayachainNativeResults.val(JSON.stringify(res));
+  } else {
+    const label = await wallet.getLabel();
+    $mayachainNativeResults.val(label + " does not support MAYAchain");
+  }
+});
 /*
  * THORChain
  */

examples/sandbox/json/mayachainTx.json

@@ -0,0 +1,30 @@
+{
+  "mayachainUnsignedTx": {
+    "fee": {
+      "amount": [
+        {
+          "amount": "1",
+          "denom": "cacao"
+        }
+      ],
+      "gas": "200000"
+    },
+    "memo": "foobar",
+    "msg": [
+      {
+        "type": "mayachain/MsgSend",
+        "value": {
+          "amount": [
+            {
+              "amount": "1",
+              "denom": "cacao"
+            }
+          ],
+          "from_address": "maya1ls33ayg26kmltw7jjy55p32ghjna09zp7z4etj",
+          "to_address": "maya1ls33ayg26kmltw7jjy55p32ghjna09zp7z4etj"
+        }
+      }
+    ],
+    "signatures": null
+  }
+}

integration/src/integration.ts

@@ -16,6 +16,7 @@ import { eosTests } from "./eos";
 import { ethTests } from "./ethereum";
 import { fioTests } from "./fio";
 import { kavaTests } from "./kava";
+import { mayachainTests } from "./mayachain";
 import { osmosisTests } from "./osmosis";
 import { rippleTests } from "./ripple";
 import { secretTests } from "./secret";
@@ -136,6 +137,14 @@ export function integration(suite: WalletSuite): void {
       thorchainTests(() => ({ wallet, info }));
     });
 
+    describe("mayachainTests", () => {
+      beforeAll(async () => {
+        wallet = await suite.createWallet("Thorchain");
+      });
+
+      mayachainTests(() => ({ wallet, info }));
+    });
+
     describe("SecretWallet", () => {
       beforeAll(async () => {
         wallet = await suite.createWallet("Secret");

integration/src/mayachain/index.ts

@@ -0,0 +1,7 @@
+import * as core from "@shapeshiftoss/hdwallet-core";
+
+import { mayachainTests as tests } from "./mayachain";
+
+export function mayachainTests(get: () => { wallet: core.HDWallet; info: core.HDWalletInfo }): void {
+  tests(get);
+}

integration/src/mayachain/mayachain.ts

@@ -0,0 +1,144 @@
+import * as core from "@shapeshiftoss/hdwallet-core";
+import * as keepkey from "@shapeshiftoss/hdwallet-keepkey";
+import * as ledger from "@shapeshiftoss/hdwallet-ledger";
+
+import tx_unsigned_swap_amino from "./tx01.mainnet.mayachain.swap.amino.json";
+import tx_unsigned_swap from "./tx01.mainnet.mayachain.swap.json";
+import tx_signed_swap_amino from "./tx01.mainnet.mayachain.swap.signed.amino.json";
+import tx_signed_swap from "./tx01.mainnet.mayachain.swap.signed.json";
+import tx_unsigned_transfer_amino from "./tx01.mainnet.mayachain.transfer.amino.json";
+import tx_unsigned_transfer from "./tx01.mainnet.mayachain.transfer.json";
+import tx_signed_transfer_amino from "./tx01.mainnet.mayachain.transfer.signed.amino.json";
+import tx_signed_transfer from "./tx01.mainnet.mayachain.transfer.signed.json";
+
+const MNEMONIC12_NOPIN_NOPASSPHRASE = "alcohol woman abuse must during monitor noble actual mixed trade anger aisle";
+
+const TIMEOUT = 60 * 1000;
+
+/**
+ *  Main integration suite for testing MayachainWallet implementations' Mayachain support.
+ */
+export function mayachainTests(get: () => { wallet: core.HDWallet; info: core.HDWalletInfo }): void {
+  let wallet: core.MayachainWallet & core.HDWallet;
+  let useAmino: boolean;
+
+  describe("Mayachain", () => {
+    beforeAll(async () => {
+      const { wallet: w } = get();
+      if (core.supportsMayachain(w)) wallet = w;
+      useAmino = w instanceof keepkey.KeepKeyHDWallet || w instanceof ledger.LedgerHDWallet;
+    });
+
+    beforeEach(async () => {
+      if (!wallet) return;
+      await wallet.wipe();
+      await wallet.loadDevice({
+        mnemonic: MNEMONIC12_NOPIN_NOPASSPHRASE,
+        label: "test",
+        skipChecksum: true,
+      });
+    }, TIMEOUT);
+
+    test(
+      "mayachainGetAccountPaths()",
+      () => {
+        if (!wallet) return;
+        const paths = wallet.mayachainGetAccountPaths({ accountIdx: 0 });
+        expect(paths.length > 0).toBe(true);
+        expect(paths[0].addressNList[0] > 0x80000000).toBe(true);
+      },
+      TIMEOUT
+    );
+
+    test(
+      "describePath() mayachain",
+      async () => {
+        if (!wallet) return;
+
+        const out = wallet.describePath({
+          path: core.bip32ToAddressNList("m/44'/931'/0'/0/0"),
+          coin: "Mayachain",
+        });
+
+        // This is strange, and probably wrong, behavior... but it's what happens.
+        if (wallet.getVendor() === "KeepKey") {
+          // eslint-disable-next-line jest/no-conditional-expect
+          expect(out).toMatchInlineSnapshot(`
+          Object {
+            "coin": "Mayachain",
+            "isKnown": false,
+            "scriptType": undefined,
+            "verbose": "m/44'/931'/0'/0/0",
+          }
+          `);
+        } else {
+          // eslint-disable-next-line jest/no-conditional-expect
+          expect(out).toMatchInlineSnapshot(`
+            Object {
+              "accountIdx": 0,
+              "coin": "Mayachain",
+              "isKnown": true,
+              "isPrefork": false,
+              "verbose": "Mayachain Account #0",
+              "wholeAccount": true,
+            }
+          `);
+        }
+      },
+      TIMEOUT
+    );
+
+    test(
+      "mayachainGetAddress()",
+      async () => {
+        if (!wallet) return;
+        expect(
+          await wallet.mayachainGetAddress({
+            addressNList: core.bip32ToAddressNList("m/44'/931'/0'/0/0"),
+            showDisplay: false,
+            testnet: false,
+          })
+        ).toEqual("maya1ls33ayg26kmltw7jjy55p32ghjna09zp7z4etj");
+      },
+      TIMEOUT
+    );
+
+    describe("mayachainSignTx()", () => {
+      it.each([
+        [
+          "should correctly sign a transfer tx",
+          tx_unsigned_transfer_amino,
+          tx_unsigned_transfer,
+          tx_signed_transfer_amino,
+          tx_signed_transfer,
+        ],
+        [
+          "should correctly sign a swap tx",
+          tx_unsigned_swap_amino,
+          tx_unsigned_swap,
+          tx_signed_swap_amino,
+          tx_signed_swap,
+        ],
+      ])(
+        "%s",
+        async (_, aminoTx, protoTx, signedAminoTx, signedProtoTx) => {
+          const tx = useAmino ? aminoTx : protoTx;
+          const signedTx = useAmino ? signedAminoTx : signedProtoTx;
+
+          if (!wallet || !tx) return;
+
+          const input: core.MayachainSignTx = {
+            tx,
+            addressNList: core.bip32ToAddressNList("m/44'/931'/0'/0/0"),
+            chain_id: tx.chain_id,
+            account_number: tx.account_number,
+            sequence: tx.sequence,
+          };
+          const res = await wallet.mayachainSignTx(input);
+          expect(res).toEqual(signedTx);
+        },
+        TIMEOUT
+      );
+    });
+  });
+}

integration/src/mayachain/tx01.mainnet.mayachain.swap.amino.json

@@ -0,0 +1,31 @@
+{
+  "account_number": "6359",
+  "chain_id": "mayachain-mainnet-v1",
+  "sequence": "20",
+  "fee": {
+    "amount": [
+      {
+        "amount": "0",
+        "denom": "cacao"
+      }
+    ],
+    "gas": "350000"
+  },
+  "memo": "",
+  "msg": [
+    {
+      "type": "mayachain/MsgDeposit",
+      "value": {
+        "coins": [
+          {
+            "asset": "MAYA.CACAO",
+            "amount": "1000000"
+          }
+        ],
+        "memo": "SWAP:DASH.DASH:XdTw4G5AWW4cogGd7ayybyBNDbuB45UpgH:10000",
+        "signer": "maya1ls33ayg26kmltw7jjy55p32ghjna09zp7z4etj"
+      }
+    }
+  ],
+  "signatures": []
+}

integration/src/mayachain/tx01.mainnet.mayachain.swap.json

@@ -0,0 +1,31 @@
+{
+  "account_number": "6359",
+  "chain_id": "mayachain-mainnet-v1",
+  "sequence": "20",
+  "fee": {
+    "amount": [
+      {
+        "amount": "0",
+        "denom": "cacao"
+      }
+    ],
+    "gas": "350000"
+  },
+  "memo": "",
+  "msg": [
+    {
+      "type": "mayachain/MsgDeposit",
+      "value": {
+        "coins": [
+          {
+            "asset": "MAYA.CACAO",
+            "amount": "1000000"
+          }
+        ],
+        "memo": "SWAP:DASH.DASH:XdTw4G5AWW4cogGd7ayybyBNDbuB45UpgH:10000",
+        "signer": "maya1ls33ayg26kmltw7jjy55p32ghjna09zp7z4etj"
+      }
+    }
+  ],
+  "signatures": []
+}

integration/src/mayachain/tx01.mainnet.mayachain.swap.signed.amino.json

@@ -0,0 +1,8 @@
+{
+  "serialized": "CogBCoUBChEvdHlwZXMuTXNnRGVwb3NpdBJwCh8KFAoETUFZQRIFQ0FDQU8aBUNBQ0FPEgcxMDAwMDAwEjdTV0FQOkRBU0guREFTSDpYZFR3NEc1QVdXNGNvZ0dkN2F5eWJ5Qk5EYnVCNDVVcGdIOjEwMDAwGhT8Ix6RCtW39bvSkSlAxUi8p9eUQRJkClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEDFRlxO4tCvcNnES0zEyzxTO35KKxXcdREukWblJcRe6MSBAoCCAEYFBIQCgoKBWNhY2FvEgEwELCuFRpAORL7NmFPsTZE8i/35JVAf5dMXQG/Pr+RDkGZ+PTyTk5lAjsJkO+kPfLoI5NZ8/yhvznS3A7oiNGLhaftcSNmpw==",
+  "body": "CpABChEvdHlwZXMuTXNnRGVwb3NpdBJ7CiAKFAoETUFZQRIFQ0FDQU8aBUNBQ0FPEgg1MDk5NDAwMBJBU1dBUDpFVEguRVRIOjB4M2YyMzI5QzlBREZiY0NkOUE4NGY1MmM5MDZFOTM2QTQyZEExOENCODozNDg5NTM1MDEaFPwjHpEK1bf1u9KRKUDFSLyn15RB",
+  "authInfoBytes": "ClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEDFRlxO4tCvcNnES0zEyzxTO35KKxXcdREukWblJcRe6MSBAoCCAEYFBIQCgoKBWNhY2FvEgEwELCuFQ==",
+  "signatures": [
+    "ORL7NmFPsTZE8i/35JVAf5dMXQG/Pr+RDkGZ+PTyTk5lAjsJkO+kPfLoI5NZ8/yhvznS3A7oiNGLhaftcSNmpw=="
+  ]
+}

integration/src/mayachain/tx01.mainnet.mayachain.swap.signed.json

@@ -0,0 +1,8 @@
+{
+  "serialized": "CogBCoUBChEvdHlwZXMuTXNnRGVwb3NpdBJwCh8KFAoETUFZQRIFQ0FDQU8aBUNBQ0FPEgcxMDAwMDAwEjdTV0FQOkRBU0guREFTSDpYZFR3NEc1QVdXNGNvZ0dkN2F5eWJ5Qk5EYnVCNDVVcGdIOjEwMDAwGhT8Ix6RCtW39bvSkSlAxUi8p9eUQRJkClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEDFRlxO4tCvcNnES0zEyzxTO35KKxXcdREukWblJcRe6MSBAoCCAEYFBIQCgoKBWNhY2FvEgEwELCuFRpAORL7NmFPsTZE8i/35JVAf5dMXQG/Pr+RDkGZ+PTyTk5lAjsJkO+kPfLoI5NZ8/yhvznS3A7oiNGLhaftcSNmpw==",
+  "body": "CoUBChEvdHlwZXMuTXNnRGVwb3NpdBJwCh8KFAoETUFZQRIFQ0FDQU8aBUNBQ0FPEgcxMDAwMDAwEjdTV0FQOkRBU0guREFTSDpYZFR3NEc1QVdXNGNvZ0dkN2F5eWJ5Qk5EYnVCNDVVcGdIOjEwMDAwGhT8Ix6RCtW39bvSkSlAxUi8p9eUQQ==",
+  "authInfoBytes": "ClAKRgofL2Nvc21vcy5jcnlwdG8uc2VjcDI1NmsxLlB1YktleRIjCiEDFRlxO4tCvcNnES0zEyzxTO35KKxXcdREukWblJcRe6MSBAoCCAEYFBIQCgoKBWNhY2FvEgEwELCuFQ==",
+  "signatures": [
+    "ORL7NmFPsTZE8i/35JVAf5dMXQG/Pr+RDkGZ+PTyTk5lAjsJkO+kPfLoI5NZ8/yhvznS3A7oiNGLhaftcSNmpw=="
+  ]
+}