{"_id":"@bitsoft-network/cashier-coinbase","_rev":"3-07bd8d4dcd21de57c9bc1dd7916fc996","name":"@bitsoft-network/cashier-coinbase","dist-tags":{"latest":"1.0.5"},"versions":{"1.0.3":{"name":"@bitsoft-network/cashier-coinbase","version":"1.0.3","description":"Simplified Coinbase API manager package.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/bitsoft-network/cashier-coinbase.git"},"keywords":["coinbase","api","http"],"author":{"name":"Leevi Halme","email":"me@leevihal.me","url":"https://leevihal.me/"},"license":"MIT","bugs":{"url":"https://github.com/bitsoft-network/cashier-coinbase/issues"},"homepage":"https://github.com/bitsoft-network/cashier-coinbase#readme","dependencies":{"axios":"^0.25.0"},"gitHead":"4359d7920e9bf237dc2ee9988bab937095a5ea77","_id":"@bitsoft-network/cashier-coinbase@1.0.3","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-o0UuhX/iUegjpqK8961bJv7f1wq5JeUNkxTsYvOJ1kh3iM00CqP/MofZX67kI0AACiCLoNY0yNTXhSxEXPDTXA==","shasum":"bdee9f7ec22bdcc63c23733b1a8d03af39b26ab3","tarball":"https://registry.npmjs.org/@bitsoft-network/cashier-coinbase/-/cashier-coinbase-1.0.3.tgz","fileCount":4,"unpackedSize":16537,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKdrDACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqamw/8Chf3FpxkEnIi1Kac1OKce5P+tVE4fl3GM7vuOUHJ2Df/r2+N\r\nXvmzE6NoLNAIZC8zzBNeFGFcdc/BQuX0FQwk09f7sz0e4Vk1lP+oL+LSDOL9\r\nr8vcXAf9X7QGQMeSMkcYECZb0O/GfzURQamXwq6d7xpm/D+gPx+UovUAFFxs\r\nQbWVz3FyCvp1oCHrZjvwcoMpjHetj2PsKynnOXJrIZk3Z1A8yy718Gn+X9E3\r\nu9eRlSIjWgOXnImTaq9fzchd5DSBARE81XioJfa6JEHjwTvJz1dkDKlAJxD4\r\nFRy7n9nJTWKSfQ9jKkTG3KgIXJh1Lliu0qJSt4T27gPonUxn/HGpb5NgY8KL\r\n6DgPuAnyjpAAHO8/65cW+CeGkjdIBy+e+eOz8/OgA1SW37KHWUMtub5BbQEB\r\nlgxvON21x0HQ5mg5kdaEcIskXG8Md+IMJikQBuuYCOlRtze9wVj6xX/t0a7n\r\nRxOrPm/Eus6zttqKco0vY4TaKGSdbm333ouw/5mVkXzg2kcR2w7kmFj5ocHV\r\npCqcARvW+ic8MZOXbdST7NQvrbEzMSJY+OGGR+xpZWWhZCwL+lCI+kTRXbUT\r\nZNA8PepIW/nZP12nIkcAeNCwRIUGUIYg7pRZB0ui7RZrDDNUr+W+9/YCGjQc\r\n19r07zvYMKUppAtwRUPYOpf3Lp5v0PZRYcU=\r\n=Qk3u\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBNBgnYzWxMOjJmUKcl142odP9nUoCDIOfK4wrHRPhUVAiBGM6mMc6+lPIWBCdXEWKRs7hBiDyV2/gf8jeyC6vMVmg=="}]},"_npmUser":{"name":"leevihalme","email":"leevi.halme2@gmail.com"},"directories":{},"maintainers":[{"name":"leevihalme","email":"leevi.halme2@gmail.com"},{"name":"bitsoft-admin","email":"bitsoftnetwork@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cashier-coinbase_1.0.3_1646910147159_0.757064680597902"},"_hasShrinkwrap":false},"1.0.4":{"name":"@bitsoft-network/cashier-coinbase","version":"1.0.4","description":"Simplified Coinbase API manager package.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/bitsoft-network/cashier-coinbase.git"},"keywords":["coinbase","api","http"],"author":{"name":"Leevi Halme","email":"me@leevihal.me","url":"https://leevihal.me/"},"license":"MIT","bugs":{"url":"https://github.com/bitsoft-network/cashier-coinbase/issues"},"homepage":"https://github.com/bitsoft-network/cashier-coinbase#readme","dependencies":{"axios":"^0.25.0"},"gitHead":"bfce725b05923eca715fbf86510e58fc631828e4","_id":"@bitsoft-network/cashier-coinbase@1.0.4","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-5zSFMGszBhkkS0HPlMc/ys0VdlZ1K9+Jke2j+bboBR390bBncJ916TuHqbjCiAivSxQHAii9UsDEDoH38U1A3g==","shasum":"1cc5909dd220e8eb2a9230c9aa8728c7e10b3554","tarball":"https://registry.npmjs.org/@bitsoft-network/cashier-coinbase/-/cashier-coinbase-1.0.4.tgz","fileCount":4,"unpackedSize":16633,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKi7ZACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpgoA/8C/yC6kr0X6qsnFIukN3skc3VCXTY/5dCPftzZZbWQTJxkZvw\r\noA6PDVVDtD1u6wDzGaWNlMvyJmbjDPCT8N+50lMHo2OrHNZ44A9GfUfRQGjb\r\ncVXOh7ZjXSI/CdEoDlRnbYDjar3xdy9avTJwn5sRx7hvZdoAK4J9Ey1aQaR2\r\nmhQRc5V+AZqxpZz5mqaMBvi8EZg6vcjWIR4/lcZ88ntjldUV+gG/Z2ICg0Z0\r\nU8eQHeGS4mZIjE+yHZkP5msH452tmeKNRELUoUvPaL8boROeVH0L+kJXS0tp\r\nB8B4VnR9PY1sCroUHX2KSPS9lc+HEy6cdCmJiIOoSm4OSYua/aC+ir0xqBTu\r\nXlVwfYHNolr7t8TlkbmOty6e/eHsFsdFmcjrZ/yGVBdlVEBb2KAO5ohw0+fi\r\ngq4YZcssWM/lqqfzoXX9wSBcvC3ys33OD4LZ82qEEnn67RLohnoTI6Y6V3dg\r\nasKfinAh8BAeEvNuzVRANPMnmFOUruYKv9kFlJwmVhhgnpWLWEWgFLq4w28C\r\nxTVzGONFS5Qv94aNwp1VGgrmW9NHksabbDW8n5TuQ66m5JH4xf65uOU4QI5S\r\nipMN4RmnRv/N/Q66LN7ONQQcmJ2pAGQr7EqvT9cvc9TBHvoWyai7rAYzR5Ih\r\npjN21KK5Hu30t5mThq581UXZOKiZrbyHeGk=\r\n=LEB4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDxt8JrwUoFRaiDXRH6cYxAtee2JjUcfpuJ5Ode5C7phgIgRO9VbG6bqHospU4vlC7BU56oPRJJbzsZ8es5ZyHkV/s="}]},"_npmUser":{"name":"leevihalme","email":"leevi.halme2@gmail.com"},"directories":{},"maintainers":[{"name":"leevihalme","email":"leevi.halme2@gmail.com"},{"name":"bitsoft-admin","email":"bitsoftnetwork@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cashier-coinbase_1.0.4_1646931673174_0.1678771331679081"},"_hasShrinkwrap":false},"1.0.5":{"name":"@bitsoft-network/cashier-coinbase","version":"1.0.5","description":"Simplified Coinbase API manager package.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/bitsoft-network/cashier-coinbase.git"},"keywords":["coinbase","api","http"],"author":{"name":"Leevi Halme","email":"me@leevihal.me","url":"https://leevihal.me/"},"license":"MIT","bugs":{"url":"https://github.com/bitsoft-network/cashier-coinbase/issues"},"homepage":"https://github.com/bitsoft-network/cashier-coinbase#readme","dependencies":{"axios":"^0.25.0"},"gitHead":"a92e0845fa5210e4eafef553eb7dd067a653a877","_id":"@bitsoft-network/cashier-coinbase@1.0.5","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-6trwIC9sibgBqRlaIrwdlOKR8LOFePguCgbwrNAujTtmwaeKYh6Cjc9mqKnrNDo5UGFsqC7NojlOZBBF4+ytag==","shasum":"ee98288ab96836e4104da8b2947e2c2cfc4d69b3","tarball":"https://registry.npmjs.org/@bitsoft-network/cashier-coinbase/-/cashier-coinbase-1.0.5.tgz","fileCount":4,"unpackedSize":16666,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKjPLACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrLHg/+OKIFbEQcUYlJH8VJ534OImxgBz177QT8Klu4flM4WXEvZWqC\r\nZjKNmM2VRduYrxwCb0dB0Ja2ZYYUZG1p3LMyNILkX+zyQinggtW/Uw0ltVPB\r\nmHrzy9W3nCKqJ20RftSKhuYr5ldJ09GYtgtaTrxSpfGcer265mEDU03kDAen\r\nb+1zUU6Mbjpypr5+i/6fnyRCKzpAjFHSfs7CcFf2h6bMPgMdmJSOtmrWTFMT\r\nSn9OoeC2EJVGIKZKJBc+LNha9+PwBNPcaw5C+1qBxTGECoyhdKiHQRP6fpyh\r\nTpbm8A0jVjtOxzfWBY+dOlBDzz/KbDTfpp/OLOaxuvxz4IiXPGCnJDOfBP03\r\naaA+LUfXFhqUMvlDpZqXMcysSQyebk5nscQFrooygH6Oww1MuW+vgR+3yLsl\r\nUg298MR/tGYs/eWFP/57aipHI6jCL+nIdKN1IpO89jNMYvBAZxWvSnpUtRyS\r\nAbdZ9+O55/tsRnBmmDOE1A3ERymj+IzUPJG88aCeNyIzL6XZ8tejro6V+DZR\r\nDlcI1hTvYbHYdWtkj/hq0B9RXJG6Cc1D8HCj+nRD+guapJtbbeIcWMJQJNuo\r\nPwDR5AUtvY8/DHXwRRjaxIdyZ07pqen49b07BWmXViBOONnUENfUsDEdRIUj\r\nQt8ESgc+9DX2IfEoZJsf/wlbWj8zYOQyD9k=\r\n=rPRd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCMpfpbvL4YoKhsfjI2PW1xrMyfXtSkxxheUBu7YYL+fQIgGbz5+oyBpJMbGBZ+hZMODdOr5LUt6MM0x+tBxGCm8dY="}]},"_npmUser":{"name":"leevihalme","email":"leevi.halme2@gmail.com"},"directories":{},"maintainers":[{"name":"leevihalme","email":"leevi.halme2@gmail.com"},{"name":"bitsoft-admin","email":"bitsoftnetwork@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cashier-coinbase_1.0.5_1646932939252_0.1271337370457808"},"_hasShrinkwrap":false}},"time":{"created":"2022-03-10T11:02:27.085Z","1.0.3":"2022-03-10T11:02:27.286Z","modified":"2022-04-04T19:14:14.890Z","1.0.4":"2022-03-10T17:01:13.316Z","1.0.5":"2022-03-10T17:22:19.398Z"},"maintainers":[{"name":"leevihalme","email":"leevi.halme2@gmail.com"},{"name":"bitsoft-admin","email":"bitsoftnetwork@protonmail.com"}],"description":"Simplified Coinbase API manager package.","homepage":"https://github.com/bitsoft-network/cashier-coinbase#readme","keywords":["coinbase","api","http"],"repository":{"type":"git","url":"git+https://github.com/bitsoft-network/cashier-coinbase.git"},"author":{"name":"Leevi Halme","email":"me@leevihal.me","url":"https://leevihal.me/"},"bugs":{"url":"https://github.com/bitsoft-network/cashier-coinbase/issues"},"license":"MIT","readme":"# cashier-coinbase\r\n\r\nSimplified Coinbase API manager package.\r\n\r\n## Usage\r\n\r\nInstall the package by typing `npm i @bitsoft-network/cashier-coinbase` in your project folder.\r\n\r\n### Setup\r\n\r\n###### Example:\r\n\r\n```javascript\r\nconst CoinbaseCashier = require(\"@bitsoft-network/cashier-coinbase\");\r\n\r\nconst client = new CoinbaseCashier({\r\n  apiKey: \"lamekey\",\r\n  apiSecret: \"lamesecret\",\r\n});\r\n```\r\n\r\n## Methods\r\n\r\n### getCashierAccounts\r\n\r\nGet cashier accounts information (BTC, ETH and LTC).\r\n\r\n###### Example:\r\n\r\n```javascript\r\nconst accounts = await client.getCashierAccounts();\r\n```\r\n\r\n#### Parameters\r\n\r\nNone\r\n\r\n#### Returns\r\n\r\n- Object (AccountsObject)\r\n\r\n### createDepositAddresses\r\n\r\nCreate user's deposit addresses (BTC, ETH and LTC)\r\n\r\n###### Example:\r\n\r\n```javascript\r\nconst addresses = await client.createDepositAddresses(userId);\r\n```\r\n\r\n#### Parameters\r\n\r\n- userId (String)\r\n\r\n#### Returns\r\n\r\n- Object (AddressesObject)\r\n\r\n### createNewWithdraw\r\n\r\nCreate a new withdraw. Amount must be in cryptocurrency (max 4 decimal places). Transaction ID is to ensure every transaction is unique and only executed once.\r\n\r\n###### Example:\r\n\r\n```javascript\r\nconst withdraw = await client.createNewWithdraw(\r\n  currency,\r\n  amount,\r\n  toAddress,\r\n  transactionId\r\n);\r\n```\r\n\r\n#### Parameters\r\n\r\n- currency (String [ BTC | ETH | LTC ])\r\n- amount (String)\r\n- toAddress (String)\r\n- transactionId (String)\r\n\r\n#### Returns\r\n\r\n- Object (WithdrawObject)\r\n\r\n### getExchangeRate\r\n\r\nGet exchange rate for two currencies. Return value will contain exchange rate for one unit of currency.\r\n\r\n###### Example:\r\n\r\n```javascript\r\nconst rate = await client.getExchangeRate(currency, toCurrency);\r\n```\r\n\r\n###### Example 2:\r\n\r\n```javascript\r\nconst rate = await client.getExchangeRate(\"BTC\", \"EUR\"); // 35409.37\r\n```\r\n\r\n#### Parameters\r\n\r\n- currency (String)\r\n- toCurrency (String)\r\n\r\n#### Returns\r\n\r\n- Object (RateObject)\r\n\r\n### validateNotification\r\n\r\nValidate incoming IPN (Instant Payment Notification).\r\n\r\n###### Example:\r\n\r\n```javascript\r\nconst valid = await client.validateNotification(body, signature);\r\n```\r\n\r\n#### Parameters\r\n\r\n- body (ExpressJsRequest, Object)\r\n- signature (String)\r\n\r\n#### Returns\r\n\r\n- Boolean\r\n\r\n## Objects\r\n\r\n### ConfigObject\r\n\r\nObject which holds all configuration values.\r\n\r\n#### Example\r\n\r\n```javascript\r\nconst config = {\r\n  // Coinbase API key\r\n  apiKey: \"lamekey\",\r\n\r\n  // Coinbase API secret\r\n  apiSecret: \"lamesecret\",\r\n\r\n  // API version to use. Default\r\n  // version is: \"2022-01-30\"\r\n  apiVersion: \"\",\r\n\r\n  // Whether or not to show debug\r\n  // messages\r\n  debug: false,\r\n};\r\n```\r\n\r\n### AccountsObject\r\n\r\nStores the Coinbase accounts used by cashier\r\n\r\n#### Example\r\n\r\n```javascript\r\n{\r\n  BTC: {\r\n    id: \"...\",\r\n    name: \"BTC Wallet\",\r\n    primary: true,\r\n    type: \"wallet\",\r\n    currency: {\r\n      code: \"BTC\",\r\n      name: \"Bitcoin\",\r\n      color: \"#F7931A\",\r\n      sort_index: 100,\r\n      exponent: 8,\r\n      type: \"crypto\",\r\n      address_regex: \"^([13][a-km-zA-HJ-NP-Z1-9]{25,34})|^(bc1([qpzry9x8gf2tvdw0s3jn54khce6mua7l]{39}|[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{59}))$\",\r\n      asset_id: \"...\",\r\n      slug: \"bitcoin\"\r\n    },\r\n    balance: { \"amount\": \"0.00000000\", \"currency\": \"BTC\" },\r\n    created_at: \"2018-08-28T00:00:00Z\",\r\n    updated_at: \"2018-08-28T00:00:00Z\",\r\n    resource: \"account\",\r\n    resource_path: \"/v2/accounts/...\",\r\n    allow_deposits: true,\r\n    allow_withdrawals: true\r\n  },\r\n  ETH: { ... },\r\n  LTC: { ... }\r\n}\r\n```\r\n\r\n### AddressesObject\r\n\r\nNewly created addresses from Coinbase API.\r\n\r\n#### Example\r\n\r\n```javascript\r\n{\r\n  BTC: '...btcAddress',\r\n  ETH: '...ethAddress',\r\n  LTC: '...ltcAddress'\r\n}\r\n```\r\n\r\n### WithdrawObject\r\n\r\nNewly created withdraw from Coinbase API.\r\n\r\n#### Example\r\n\r\n```javascript\r\n{\r\n  id: \"...transactionIdFromCoinbase\",\r\n  network: {\r\n    status: \"unconfirmed\",\r\n    hash: \"463397c87beddd9a61ade61359a13adc9efea26062191fe07147037bce7f33ed\",\r\n    name: \"bitcoin\"\r\n  }\r\n}\r\n```\r\n\r\n## License\r\n\r\nMIT <3\r\n","readmeFilename":"README.md"}