8 releases
new 0.4.3-rc.0 | Apr 18, 2025 |
---|---|
0.4.2 | Mar 20, 2025 |
0.4.2-rc.1 | Feb 27, 2025 |
0.3.0 | Oct 25, 2024 |
0.1.0 | Sep 6, 2024 |
#1307 in Network programming
452 downloads per month
Used in 2 crates
87KB
1.5K
SLoC
Pubky
Rust implementation implementation of Pubky client.
Quick Start
use pubky_testnet::EphemeralTestnet;
use pubky::Keypair;
#[tokio::main]
async fn main () {
// Mainline Dht testnet and a temporary homeserver for unit testing.
let testnet = EphemeralTestnet::start().await.unwrap();
let client = testnet.pubky_client_builder().build().unwrap();
let homeserver = testnet.homeserver_suite();
// Generate a keypair
let keypair = Keypair::random();
// Signup to a Homeserver
let keypair = Keypair::random();
client.signup(&keypair, &homeserver.public_key(), None).await.unwrap();
// Write data.
let url = format!("pubky://{}/pub/foo.txt", keypair.public_key());
let url = url.as_str();
let data = [0, 1, 2, 3, 4].to_vec();
// The client has the same familiar API of a reqwest client
client.put(url).body(data.clone()).send().await.unwrap();
// Read using a Public key based link
let response = client.get(url).send().await.unwrap();
let response_data = response.bytes().await.unwrap();
assert_eq!(response_data, data);
// Delete an entry.
client.delete(url).send().await.unwrap();
let response = client.get(url).send().await.unwrap();
assert_eq!(response.status(), 404);
}
Example code
Check more examples for using the Pubky client.
Wasm Rust Analyzer
In vscode with the rust-analyzer, wasm behind the #[cfg(wasm_browser)]
guard is not type checked. To fix this, add
a .vscode/settings.json
file in the root of this project with the following content:
{
"rust-analyzer.cargo.target": "wasm32-unknown-unknown"
}
If not done already, you need to add the wasm target: cargo target add wasm32-unknown-unknown
.
This is just a workaround because it enables the wasm feature in all workspace member which creates problems. So it is best to enable this settings only temporarily for wasm development and then turn it off again before commiting the changes. This is a rust-analyzer issue.
How To Build/Test the NPM Package
- Go to
pubky-client/pkg
. - Run
npm run build
. - Run a testnet mainline DHT, Pkarr relay and Homeserver
npm run testnet
- Run tests with
npm run test
.
Dependencies
~10–24MB
~371K SLoC