{"bugs":{"url":"https://github.com/streamr-dev/streamr-client-protocol-js/issues"},"dist":{"shasum":"ae3ddfe405424bfd345fc0eb6d683d4a01b2f31a","tarball":"https://registry.npmjs.org/streamr-client-protocol/-/streamr-client-protocol-7.1.3-1.tgz","fileCount":3,"integrity":"sha512-mQ8Gp8Z3HPI3Bxv46V2Ki03mXJPQISfMB73HJotSknxX3QBOgsHncGpVerv1izVXtLdPGULp2LbUtHN1NluxFg==","signatures":[{"sig":"MEUCIQDLPsjsXPrcf7xO2EHOAqPiRZzk1Dqw5oXfGhfcsQeHBwIgX0tKs6aqkBcQTGX1bM4Ycz+omoJ2+G9P9KnNs/RMsD4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":17522,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4e0GCRA9TVsSAnZWagAAFfQQAIyiJCCzFXPx1ZobdcCi\nkAL1It8OgDdq5XgaJ+ikbsaoOQPTzuw776bb1aTrWbnFB6xjeTmaGS4H2PQn\nVfr/qdtWNQU5mUoIj8w8Ikcf1aYWA1Iybz1OHLe26PkWyg06z9Apox0hl/DU\ng9xWWk9tduR0AAo02+phLJCyaMVXzGKMc/ucywclnG2PUN5KsyVMosN/pNdQ\njspzOW4B3wsg++DnzlgfG1Vh/ANXUWfLlkKQEOYmTEdta41iC+9cDkRjnlwX\nBoclssl7tsPbmrrmFN1zIMujk9HM3uv+WeVtHqZLgzLQ0chg+LKWVOLYZj9f\ne4S5iyx+M2RL1Ibn+7GU1CIfSGTJinHqnT3FTwzH6ZDEPBpz6c9H9W1uvFcL\n+p5Xv5FKLpqgfHlFbeN6U7l/rhwxt7pGI3kXVkmUhZX4r8daqlaOxRrW3beq\nP3ylBFD2N4uhkyX8bn4WacT1fqywkZgnPX2KVrQdacTQSu8PsIVcodcw46J3\n4xjRmwcGzALmFoayAd6hFsvquFRLG95WSSjmzGrB3rWyUTdA3/q2ZTJiDAzv\nI2yZ3OjKhhdWozzDuZXQd8e1CWGXq/FwEwAEHobTYI6PS8y12DVt4gks3GW0\nL25RuECZu9vfpH8c9kXAwZC/PThQ1X0jVxSv4NV0J6TJR6uQkCbxs3F7KZur\nweKz\r\n=pInU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/src/index.js","name":"streamr-client-protocol","types":"./dist/src/index.d.ts","author":{"name":"Streamr"},"readme":"# streamr-client-protocol\n\nES6 JS implementations of [Streamr Protocol](https://github.com/streamr-dev/streamr-specs/blob/master/PROTOCOL.md) messages. This is shared code used by (at least):\n \n - [streamr-client-javascript](https://github.com/streamr-dev/streamr-client-javascript)\n - [streamr-broker](https://github.com/streamr-dev/streamr-broker)\n - [streamr-network](https://github.com/streamr-dev/streamr-network)\n \n The package is available on npm as `streamr-client-protocol`.\n \n ## Table of Contents\n- [Use](#use)\n- [Release](#release)\n\n## Use\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## Release\n\nPublishing to NPM is automated via Github Actions. Follow the steps below to publish stable (`latest`) or `beta`.\n\n### Publishing stable (latest)\n1. `git checkout master && git pull`\n2. 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. \n3. `git push --follow-tags`\n4. Wait for Github Actions to run tests\n5. 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","gitHead":"fe685b19dd084983026cb6ba2c25b5f4693d384c","license":"Apache-2.0","scripts":{"test":"jest","build":"tsc --build --clean && tsc --build","eslint":"eslint '{src,test}/**/*.ts'","prepare":"npm run build","coverage":"jest --coverage","benchmark":"jest test/benchmarks --detectOpenHandles","test-unit":"jest test/unit --detectOpenHandles","test-integration":"jest test/integration --detectOpenHandles"},"_npmUser":{"name":"harbu","email":"harbuzen@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":{},"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.0","dependencies":{"heap":"^0.2.6","sha3":"^2.1.3","debug":"^4.3.1","ethers":"^5.0.24","secp256k1":"^4.0.2","eventemitter3":"^4.0.7","promise-memoize":"^1.2.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^26.6.3","sinon":"^9.2.2","eslint":"^7.15.0","ts-jest":"^26.4.4","ts-node":"^9.1.1","typescript":"^4.1.3","@types/heap":"^0.2.28","@types/jest":"^26.0.19","@types/node":"^14.14.14","await-sleep":"0.0.1","@types/debug":"^4.1.5","@types/sinon":"^9.0.9","array-shuffle":"^2.0.0","eslint-loader":"^4.0.2","web3-eth-accounts":"^1.3.0","eslint-config-airbnb":"^18.2.1","eslint-plugin-import":"^2.22.1","eslint-plugin-promise":"^4.2.1","@types/promise-memoize":"^1.2.0","@typescript-eslint/parser":"^4.10.0","eslint-config-streamr-nodejs":"^1.3.0","@typescript-eslint/eslint-plugin":"^4.11.0"},"_npmOperationalInternal":{"tmp":"tmp/streamr-client-protocol_7.1.3-1_1608641798647_0.07610322327591135","host":"s3://npm-registry-packages"},"_id":"streamr-client-protocol@7.1.3-1","version":"7.1.3-1"}