{"bugs":{"url":"https://github.com/streamr-dev/streamr-client-protocol-js/issues"},"dist":{"shasum":"fb48263486a78874511d733e601b3388dfc7bfbb","tarball":"https://registry.npmjs.org/streamr-client-protocol/-/streamr-client-protocol-5.3.3.tgz","fileCount":167,"integrity":"sha512-9pdyuzAvE5QZLAP/bwt5m7LRtIsdHVmN+TRhx+NSsw9K9FdaXqJrnVlci07uPfidVlITu23/ahXDm629ZvWwfQ==","signatures":[{"sig":"MEUCIQChVKq72mzHEm2cSbAlsXbuVqXQjHA3Rbff0SVY6OzYOAIgFucgZrWsoqaRKJru13FeX/hEDsf/4JDM9SRSPSHjLwA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8948831,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgBIs1CRA9TVsSAnZWagAABpMP/2wh85aN04TXyTfJvqXA\nFGhV7gOr7sjaL80HxdR9RgekyOIImPTjV05EhAr3avjn5cnlmpPBYQNqP5yW\nhz0lXx+6V6eKdarg7cd0SWIiCgT42SxoeJFj599XBNC2RFoa3s2nFW/JWELE\n11imbAJl601SQY308w93liyuFj1xtdAD6zJzzXzOxRkPKuzRjiH1xchet7dz\nnGq9JmoQ3ygJnexv+ZuoitgdbWvuhVMW21NERxcKEH47aQtUaNo47H70GXp7\nTB0tBny3NN5Skpn4rrRhxRhyVnc0abeSCuZko17ZTbXw5Lxy7TApA596HXQE\ntAgEQzEQptr5+o1JhgBErpnz9UU4ASOtzAwQ/ogL/yUKH484Ks0YGi87FRrx\nrCmutwPZeDnTs2aiHMuy7mfvTKmGGXpCPFU9n2VIs5yczo5ASWHXkM1bfAfA\nMeHG2HLBeyvTJaTPASb3TgiBiB4KtxdgYdoEC1524cnmJS+GOU/ZY9VDnC/X\n3n4vuFvcHhYPDTdCZmQV8uJla8a6SxL8Nb6EGQOCxoayDG+pEJCnszNSRQyh\nHKpZ83Gc5A3dH5LUcwCwaeqNZOAG4+C4OSwu/O6DMdnJ7g0n8HzndPA6rkP/\nsqWI7KzAFglEYahlTblXqXDLflgSEcO8hVkBFRtYyYwJXmnWFp1A4nwc0o7a\nnE3I\r\n=IrtM\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/streamr-client-protocol.js","name":"streamr-client-protocol","author":{"name":"Streamr"},"module":"src/index.js","readme":"[![Build Status](https://travis-ci.com/streamr-dev/streamr-client-protocol-js.svg?branch=master)](https://travis-ci.com/streamr-dev/streamr-client-protocol-js)\n\nThis repository contains ES6 JS implementations of the Streamr [protocol](https://github.com/streamr-dev/streamr-specs/blob/master/PROTOCOL.md) messages. This is shared code used by:\n \n - [streamr-client-javascript](https://github.com/streamr-dev/streamr-client-javascript)\n - [broker](https://github.com/streamr-dev/broker)\n - [network](https://github.com/streamr-dev/network)\n \n This package is available on npm as `streamr-client-protocol`.\n\n### Usage\n\nThis section describes how to use the Javascript implementation of the [protocol](https://github.com/streamr-dev/streamr-specs/blob/master/PROTOCOL.md).\n\n#### Creating messages from arguments\n\nEvery message type from both the Control Layer and the Message Layer is defined as a class and has a static `create` method that takes class-specific arguments to build an instance of the latest version of the message type. The arguments for each message type are defined in the [protocol documentation](https://github.com/streamr-dev/streamr-specs/blob/master/PROTOCOL.md) and in the definition of the `create` method.\n\nThis example shows how to create a `StreamMessage` and encapsulate it in a `PublishRequest`.\n\n```javascript\nconst streamMessage = new StreamMessage({\n    messageId: new MessageID(...),\n    content\n})\nconst publishRequest = new PublishRequest({\n    requestId: 'requestId', \n    streamMessage, \n})\n```\n\n#### Serializing messages to strings\n\nEvery message type from both the Control Layer and the Message Layer has a `serialize` method, which takes as argument the version to serialize to. By default, it serializes to the latest version of the message type. The `serialize` methods return a string.\n\n```javascript\nconst streamMessage = new StreamMessage({...})\nstreamMessage.serialize() // to latest version\n// > '[31,[\"streamId\",0,1529549961116,\"publisherId\",\"msgChainId\"],null,27,0,{\"foo\":\"bar\"},0,null]'\nstreamMessage.serialize(30) // to MessageLayer version 30\n// > '[30,[\"streamId\",0,1529549961116,\"publisherId\",\"msgChainId\"],null,27,{\"foo\":\"bar\"},0,null]'\n\nconst subscribeRequest = new SubscribeRequest({\n    streamId: 'streamId', \n    streamPartition: 0, \n    sessionToken: 'sessionToken',\n})\nsubscribeRequest.serialize() // to latest version\n// > '[2,9,\"requestId\",\"streamId\",0,\"sessionToken\"]'\nsubscribeRequest.serialize(1) // to ControlLayer version 1\n// > '[1,9,\"streamId\",0,\"sessionToken\"]'\n```\n\n#### Parsing messages from strings\n\nFor deserialization, use the static `deserialize` method that is present in `ControlMessage` for the ControlLayer and `StreamMessage` for the Message Layer. The `deserialize` method accepts both strings and arrays as input.\n\n```javascript\nconst serializedStreamMessage = '[30,[\"streamId\",0,1529549961116,\"publisherId\",\"msgChainId\"],null,27,{\"foo\":\"bar\"},0,null]'\nconst streamMessage = StreamMessage.deserialize(serializedStreamMessage)\n``` \n\nOn the other hand, the Control Layer has many different message types. So we can only know that the `deserialize` method will return a `ControlMessage`. We can use the `type` field to differentiate.\n\n```javascript\nconst serializedMessage = '[1,9,\"streamId\",0,\"sessionToken\"]'\nconst controlMessage = ControlMessage.deserialize(serializedMessage)\nif (controlMessage.type === ControlMessage.TYPES.UnicastMessage) {\n    //treat it as a UnicastMessage\n} else if (controlMessage.type === ControlMessage.TYPES.SubscribeRequest) {\n    //treat it as a SubscribeRequest\n} else if (...) {\n    \n} else {\n    throw new Error(`Unknown type: ${controlMessage.type}`)\n}\n```\n\n## Publishing\n\nPublishing to NPM is automated via Github Actions. Follow the steps below to publish `latest` or `beta`.\n\n### Publishing `latest`:\n1. Update version with either `npm version [patch|minor|major]`. Use semantic versioning\nhttps://semver.org/. Files package.json and package-lock.json will be automatically updated, and an appropriate git commit and tag created. \n2. `git push --follow-tags`\n3. Wait for Github Actions to run tests\n4. If tests passed, Github Actions will publish the new version to NPM\n\n### Publishing `beta`:\n1. Update version with either `npm version [prepatch|preminor|premajor] --preid=beta`. Use semantic versioning\nhttps://semver.org/. Files package.json and package-lock.json will be automatically updated, and an appropriate git commit and tag created. \n2. `git push --follow-tags`\n3. Wait for Github Actions to run tests\n4. If tests passed, Github Actions will publish the new version to NPM\n","engines":{"node":">= 10"},"gitHead":"308bde94686b979692e86867965c18c7f8eace7b","license":"Apache-2.0","scripts":{"dev":"webpack --progress --colors --watch","test":"jest","build":"rm dist/*; NODE_ENV=production webpack --mode=production --progress","eslint":"eslint .","prepare":"npm run build","pretest":"npm run eslint","coverage":"jest --coverage","benchmark":"jest test/benchmarks --detectOpenHandles","test-unit":"jest test/unit --detectOpenHandles","test-integration":"jest test/integration --detectOpenHandles"},"_npmUser":{"name":"timoxley","email":"secoif@gmail.com"},"homepage":"https://github.com/streamr-dev/streamr-client-protocol-js#readme","repository":{"url":"git://github.com/streamr-dev/streamr-client-protocol-js.git","type":"git"},"_npmVersion":"6.14.8","description":"JavaScript classes implementing the Streamr client-to-node protocol","directories":{"test":"test"},"maintainers":[{"name":"kare","email":"kare.nuorteva@me.com"},{"name":"juhah","email":"juha.haavisto@streamr.com"},{"name":"fonty1","email":"mr.matto@gmail.com"},{"name":"hpihkala","email":"henri.pihkala@streamr.com"},{"name":"tumppi","email":"tuomas.koponen@streamr.com"},{"name":"timoxley","email":"secoif@gmail.com"},{"name":"harbu","email":"harbuzen@gmail.com"},{"name":"mariusz_io","email":"mariusz@mariusz.io"},{"name":"pzsavola","email":"petri.savolainen@spaceify.net"},{"name":"mmartinmo","email":"martin.moravek@streamr.com"},{"name":"juslesan","email":"santeri.juslenius@gmail.com"},{"name":"jtakalai","email":"juuso.takalainen@streamr.com"},{"name":"jwolff","email":"jwolff@isentropy.com"},{"name":"streamr-dev","email":"devtools@streamr.com"},{"name":"teogeb","email":"teo@streamr.com"}],"_nodeVersion":"14.15.1","dependencies":{"heap":"^0.2.6","sha3":"^2.1.3","debug":"^4.2.0","ethers":"^5.0.14","core-js":"^3.6.5","hashring":"^3.2.0","secp256k1":"^4.0.2","eventemitter3":"^4.0.7","promise-memoize":"^1.2.1","@babel/runtime-corejs3":"^7.11.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^26.4.2","sinon":"^9.0.3","buffer":"^6.0.3","eslint":"^7.9.0","webpack":"^4.44.2","@babel/cli":"^7.11.6","babel-jest":"^26.3.0","@babel/core":"^7.11.6","await-sleep":"0.0.1","webpack-cli":"^3.3.12","babel-eslint":"^10.1.0","babel-loader":"^8.1.0","array-shuffle":"^1.0.1","eslint-loader":"^4.0.2","webpack-merge":"^5.1.4","@babel/preset-env":"^7.11.5","web3-eth-accounts":"^1.3.0","eslint-config-airbnb":"^18.2.0","eslint-plugin-import":"^2.22.0","eslint-plugin-promise":"^4.2.1","terser-webpack-plugin":"^4.2.2","webpack-node-externals":"^2.5.2","eslint-config-streamr-nodejs":"^1.3.0","@babel/plugin-transform-classes":"^7.10.4","@babel/plugin-transform-runtime":"^7.11.5","babel-plugin-add-module-exports":"^1.0.4","@babel/plugin-proposal-class-properties":"^7.10.4","babel-plugin-transform-class-properties":"^6.24.1","@babel/plugin-transform-modules-commonjs":"^7.10.4"},"_npmOperationalInternal":{"tmp":"tmp/streamr-client-protocol_5.3.3_1610910516622_0.08623340038756444","host":"s3://npm-registry-packages"},"_id":"streamr-client-protocol@5.3.3","version":"5.3.3"}