{"_id":"2key-protocol","_rev":"4-39796b7739dde2eec0893be9374c6572","name":"2key-protocol","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"2key-protocol","version":"1.0.0","description":"TwoKeyProtocol instance","main":"index.js","directories":{"test":"test"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/2key/contracts/tree/develop/2key-protocol"},"author":"","license":"ISC","_id":"2key-protocol@1.0.0","_npmVersion":"6.2.0","_nodeVersion":"10.9.0","_npmUser":{"name":"madjarevicn","email":"nikola.madjarevic@gmail.com"},"dist":{"integrity":"sha512-hQx8G8HBzA9FNL9WsV4ZSbetFdDMJ9Ewj5l+eNB1zfNPn+FRFYqrkfFeconyFQFOz9fPPGhQqs6PcqaqBR7aew==","shasum":"d64eb8d83ffc46217a7e7c8339050c1d3f5de0a0","tarball":"https://registry.npmjs.org/2key-protocol/-/2key-protocol-1.0.0.tgz","fileCount":28,"unpackedSize":2700341,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbxeaDCRA9TVsSAnZWagAADfcQAIRDKTR7nQk1XjD9ZtJ7\nF80L2WAIo9+kORrWjVujw4URb1mXIzI4vzK8UHr/Zc2hzilMIUKjjRmsYOfW\ngpJJuqMULtl/dS4IvryRwAs9TLI6FbGKUlQO1DkRI0uZhRCWMtg1ZqHHPwuC\nVhC+08PihQS7nYFpU+E/glGMU/UiqeNqVKdVfsfCwA6HMoGlcS8F0rUgAv36\nm6u2J9XV+w4H4/K65xKbDZN/tCWOpvtXCDT8pkKP2aT0OUAzH7cHr8siWb0w\nz8tuceuH5fq7ywNlQJoDGMweufvc6b38N12BLUDTvK3kxFW3SHpN4Bw1ep3G\nu0kgg/nVsKHjUxzmglN94bXAhy8lQSfOk++PTYDZNvK/qn7n7cmAlkS8omdf\nytY642UWLuIpV7HgtmhL3dw/vJiwzr48zYOwz/cAd0k5wymgZ5ONgkYNo4m7\nt6VfwhLszMRkOiDf61Cgyq2bV8wVYDVOQLz7m04nbhwGYcWk8TVb+yU2iX+A\np+RJHC7o3WB1QtSCodqA5vnrBbHmpCk9Qn2e/o3GeY71CtK7CCcfbs0rKvtz\n+vJCOp30i38t2vRFuuCMlqYdLrfV4FfLeLId5sQR5eP+a0bR0F3htKAZKW/y\nMbVfOyTVuO3hQnkpRiHNN2CTfnxck1ofNpXXU8vrb1pvLFUWV6tk9K2LCf6v\n/FuB\r\n=NBkj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDlbrF/OarFWQ1AkcjoScE1aQEAKoq543pDlKVLFaqn8AIhAOXrzQxVVlLmVrUqQyjppFP3vhvRFfha9JtuW8VW7WCM"}]},"maintainers":[{"name":"madjarevicn","email":"nikola.madjarevic@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/2key-protocol_1.0.0_1539696258841_0.39135753606547286"},"_hasShrinkwrap":false,"deprecated":"wrong access modifier"}},"time":{"created":"2018-10-16T13:24:18.840Z","1.0.0":"2018-10-16T13:24:19.041Z","modified":"2022-04-04T10:19:18.987Z"},"maintainers":[{"email":"npm@npmjs.com","name":"npm"}],"description":"TwoKeyProtocol instance","repository":{"type":"git","url":"https://github.com/2key/contracts/tree/develop/2key-protocol"},"license":"ISC","readme":"# 2key-protocol Developer guid\n\n### How to prepare environment\n\n* ```yarn run geth``` - to start local devnet\n* deploy contracts with ```yarn run deploy --migrate dev-local,plasma-ap --reset``` this will deploy new contracts to your local node and remote syncEventsNode (http://astring.aydnep.com.ua:18545)\n* setup ```.env``` file and specify mnemonics and addresses of accounts\n* run ```yarn run test:one 2key-protocol/test/sendETH.spec.ts``` - this test will send ETH to all accounts used in test\n* run ```yarn run test``` to start tests\n* after all steps passed you can continue with development\n\n### How run Metamask debugger app\n\n* ```yarn start```\n\n### Folder structure\n\n```\n2key-protocol\n|----README.md - this file\n|----src - sources of 2key-protocol\n|    |----acquisition - Acquisition Campaign functionality\n|    |    |----index.ts - entrypoint that imported as AcquisitionCampaign subclass to our 2key-protocol class\n|    |----utils - utils and helpers functions\n|    |    |----helpers.ts - common private methods used in 2key-protocol class and all nested subclasses\n|    |    |----index.ts - entrypoint that imported as Utils subclass to our 2key-protocol class\n|    |    |----sign.ts - Udi math|crypto stuff for offchain joining\n|    |----contracts.json - abi of whitelisted contracts generated with SOLDeployer (currently unused)\n|    |----contracts.tar.gz - backup of deployed contracts to staging (ropsten.infura)\n|    |----contracts.ts - our solidity abi interface that also contains bytecodes and networks address of all our\n|    |                   singletone and other contracts that used in our 2key-protocol class\n|    |----index.ts - our 2key-protocol entrypoint\n|    |----interface.ts - definitions of all functions and datastructures\n|----dist - submodule that synced with github.com/2key/2key-protocol repo here webpack will build our library\n|----test - tests folder\n|    |----_web3.ts - test helpers to create web3 instance with wallet provider\n|    |----index.html - debugger app with metamask support\n|    |----index.spec.ts - the main test scenario, in feature we need to split this to different cases\n|    |----proxy.spec.ts - proxy for listening plasama event\n|    |----sendETH.spec.ts - test for fullfilling all needed accounts (look at .env file) with 10ETH\n|    |----sendTokens.spec.ts - test for sending truffle2Key tokens to aydnep accounts in staging network\n|    |----webapp.ts - script for debugger app\n```\n","readmeFilename":"README.md"}