{"_id":"@axiaglobal/hd-wallet","name":"@axiaglobal/hd-wallet","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@axiaglobal/hd-wallet","version":"2.0.0","description":"Ledger Hardware Wallet Axia API","license":"MIT","keywords":["Ledger","LedgerWallet","axia","NanoS","Blue","Hardware Wallet"],"repository":{"type":"git","url":"git+https://github.com/AxiaCoin/axia-network-v2-hd-wallet.git"},"bugs":{"url":"https://github.com/AxiaCoin/axia-network-v2-hd-wallet/issues"},"homepage":"https://github.com/AxiaCoin/axia-network-v2-hd-wallet#readme","publishConfig":{"access":"public"},"main":"lib/Axia.js","module":"lib-es/Axia.js","types":"lib/Axia.d.ts","dependencies":{"@ledgerhq/hw-transport":"^6.3.0","bip32-path":"0.4.2","create-hash":"1.2.0","jest":"^26.4.1"},"scripts":{"build":"tsc && tsc -m ES6 --outDir lib-es","prepare":"tsc && tsc -m ES6 --outDir lib-es"},"devDependencies":{"@types/node":"^16.10.3","@types/jest":"^26.0.24","@ledgerhq/hw-transport-mocker":"^6.3.0","typescript":"^4.4.3"},"directories":{"lib":"lib","test":"tests"},"gitHead":"9784f5b19f238d56913249e38a5d0d9b4ea8aa71","_id":"@axiaglobal/hd-wallet@2.0.0","_nodeVersion":"16.15.0","_npmVersion":"8.16.0","dist":{"integrity":"sha512-EKUTbug3hi51hzHronUQjUr+erxoExsAk9EDVCVR/09WLaINmx86qluSEy7JttDb9+Z+Eij1MJyhhZ3jzJQkTg==","shasum":"b917352c4fa7e5206dd8b6393c7d02b211c7e174","tarball":"https://registry.npmjs.org/@axiaglobal/hd-wallet/-/hd-wallet-2.0.0.tgz","fileCount":13,"unpackedSize":54445,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHxAicvKL14o2Yiuqup9zwhLnDrLdb6SXoZ8Z8CSMyt9AiBoySBuO+sE3o4CoLteksYK+7ouorv3rkgTOT+MLjerNQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi/lheACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrtQQ//aoxdEbFEzw1GuyNVGhgUNAwX/yoXFZOQLVRuNsHLOmY+l7tu\r\n76wCKaFGAW/FLJ2aHQGXfgn55f/zn8c23Cp41+z46gEiWmaiLC06PCbAChvA\r\nWF6OjpymE9K4OG8Kr4jiKu4B4QjifPFVXuYbcGMmB9UTBIj7eaGHGAlXfrTG\r\n3NKcuwgWlH39bgkaQpXZErw0VY8nL60x9xb05Z4qW7B3hmw/tOHuxsmMDJE9\r\nIEqYPZx3Q0OFs/30NJ2KNqj7esiKe62EX59WFO9td9fV8krSpxLQ2Uxw249m\r\nT942nuNdhjIB5naBi9deejZz6eoeksWbGoensZDN8wqzMESVkt9G7Hh+U918\r\nBgI1tYMNqB7+Q3VMRBNcdDY7rBRXvd1GPXWU5NHbLMiQz+FWm+Zt9bayrIFb\r\nnD9WkUv4in4NW+EbVolGinqTVdHJGp5oX51MXf9sNL3ZXIbwuzXaLObqgOBY\r\nEN4Fo57WF7qYowM/eYY4FPA0OZLbzPceraCfPZ7nxzmBW9But1dw4KnNQgVp\r\nHHZI1JbUk+qw8Aq8zSdQ6+k8nUlkubVMMDsGKqdPtCOqZ+CaJ7W4ecj53X2Q\r\nFiZ8rDK0epMmtJ/LgkxsYjGVjTGf6MdCaJhqMWysA3uFuyFIT8gngOZsevuF\r\nRd0o0ZpHAebCD+Ov8a6xu9HLxyEN3lCGtc8=\r\n=BLzt\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"jeffjing98","email":"jeffjing98@gmail.com"},"maintainers":[{"name":"jeffjing98","email":"jeffjing98@gmail.com"},{"name":"zhizhou","email":"luzhizhou@hotmail.com"},{"name":"axiacoin-org","email":"lucas@axiacoin.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/hd-wallet_2.0.0_1660835934551_0.31683598247730105"},"_hasShrinkwrap":false}},"time":{"created":"2022-08-18T15:18:54.494Z","2.0.0":"2022-08-18T15:18:54.741Z","modified":"2022-08-18T15:18:54.898Z"},"maintainers":[{"name":"jeffjing98","email":"jeffjing98@gmail.com"},{"name":"zhizhou","email":"luzhizhou@hotmail.com"},{"name":"axiacoin-org","email":"lucas@axiacoin.org"}],"description":"Ledger Hardware Wallet Axia API","homepage":"https://github.com/AxiaCoin/axia-network-v2-hd-wallet#readme","keywords":["Ledger","LedgerWallet","axia","NanoS","Blue","Hardware Wallet"],"repository":{"type":"git","url":"git+https://github.com/AxiaCoin/axia-network-v2-hd-wallet.git"},"bugs":{"url":"https://github.com/AxiaCoin/axia-network-v2-hd-wallet/issues"},"license":"MIT","readme":"[Github](https://github.com/LedgerHQ/ledgerjs/),\r\n[Ledger Devs Slack](https://ledger-dev.slack.com/)\r\n\r\n## @axia-systems/hd-wallet\r\n\r\n[Ledger Hardware Wallet](https://www.ledger.com/) JavaScript bindings for [Axia](https://axia.global/), based on [LedgerJS](https://github.com/LedgerHQ/ledgerjs).\r\n\r\n## Using LedgerJS for Axia\r\n\r\nHere is a sample app for Node:\r\n\r\n```javascript\r\nconst Transport = require(\"@ledgerhq/hw-transport-node-hid\").default;\r\nconst Axia = require(\"@axia-systems/hd-wallet\").default;\r\n\r\nconst getWalletId = async () => {\r\n  const axia = new Axia(await Transport.create());\r\n  return await axia.getWalletId();\r\n};\r\n\r\nconst signHash = async () => {\r\n  const transport = await Transport.create();\r\n  const axia = new Axia(await Transport.create());\r\n  return await axia.signHash(\r\n    \"44'/9000'/0'/0/0\",\r\n    \"0000000000000000000000000000000000000000000000000000000000000000\"\r\n  );\r\n};\r\n\r\nconst getVersion = async () => {\r\n  const axia = new Axia(await Transport.create());\r\n  return await axia.getAppConfiguration();\r\n};\r\n\r\nconst getAddress = async () => {\r\n  const axia = new Axia(await Transport.create());\r\n  return await axia.getWalletPublicKey(\"44'/9000'/0'/1/0\");\r\n};\r\n\r\nconst doAll = async () => {\r\n  console.log(await getWalletId());\r\n  console.log(await getVersion());\r\n  console.log(await getAddress());\r\n  console.log(await signHash());\r\n};\r\n\r\ndoAll().catch(err => console.log(err));\r\n```\r\n\r\n## API\r\n\r\n#### Table of Contents\r\n\r\n-   [Axia](#axia)\r\n    -   [Parameters](#parameters)\r\n    -   [Examples](#examples)\r\n    -   [getWalletPublicKey](#getwalletpublickey)\r\n        -   [Parameters](#parameters-1)\r\n        -   [Examples](#examples-1)\r\n    -   [signTransaction](#signtransaction)\r\n        -   [Parameters](#parameters-2)\r\n        -   [Examples](#examples-2)\r\n    -   [getAppConfiguration](#getappconfiguration)\r\n        -   [Examples](#examples-3)\r\n    -   [getWalletId](#getwalletid)\r\n        -   [Examples](#examples-4)\r\n\r\n### Axia\r\n\r\nAxia API for Ledger\r\n\r\n#### Parameters\r\n\r\n-   `transport` **`Transport<any>`**\r\n-   `scrambleKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  (optional, default `\"Axia\"`)\r\n\r\n#### Examples\r\n\r\n```javascript\r\nimport Axia from \"@zee-ava/hd-wallet-axia\";\r\nconst axia = new Axia(transport);\r\n```\r\n\r\n#### getWalletPublicKey\r\n\r\nGet Axia address for a given BIP-32 path.\r\n\r\n##### Parameters\r\n\r\n-   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP-32 format\r\n\r\n##### Examples\r\n\r\n```javascript\r\nconst publicKey = await axia.getWalletPublicKey(\"44'/9000'/0'/0/0\");\r\n```\r\n\r\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** an object with a public key.\r\n\r\n#### signHash\r\n\r\nSign a 32-byte hash of transaction with a given BIP-32 path\r\n\r\n##### Parameters\r\n\r\n-   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP-32 format\r\n-   `hash` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** hash of a to sign\r\n\r\n##### Examples\r\n\r\n```javascript\r\nconst signature = await axia.signHash(\"44'/9000'/0'/0/0\", \"0000000000000000000000000000000000000000000000000000000000000000\");\r\n```\r\n\r\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** a signature as hex string.\r\n\r\n#### getAppConfiguration\r\n\r\nGet the version of the application installed on the hardware device.\r\n\r\n##### Examples\r\n\r\n```javascript\r\nconsole.log(await axia.getAppConfiguration());\r\n```\r\n\r\nproduces something like\r\n\r\n```\r\n{\r\n  \"version\": \"1.0.3\",\r\n  \"commit\": \"1234567\",\r\n  \"name\": \"Axc\"\r\n}\r\n```\r\n\r\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;{version: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), commit: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), name: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>** an object with a version.\r\n\r\n#### getWalletId\r\n\r\nGet the wallet identifier for the Ledger wallet. This value distinguishes different Ledger hardware devices which have different seeds.\r\n\r\n##### Examples\r\n\r\n```javascript\r\nconsole.log(await axia.getWalletId());\r\n```\r\nproduces something like\r\n\r\n```\r\nabcdefgh\r\n```\r\n\r\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** a byte string.\r\n","readmeFilename":"README.md"}