{"_id":"@atomicport/symbol","name":"@atomicport/symbol","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@atomicport/symbol","version":"0.0.1","description":"Support Cross-Chain-Swap with HTLC on any blockchains","main":"./dist/cjs/index.js","module":"./dist/esm/index.js","types":"./dist/esm/index.d.ts","license":"MIT","author":{"name":"Symbol Blockchain Community"},"private":false,"keywords":["symbol","blockchain","cross-chain-swap","htlc"],"contributors":[{"name":"faunsu19000"},{"name":"0x070696E65"}],"repository":{"type":"git","url":"git+https://github.com/ymuichiro/atomic-port.git"},"engines":{"node":">=12.22.1"},"publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/ymuichiro/atomic-port/issues"},"homepage":"https://github.com/ymuichiro/atomic-port","scripts":{"build":"npm run pre-build && npx tsc -p ./tsconfig.json && npx tsc -p ./tsconfig.esm.json","pre-build":"eslint './src/**/*.{ts, js, json}' && prettier --write src"},"peerDependencies":{"symbol-sdk":"^2.0.3","rxjs":"^7.4.0"},"gitHead":"ae5b63cc927bebb64c8eb4647afd6a1d0a633a03","_id":"@atomicport/symbol@0.0.1","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-fX9t/0QTgG8OjzxLMa/cYj5dsk6wD6lL5yWog26uWMoKzuIuNfSI3PxgvyYpy2fv77XjiuBIo/JBNXeMOUNYZg==","shasum":"b42e8372add4a31abc2183807ac4f2bed5276670","tarball":"https://registry.npmjs.org/@atomicport/symbol/-/symbol-0.0.1.tgz","fileCount":15,"unpackedSize":18751,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQChd8mb+tddHfVu59R4cKgIieIB58vNw7Q/4EFBMsVpHwIhALIszPWm2zEJP9jP5ONmYjlFn1CULqeazNQKmoX4QP7y"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj6le1ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpm2RAAiR7NmG6XOojcI/LFVg2ftqatk0XBA0ZKj00qT+tV2IlfaY/4\r\nxTDY59MM9TXURSQiSZO0oK1hwHBGIRJX0w/SiVOLzrU+yLSDMm8um02tBbPD\r\nyVFssIHo4VZDmKR5inmFxbT9VE723wXpnrXXQ+O9KbQc1Jy4Tqc4/xN9prhF\r\nCm/83lUig82gJf1kgOzlxExCugIq6fSqsSZtBBEFehqAfvLcbWIhZdyge65i\r\npsjrF3KhY5hE88PZ+ccONXX+bRVgVNVNjW4C54rkIbGXXYhVeyUpLqOrnMPb\r\nyL3k0D4NVlXzju9jZLXFO6m3fcFnzOHonCNHkmZRcfu3SRoq5RjfwC4afbmn\r\nlfCCDsNPVBBgrYEvWNEHjU2+WKkzrsjBrHxgOkRPzQpPBUxUC7eCdsLHUGTu\r\nOarBmRwsh96t3O+FahtQlN/URDK4gO8BptgHQc4tPCa35n1GmeGsqka1nCA/\r\nPhuqOZxGXdY9A1haLIDEf1S6/8wu3vG4/Qid3kQ2d0WMqIPzpyqpIXzpO4NC\r\nR81A4G8DEZa3767Mf1hcRT99yyo0QGss8tLy8CZfM3cZAo+wB+EHhcaC+0Pb\r\n3xkaUcUxQN1vjIhcF1vSdrl7CGUvFo08/dogBmseRO9M8tDOC5HMKcw1TJtI\r\nLRrI+aveil++8UewV6SoU57RitRbWE1TeT8=\r\n=0zw0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ymuichiro","email":"ym.u.ichiro@gmail.com"},"directories":{},"maintainers":[{"name":"ymuichiro","email":"ym.u.ichiro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/symbol_0.0.1_1676302261402_0.08903898521632447"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-13T15:31:01.309Z","0.0.1":"2023-02-13T15:31:01.604Z","modified":"2023-02-13T15:31:01.811Z"},"maintainers":[{"name":"ymuichiro","email":"ym.u.ichiro@gmail.com"}],"description":"Support Cross-Chain-Swap with HTLC on any blockchains","homepage":"https://github.com/ymuichiro/atomic-port","keywords":["symbol","blockchain","cross-chain-swap","htlc"],"repository":{"type":"git","url":"git+https://github.com/ymuichiro/atomic-port.git"},"contributors":[{"name":"faunsu19000"},{"name":"0x070696E65"}],"author":{"name":"Symbol Blockchain Community"},"bugs":{"url":"https://github.com/ymuichiro/atomic-port/issues"},"license":"MIT","readme":"
\n\n \n \n \n\n
\n\n[Go to top](#../../README.md)\n\n# @atomic-port/symbol\n\nThis package is for HTLC transactions between the any blockchains. HTLC allows direct transactions between different chains. Usage and examples are shown below.\n\n \n\n## Test is now open to the public.\n\nTransactions on each chain in this library are currently available only on the testnet.\nIf you wish to use it in a production environment, please change the network and other parameters.\n\n \n\n## Introduction\n\nInstall the necessary libraries\n\n**npm**\n\n```\nnpm install --save symbol-sdk@2 rxjs @atomic-port/symbol\n```\n\n**yarn**\n\n```\nyarn add symbol-sdk@2 rxjs @atomic-port/symbol\n```\n\nHTLC issues a secret and key in advance and uses this to issue a secret lock.\nWhen both parties agree to the transaction, the secret and key are exchanged separately, and the key is used to receive a token. This is how the cross-chain swap is performed.\n\n \n\n## Issue a secret lock\n\nYou can publish using this package with the following operations.\nThe output hashPair contains a secret and a proof. The secret is shared in advance, and the proof is issued at a mutually agreed timing.\n\n[lock.ts](../../examples/symbol/src/lock.ts)\n\n \n\n## Unlocking by Proof\n\nWith a secret lock, locked assets are withdrawn through a secret proof transaction.\n\n[withDraw.ts](../../examples/symbol/src/withDraw.ts)\n\n \n\nFor more detailed examples, please check the sample collection below\n[examples](examples/README.md)\n\n \n\n## More Documents\n\n- [Symbol documentation](https://docs.symbol.dev/index.html)\n- [Symbol Learning Site](https://learn.en.symbol-community.com/)\n- [Symbol Community](https://symbol-community.com/en)\n","readmeFilename":"README.md"}
![\"logo\"](\"https://user-images.githubusercontent.com/47295014/218366194-eee5969d-3c4c-4445-9303-5368c66aac9a.png\")
\n