{"id":13416908,"url":"https://github.com/drom/reqack","last_synced_at":"2025-04-26T18:13:26.139Z","repository":{"id":51001089,"uuid":"51901676","full_name":"drom/reqack","owner":"drom","description":"🔁 elastic circuit toolchain","archived":false,"fork":false,"pushed_at":"2024-12-02T05:09:52.000Z","size":282,"stargazers_count":30,"open_issues_count":24,"forks_count":5,"subscribers_count":3,"default_branch":"trunk","last_synced_at":"2025-04-17T21:35:05.496Z","etag":null,"topics":["hacktoberfest","hardware-description-language","hdl","verilog"],"latest_commit_sha":null,"homepage":"https://observablehq.com/collection/@drom/reqack","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/drom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-17T06:55:26.000Z","updated_at":"2025-01-03T09:17:06.000Z","dependencies_parsed_at":"2022-09-02T03:30:59.140Z","dependency_job_id":null,"html_url":"https://github.com/drom/reqack","commit_stats":null,"previous_names":["drom/elastic"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drom%2Freqack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drom%2Freqack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drom%2Freqack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drom%2Freqack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drom","download_url":"https://codeload.github.com/drom/reqack/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250713476,"owners_count":21475186,"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":["hacktoberfest","hardware-description-language","hdl","verilog"],"created_at":"2024-07-30T22:00:29.419Z","updated_at":"2025-04-25T15:44:14.558Z","avatar_url":"https://github.com/drom.png","language":"JavaScript","funding_links":[],"categories":["Meta HDL and Transpilers"],"sub_categories":[],"readme":"[![NPM version](https://img.shields.io/npm/v/reqack.svg)](https://www.npmjs.org/package/reqack)\n[![Linux](https://github.com/drom/reqack/actions/workflows/linux.yml/badge.svg)](https://github.com/drom/reqack/actions/workflows/linux.yml)\n[![MacOS](https://github.com/drom/reqack/actions/workflows/macos.yml/badge.svg)](https://github.com/drom/reqack/actions/workflows/macos.yml)\n[![Windows](https://github.com/drom/reqack/actions/workflows/windows.yml/badge.svg)](https://github.com/drom/reqack/actions/workflows/windows.yml)\n[TUTORIAL](https://beta.observablehq.com/@drom/reqack)\n\n# REQuest ⇄ ACKnowledge\n\nJavaScript Tool set to construct, transform and analyze digital circuits based on elastic transactional [protocol](./docs/protocol.md) and Request-Acknowledge handshake.\n\nUser describes circuit JavaScript API, add standard components from the library, or create new componets.\n\nSeveral standard [controllers](./docs/controller.md) provided.\n\nUser can transform constructed circuit by changing buffer capacity or performing other correct by construction transformations.\n\n## Usage\n\nThe package can be installed from `npm`:\n\n```sh\nnpm i reqack\n```\n\nand imported into your JavaScript code:\n\n```js\nconst reqack = require('reqack');\n```\n\nA **circuit** can be constructed this way:\n\n```js\nconst g = reqack.circuit('circuit_name');\n```\n\nA **node** can be constructed by calling the circuit function. Optional `node_label` string will be used as standard or custom operation or as a root of a signal name.\n\n```js\nconst node1 = g('node_label');\n```\n\nA **edge** can be constructed by calling the node function. Optional argument is an `Object` with two major properties (width, capacity).\n\n```js\nconst edge1 = node1({width: 32, capacity: 1});\n```\n\nOne node can be **connected** to another node by calling edge with a destination node.\n\n```js\nedge1(node2); // -\u003e edge1\n```\n\nResulted Verilog RTL can be produced by calling\n\n```js\nconst verilogString = reqack.verilog(g, {});\n```\n\nSVG image can be rendered by calling\n\n```js\nconst svg = reqack.svg(g);\n```\n\n## Testing\n\n```sh\nnpm i\nnpm test\n```\n\n## License\n\nMIT [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrom%2Freqack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrom%2Freqack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrom%2Freqack/lists"}