{"id":18573888,"url":"https://github.com/basedwon/newk","last_synced_at":"2025-05-15T23:34:13.139Z","repository":{"id":208346025,"uuid":"714108739","full_name":"basedwon/newk","owner":"basedwon","description":"Provides a flexible, transport-layer abstraction for various network protocols","archived":false,"fork":false,"pushed_at":"2023-11-21T02:06:41.000Z","size":116,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-19T19:37:44.444Z","etag":null,"topics":["nkn","p2p","pubsub","transport"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/basedwon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-04T00:05:06.000Z","updated_at":"2023-11-20T22:19:24.000Z","dependencies_parsed_at":"2023-11-21T03:23:53.400Z","dependency_job_id":"4016b9ce-7290-42ea-8877-6512c416a4c2","html_url":"https://github.com/basedwon/newk","commit_stats":null,"previous_names":["basedwon/newk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fnewk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fnewk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fnewk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fnewk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/basedwon","download_url":"https://codeload.github.com/basedwon/newk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442345,"owners_count":22071863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nkn","p2p","pubsub","transport"],"created_at":"2024-11-06T23:13:18.977Z","updated_at":"2025-05-15T23:34:13.048Z","avatar_url":"https://github.com/basedwon.png","language":"JavaScript","readme":"![Newk radioactive phone](docs/newk.png \"Newk\")\n\n# Newk\n\n\u003e Weapon of Mass Decentralization\n\n[![npm](https://img.shields.io/npm/v/newk?style=flat\u0026logo=npm)](https://www.npmjs.com/package/newk)\n[![pipeline](https://gitlab.com/basedwon/newk/badges/master/pipeline.svg)](https://gitlab.com/basedwon/newk/-/pipelines)\n[![license](https://img.shields.io/npm/l/newk)](https://gitlab.com/basedwon/newk/-/blob/master/LICENSE)\n[![downloads](https://img.shields.io/npm/dw/newk)](https://www.npmjs.com/package/newk) \n\n[![Gitlab](https://img.shields.io/badge/Gitlab%20-%20?logo=gitlab\u0026color=%23383a40)](https://gitlab.com/basedwon/newk)\n[![Github](https://img.shields.io/badge/Github%20-%20?logo=github\u0026color=%23383a40)](https://github.com/basedwon/newk)\n[![Twitter](https://img.shields.io/badge/@basdwon%20-%20?logo=twitter\u0026color=%23383a40)](https://twitter.com/basdwon)\n[![Discord](https://img.shields.io/badge/Basedwon%20-%20?logo=discord\u0026color=%23383a40)](https://discordapp.com/users/basedwon)\n\nProvides a flexible, transport-layer abstraction for various network protocols. By utilizing a base transport class, `newk` allows for easy extension and customization of network communication patterns. It comes with an NKN (New Kind of Network) and memory bus transport implementation and supports message routing, publish/subscribe patterns, and basic message handling.\n\n## Features\n\n- Transport-layer abstraction with a base class for easy extension.\n- Built-in NKN transport implementation for decentralized communication.\n- Support for Pub/Sub mechanisms.\n- Extendable with various decorators for additional functionality.\n- Straightforward message routing.\n\n## Installation\n\n```bash\nnpm install newk\n```\n\n## Usage\n\nImport the `Newk` class mixin from the package:\n\n```js\nimport Newk from 'newk'\n```\nor\n```js\nconst Newk = require('newk')\n```\n\n### Initializing Newk\n\n```js\n// Initialize with options\nconst options = {\n  identifier: 'your-identifier',\n  transport: 'bus', // or 'nkn'\n  decorators: ['pubsub', 'encryption'],\n  // ... other options\n}\nconst newk = await Newk.init(options, transportType)\n```\n\n### Adding Routes\n\n```js\nnewk.addRoute('action', handlerFunction)\nnewk.addRoutes(anObjectContainingMethods) // each method that starts with `on` is route\n```\n\n### Sending and Dispatching Messages\n\n```js\nawait newk.send(destination, payload, options)\nawait newk.dispatch(destination, messageType, data, options)\n```\n\n### Subscription and Publishing\n\n```js\nawait newk.subscribe(topic, metadata)\nawait newk.unsubscribe(topic)\nawait newk.publish(topic, payload)\nawait newk.broadcast(topic, messageType, data, options, excludeSelf)\n```\n\n### Getting Subscribers\n\n```js\nawait newk.getSubscribers(topic, metadata)\nawait newk.discover(topic, metadata, ...)\n```\n\n### Handling Messages\n\nThe `onMessage` method is used to handle incoming messages:\n\n```js\nnewk.onMessage((message) =\u003e {\n  // Handle the message\n})\n```\n\n### Connection Handling with NknConnect\n\nTo manage connections with `NknConnect`:\n\n```js\nconst nknConnect = await NknConnect.init(options)\n```\n\nYou can use `onMessage`, `onConnect`, and `onWsError` methods to handle different connection events.\n\n## Documentation\n\n- [API Reference](/docs/api.md)\n\n## Tests\n\nIn order to run the test suite, simply clone the repository and install its dependencies:\n\n```bash\ngit clone https://gitlab.com/basedwon/newk.git\ncd newk\nnpm install\n```\n\nTo run the tests:\n\n```bash\nnpm test\n```\n\n## Contributing\n\nThank you! Please see our [contributing guidelines](/docs/contributing.md) for details.\n\n## Donations\n\nIf you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!\n\n**Bitcoin (BTC):**\n```\n1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF\n```\n\n**Monero (XMR):**\n```\n46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ\n```\n\n## License\n\nNewk is [MIT licensed](https://gitlab.com/basedwon/newk/-/blob/master/LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasedwon%2Fnewk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasedwon%2Fnewk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasedwon%2Fnewk/lists"}