{"id":16369673,"url":"https://github.com/dcsunset/chord-dht","last_synced_at":"2025-03-23T02:33:56.586Z","repository":{"id":62444372,"uuid":"465767284","full_name":"DCsunset/chord-dht","owner":"DCsunset","description":"A DHT (distributed hash table) implementation in Rust based on Chord with high performance and data replication.","archived":false,"fork":false,"pushed_at":"2022-04-27T22:05:07.000Z","size":112,"stargazers_count":11,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T16:56:04.670Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DCsunset.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":"2022-03-03T15:05:11.000Z","updated_at":"2024-01-22T19:41:40.000Z","dependencies_parsed_at":"2022-11-01T22:31:51.722Z","dependency_job_id":null,"html_url":"https://github.com/DCsunset/chord-dht","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DCsunset%2Fchord-dht","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DCsunset%2Fchord-dht/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DCsunset%2Fchord-dht/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DCsunset%2Fchord-dht/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DCsunset","download_url":"https://codeload.github.com/DCsunset/chord-dht/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245048012,"owners_count":20552431,"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":[],"created_at":"2024-10-11T02:56:00.698Z","updated_at":"2025-03-23T02:33:56.322Z","avatar_url":"https://github.com/DCsunset.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chord-dht\n\n[![crates.io](https://badgen.net/crates/v/chord-dht)](https://crates.io/crates/chord-dht)\n[![docker](https://badgen.net/docker/size/dcsunset/chord-dht)](https://hub.docker.com/repository/docker/dcsunset/chord-dht)\n\nA DHT (distributed hash table) implementation in Rust based on Chord with high performance and data replication.\n\nIt can be used either as a library or as a standalone application.\n\n## Installation\n\nFor library, add `chord-dht` to the dependencies in your `Cargo.toml`.\n\nFor standalone binaries, use `cargo install chord-dht`.\nYou can also use the docker image:\n\n```sh\n# For server (suppose the port to use is \u003cport\u003e)\ndocker run -d -p \u003cport\u003e:\u003cport\u003e chord-dht chord-dht-server \u003cserver_args\u003e\n\n# For client\ndocker run -it chord-dht chord-dht-client \u003cclient_args\u003e\n```\n\n## Usage\n\n### Library\n\nAs a client:\n\n```rust\nuse chord_dht::client::setup_client;\nuse tarpc::context;\n\n#[tokio::main]\nasync fn main() -\u003e anyhow::Result\u003c()\u003e {\n\t// server address\n\tlet addr = \"127.0.0.1:9800\"\n\tlet client = setup_client(\u0026addr).await?;\n\n\tlet ctx = context::current();\n\tlet key = \"key\".as_bytes();\n\tlet value = \"value\".as_bytes();\n\tclient.set_rpc(ctx, key.clone(), Some(value.clone())).await?;\n\tlet ret = client.get_rpc(ctx, key.clone()).await?;\n\tassert_eq!(ret.unwrap(), value);\n\tOk(())\n}\n```\n\nAs a server:\n\n```rust\nuse chord_dht::core::{\n\tNode,\n\tNodeServer,\n\tconfig::Config\n};\n\n\n#[tokio::main]\nasync fn main() -\u003e anyhow::Result\u003c()\u003e {\n\tlet node = Node {\n\t\taddr: \"127.0.0.1:9800\".to_string(),\n\t\tid: 0\n\t};\n\tlet mut server = NodeServer::new(node, Config::default());\n\tlet manager = server.start(None).await?;\n\t// Wait for the server\n\tmanager.wait().await?;\n\n\tOk(())\n}\n```\n\n\n### Standalone Application\n\nTo start a server:\n\n```sh\ncargo run -- chord-dht-server \u003cbind_addr\u003e [--join \u003caddr\u003e]\n```\n\nTo start a client:\n\n```sh\ncargo run -- chord-dht-client \u003cserver_addr\u003e\n\u003e set key value\n\u003e get key\nvalue\n```\n\n\n## Features built upon Chord\n\n* In-memory key-value storage\n* Data replication\n* Fault tolerance\n\nThe in-memory key-value DHT is aimed to be efficient when storing ephemeral data (e.g. user tokens).\n\n\n## TODO\n\n- [ ] Transfer existing keys when node is down or joins the ring\n- [ ] Allow node to leave\n\n\n## License\n\nLicensed under the [AGPLv3](LICENSE) license.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcsunset%2Fchord-dht","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdcsunset%2Fchord-dht","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcsunset%2Fchord-dht/lists"}