{"_id":"@astra-js/staking","_rev":"2-048cf9f59053cacac3456cc8c2d2caef","name":"@astra-js/staking","dist-tags":{"latest":"0.1.59"},"versions":{"0.1.56":{"name":"@astra-js/staking","version":"0.1.56","description":"staking transaction package for astra","main":"dist/index.js","node":"dist/index.js","browser":"dist/index.js","module":"dist/index.esm.js","jsnext:main":"dist/index.esm.js","typings":"dist/index.d.ts","types":"dist/index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"publishConfig":{"access":"public"},"author":"","license":"MIT","dependencies":{"@astra-js/crypto":"0.1.56","@astra-js/network":"0.1.56","@astra-js/transaction":"0.1.56","@astra-js/utils":"0.1.56","text-encoding":"^0.7.0"},"gitHead":"56606e9365721729a490c27d6a294e0daf90fbdf","_id":"@astra-js/staking@0.1.56","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-yQgbUFotj0oKBW9Zfcwp3nWD/Y4dsp/UG3pvQNGgo/O2HQTn6xKrLm6d2kjZeMJKx6lBRCgPYy6J1k3yENLrRA==","shasum":"ba562c6e8edf5867fa10efa8b5b74db5238c9dec","tarball":"https://registry.npmjs.org/@astra-js/staking/-/staking-0.1.56.tgz","fileCount":11,"unpackedSize":46608,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDu/1QK59DD5SEfiSHZVY5qFPC3LNkjPIMG1DL3JMW+qQIgdTpgW6FW05xEntofCpKY9bJoWJFXYSb/QWstsaH2mRk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJifYzuACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpyxg//d0dFmZl8dtV5FHf5OfH342qIJM7qe0UIdCUMJzyecq8et42X\r\nkFTtIJ65JzavErkExbeVy1ymC37pDhj5bfwAZPA2v6VymIhJXjeiibUS3LNh\r\nFStUJTpz4PdCCIZNdAJCxF6sVUbLlh8lA3p1874zRxddJ3fsun21BIQUWBGl\r\nF/V6SVXl31waHHeDfwMJEPZz0MvUh2D1HXIzMq6BWf4ejo7ucMB1Vgm+1GEU\r\nAtbGzKiMTY8HpCfozhj4Cx8XBpHpOzfChEd9swEoKFcw0lPDoeBldHlxPBKB\r\ncGbwTrju9K2SeeK1y7W9iZO0u/X3cckuKED4oBnNnuzo9EE9i0UqfEHZxwdP\r\nijYP7hJAw3hQSbqwpzwl85HMbhl8m2kFgwurLDeBsa4Bn/CRynvltSjT2HQW\r\nz26dlYy1q1atp3JAu+whcD6yr+asZjm/MCBH8FmV0DiTbya2y3nSGjp5vvBf\r\nYlbFOPlSp0gOj7uwNqDS9daJJA+nKAUdNwasELGic7T162TrtSpUoRU/EyAy\r\nY7uyt2ygJY6GQ+nYfGZx0azr5meBwtzNMl0IKHbeaZtYtXsdQKjjHW9vK2Yb\r\nxRH/6bhvPD2bUwYx8UfNwMyeAz0porWaLubH/mYDriBYRSXyeua3qxtfwv3g\r\nw1SPhmqWH8WKKOjukSP3Ig5EFuM6QlaQwH4=\r\n=KkAL\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"astra-js","email":"contact@astranetwork.com"},"directories":{},"maintainers":[{"name":"astra-js","email":"contact@astranetwork.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/staking_0.1.56_1652395246032_0.918610096354042"},"_hasShrinkwrap":false},"0.1.59":{"name":"@astra-js/staking","version":"0.1.59","description":"staking transaction package for astra","main":"dist/index.js","node":"dist/index.js","browser":"dist/index.js","module":"dist/index.esm.js","jsnext:main":"dist/index.esm.js","typings":"dist/index.d.ts","types":"dist/index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"publishConfig":{"access":"public"},"author":"","license":"MIT","dependencies":{"@astra-js/crypto":"0.1.59","@astra-js/network":"0.1.59","@astra-js/transaction":"0.1.59","@astra-js/utils":"0.1.59","text-encoding":"^0.7.0"},"gitHead":"552a541e743583dc30ce1d5312e34895c4f1c3c5","_id":"@astra-js/staking@0.1.59","_nodeVersion":"16.15.0","_npmVersion":"lerna/3.22.1/node@v16.15.0+x64 (linux)","dist":{"integrity":"sha512-xDhO1rluLnncWGgqe43lti022JcwjZcSynCLNQvu0wyGZXRnS4N3dsTrIr6OZFajgjU3Ls/ipKbiu1oyuJ/Aaw==","shasum":"07a5b63b76e1624fafdd06df061f28b8045a625d","tarball":"https://registry.npmjs.org/@astra-js/staking/-/staking-0.1.59.tgz","fileCount":23,"unpackedSize":101869,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDophepbu1Hk/4ybgbAFlrvERvnlTXFMmBfbceTCRkhPAiEAoutOUn3YKBuAFmKdQxYShgM8CIgGVqp1aOEID+DfmuQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJig9yEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmolJA/+KHcOmKK5m2wHlLXweJdbusZYBxbQ32NyCVg5uNsfj5Dt1n9j\r\nMGid3TbG6KEjNvaQCHu6LkoRNHfJe2GHKQWLjpBmRLapbU1LHVCw7PiSARm8\r\nt2KHt5kQG3sGW+2wwmUojp3fZSQE3ichN7CRLXFvGmHu1lo00vZtNEMFhO8Z\r\nOOG08FXh2LgeIr+ix3RLBRLJcu5ky1a+kaMmL3h+IfPVtSaArLhRQxF0CmSC\r\nyegenba7ZCCETRnSsDbcugjab0pg2/UuYSw7Lar5n5xoXY1ZB+HxKVUvy7np\r\n30Y3BkNiZ2dZYnrevsZnDPpTojGuixbaa5JQKM2qdMI4iZv1Utwupeo9FnsW\r\nDua2jT+ZwCi480s5GucBFGvU4MqTx1NjffbpS4InTOqhyq0J7RdoJldC8sdq\r\nU61A11SqY+y/svjt0KphhP2/jjRA+PNpaRnqzFTKCVTYR3mS+eeqhMKO8UkA\r\nwXZrvB1ciJbPRNIubuSl3rrwHs6Ea+3vSuAX7+NxVM4OSZh3Hji+ooxF7QlP\r\nmtCrkthftBLWbCO0mELFGiLmN91OP/YyEOYKj/fG1ZENCMGQHvrsGLyjzKoF\r\nKQiyGcLNAhdhrzsulBzq43exCGQtyjC09pItZw6Wn2qFEY2q3cFLQNarL30H\r\nCAI93+rY5cdJIu+NZ7td1oX59pCBL0swO5M=\r\n=JHJf\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"astra-network","email":"contact@astranetwork.com"},"directories":{},"maintainers":[{"name":"astra-network","email":"contact@astranetwork.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/staking_0.1.59_1652808836783_0.6509754337810856"},"_hasShrinkwrap":false}},"time":{"created":"2022-05-12T22:40:45.960Z","0.1.56":"2022-05-12T22:40:46.220Z","modified":"2022-05-17T17:33:57.041Z","0.1.59":"2022-05-17T17:33:56.965Z"},"maintainers":[{"name":"astra-network","email":"contact@astranetwork.com"}],"description":"staking transaction package for astra","license":"MIT","readme":"# @astra-js/staking\n\nThis package provides a collection of apis to create, sign/send staking transaction, and receive confirm/receipt.\n\n## Installation\n\n```\nnpm install @astra-js/staking\n```\n\n## Usage\n\nCreate a Astra instance connecting to testnet\n\n```javascript\nconst { Astra } = require('@astra-js/core');\nconst {\n  ChainID,\n  ChainType,\n  hexToNumber,\n  numberToHex,\n  fromWei,\n  Units,\n  Unit,\n} = require('@astra-js/utils');\n\nconst astra = new Astra(\n    'https://rpc.s0.t.astranetwork.com/',\n    {\n        chainType: ChainType.Astra,\n        chainId: ChainID.AstraTestnet,\n    },\n);\n```\nBelow, examples show how to send delegate, undelegate, and collect rewards staking transactions. First, set the chainId, gasLimit, gasPrice for all subsequent staking transactions\n```javascript\nastra.stakings.setTxParams({\n  gasLimit: 25000,\n  gasPrice: numberToHex(new astra.utils.Unit('1').asGwei().toWei()),\n  chainId: 2\n});\n```\n<span style=\"color:red\">Note: create and edit validator transactions are not fully supported in the sdk</span>\n\nCreate delegate staking transaction\n```javascript\nconst delegate = astra.stakings.delegate({\n  delegatorAddress: '0xFF9a025FdC0fd4b68Ba4e9Bff46476de15ED8f4D',\n  validatorAddress: '0x62400ea1a21468ADad8dfe8AC7dDc5a46fb29633',\n  amount: numberToHex(new Unit(1000).asOne().toWei())\n});\nconst delegateStakingTx = delegate.build();\n```\n\nSign and send the delegate transaction and receive confirmation\n```javascript\n// key corresponds to 0xFF9a025FdC0fd4b68Ba4e9Bff46476de15ED8f4D, only has testnet balance\nastra.wallet.addByPrivateKey('45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e');\n\nastra.wallet.signStaking(delegateStakingTx).then(signedTxn => {\n  signedTxn.sendTransaction().then(([tx, hash]) => {\n    console.log(hash);\n    signedTxn.confirm(hash).then(response => {\n      console.log(response.receipt);\n    });\n  });\n});\n```\n\nSimilarily, undelegate and collect reward transactions can be composed, signed and sent\nCreate undelegate staking transaction\n```javascript\nconst undelegate = astra.stakings.undelegate({\n  delegatorAddress: '0xFF9a025FdC0fd4b68Ba4e9Bff46476de15ED8f4D',\n  validatorAddress: '0x62400ea1a21468ADad8dfe8AC7dDc5a46fb29633',\n  amount: numberToHex(new Unit(1000).asOne().toWei())\n});\nconst undelegateStakingTx = undelegate.build();\n```\n\nCreate collect rewards staking transaction\n```javascript\nconst collectRewards = astra.stakings.collectRewards({\n  delegatorAddress: '0xFF9a025FdC0fd4b68Ba4e9Bff46476de15ED8f4D'\n});\nconst collectRewardsStakingTx = collectRewards.build();\n```\n\nAlso, similar to normal transaction, signing and sending can be performed asynchronously.","readmeFilename":"README.md"}