Deploy watcher + Key generation (#34)

* Deploy watcher MVP * MVP deploy watcher * MVP wait_deploy * stash * Fix bytes_stream cut * Stash tests * satash return Vec in watch/ wait * Stash * Stash changes in types * Bad comment * Timeout in the watcher * Code documentation * Update readme for deploy_watcher * bad temp file * bad key * Update doc * Update doc * Clean up * Remove clone * Debug * Revert * Test usage * Fix test * Remove pk * Fix hello teest * Add some unit tests * Update build * Uodate readme and build * Update doc * secret_key_generate / secret_key_secp256k1_generate * Remove todo * Adding helpers get_base64_from_account_hash / accountHashToBase64 * Move deploy processed mock in watcher and rename * Update build and doc * Clippy + build + doc
casper-ecosystem · Mar 5, 2024 · 9d6a836 · 9d6a836
1 parent 72b7e2b
commit 9d6a836
Show file tree

Hide file tree

Showing 481 changed files with 16,711 additions and 6,391 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -38,9 +38,12 @@ num-traits = "0.2"
 humantime = "2"
 thiserror = "1.0.50"
 base16 = "0.2.1"
+base64 = { version = "0.21.2", default-features = false, features = ["alloc"] }
 hex = { version = "0.4.3", default-features = false }
 rust_decimal = "1.10"
 blake2 = { version = "0.9.0", default-features = false }
+reqwest = { version = "0.11", default-features = false, features = ["stream"] }
+futures-util = "*"
 
 [lib]
 crate-type = ["cdylib", "rlib"]

diff --git a/Makefile b/Makefile
@@ -33,10 +33,25 @@ e2e-test:
 doc:
 	cargo doc --package casper-rust-wasm-sdk --no-deps
 	cp -r target/doc/* docs/api-rust/
-	cd examples/frontend/angular npm typedoc --out docs/api-wasm pkg/casper_rust_wasm_sdk.d.ts
+	npx typedoc --name api-wasm --out docs/api-wasm pkg/casper_rust_wasm_sdk.d.ts
 
 build: pack doc
 	cd examples/frontend/angular/ && npm run build && cd .
 	cd examples/frontend/react/ && npm run build && cd .
 	cd examples/desktop/node/ && npx tsc index.ts && cd .
 	cd examples/desktop/electron && npm run build && cd .
+
+format:
+	cargo fmt
+
+lint: format clippy
+
+clippy:
+	cargo clippy --target wasm32-unknown-unknown --bins -- -D warnings
+	cargo clippy --lib -- -D warnings
+	cargo clippy --no-default-features --lib -- -D warnings
+
+check-lint: clippy
+	cargo fmt -- --check
+
+.PHONY: format lint check clippy
diff --git a/docs/README.md b/docs/README.md
@@ -942,6 +942,147 @@ const signed_deploy = unsigned_deploy.sign(private_key);
 
 </details>
 
+<details>
+    <summary>Wait Deploy</summary>
+
+#### Rust
+
+Developers using Rust can utilize the wait_deploy function to wait for a specific deploy event. This is achieved by providing the desired event URL, deploy hash, and an optional timeout duration. Once the deploy is processed, the resulting data, such as the deploy's cost, can be easily accessed and utilized in subsequent logic.
+
+```rust
+pub const DEFAULT_EVENT_ADDRESS: &str = "http://127.0.0.1:18101/events/main";
+
+let deploy_hash = "c94ff7a9f86592681e69c1d8c2d7d2fed89fd1a922faa0ae74481f8458af2ee4";
+
+let timeout_duration = None; // Some(30000) for 30s instead of default timeout duration of 60s
+
+// Wait for deploy
+let event_parse_result = sdk
+    .wait_deploy(DEFAULT_EVENT_ADDRESS, &deploy_hash, timeout_duration)
+    .await
+    .unwrap();
+let deploy_processed = event_parse_result.body.unwrap().deploy_processed.unwrap();
+println!("{:?}", deploy_processed);
+```
+
+#### Typescript
+
+In TypeScript, the waitDeploy function provides a similar capability to wait for a specific deploy event. Developers can leverage this function by specifying the event address, deploy hash, and an optional timeout duration. The received EventParseResult object can then be processed to extract valuable information, such as the cost of the deploy.
+
+```ts
+const events_address = 'http://127.0.0.1:18101/events/main';
+
+const deploy_hash =
+  'c94ff7a9f86592681e69c1d8c2d7d2fed89fd1a922faa0ae74481f8458af2ee4';
+
+const timeout_duration = undefined; // 30000 for 30s instead of default timeout duration of 60s
+
+// Wait for deploy
+const eventParseResult: EventParseResult = await sdk.waitDeploy(
+  events_address,
+  install_result_as_json.deploy_hash,
+  timeout_duration
+);
+console.log(eventParseResult.body.DeployProcessed);
+const cost =
+  eventParseResult.body?.DeployProcessed?.execution_result.Success?.cost;
+console.log(`deploy cost ${cost}`);
+```
+
+</details>
+
+<details>
+    <summary>Watch Deploy</summary>
+
+#### Rust
+
+The watch_deploy functionality facilitates actively monitoring deploy events. By creating a deploy watcher, developers can subscribe to specific deploy hashes and define custom callback functions to handle these events. The watcher is then started, and as deploy events occur, the specified callback functions are executed. This mechanism enables real-time responsiveness to deploy events within Rust applications.
+
+```rust
+use casper_rust_wasm_sdk::deploy_watcher::watcher::{
+    DeploySubscription, EventHandlerFn,
+};
+
+pub const DEFAULT_EVENT_ADDRESS: &str = "http://127.0.0.1:18101/events/main";
+
+let deploy_hash = "c94ff7a9f86592681e69c1d8c2d7d2fed89fd1a922faa0ae74481f8458af2ee4";
+
+let timeout_duration = None; // Some(30000) for 30s instead of default timeout duration of 60s
+
+// Creates a watcher instance
+let mut watcher = sdk.watch_deploy(DEFAULT_EVENT_ADDRESS, timeout_duration);
+
+// Create a callback function handler of your design
+let event_handler_fn = get_event_handler_fn(deploy_hash.to_string());
+
+let mut deploy_subscriptions: Vec<DeploySubscription> = vec![];
+deploy_subscriptions.push(DeploySubscription::new(
+    deploy_hash.to_string(),
+    EventHandlerFn::new(event_handler_fn),
+));
+
+// Subscribe and start watching
+let _ = watcher.subscribe(deploy_subscriptions);
+let results = watcher.start().await;
+watcher.stop();
+println!("{:?}", results);
+```
+
+#### Typescript
+
+Similarly, TypeScript developers can utilize the watchDeploy function to actively watch for deploy events on the Casper blockchain. By creating a deploy watcher and defining callback functions, developers can subscribe to specific deploy hashes and respond dynamically as events unfold.
+
+```ts
+import { EventParseResult, DeploySubscription } from 'casper-sdk';
+
+const events_address = 'http://127.0.0.1:18101/events/main';
+
+const deploy_hash =
+  'c94ff7a9f86592681e69c1d8c2d7d2fed89fd1a922faa0ae74481f8458af2ee4';
+
+// Creates a watcher instance
+const watcher = sdk.watchDeploy(events_address);
+
+// Create a callback function handler of your design
+const getEventHandlerFn = (deployHash: string) => {
+  const eventHandlerFn = (eventParseResult: EventParseResult) => {
+    console.log(`callback for ${deployHash}`);
+    if (eventParseResult.err) {
+      return false;
+    } else if (
+      eventParseResult.body?.DeployProcessed?.execution_result.Success
+    ) {
+      console.log(
+        eventParseResult.body?.DeployProcessed?.execution_result.Success
+      );
+      return true;
+    } else {
+      console.error(
+        eventParseResult.body?.DeployProcessed?.execution_result.Failure
+      );
+      return false;
+    }
+  };
+  return eventHandlerFn;
+};
+
+const eventHandlerFn = getEventHandlerFn(deploy_hash);
+
+const deploySubscription: DeploySubscription = new DeploySubscription(
+  deploy_hash,
+  eventHandlerFn
+);
+const deploySubscriptions: DeploySubscription[] = [deploySubscription];
+
+// Subscribe and start watching
+watcher.subscribe(deploySubscriptions);
+const results = await watcher.start();
+watcher.stop();
+console.log(results);
+```
+
+</details>
+
 </details>
 
 <details>
@@ -1242,6 +1383,12 @@ You can download an alpha version of the app illustrating the SDK here:
 
 - [Deploy Type and static builder](https://casper-ecosystem.github.io/rustSDK/api-rust/casper_rust_wasm_sdk/types/deploy/struct.Deploy.html)
 
+### Deploy Watcher
+
+- [Deploy Watcher](https://casper-ecosystem.github.io/rustSDK/api-rust/casper_rust_wasm_sdk/deploy_watcher/index.html)
+- [DeploySubscription](https://casper-ecosystem.github.io/rustSDK/api-rust/casper_rust_wasm_sdk/deploy_watcher/struct.DeploySubscription.html)
+- [EventParseResult](https://casper-ecosystem.github.io/rustSDK/api-rust/casper_rust_wasm_sdk/deploy_watcher/struct.EventParseResult.html)
+
 ### Types
 
 - [Current exposed types](https://casper-ecosystem.github.io/rustSDK/api-rust/casper_rust_wasm_sdk/types/index.html)
@@ -1269,6 +1416,12 @@ You can download an alpha version of the app illustrating the SDK here:
 
 - [Deploy Type and static builder](https://casper-ecosystem.github.io/rustSDK/api-wasm/classes/Deploy.html)
 
+### Deploy Watcher
+
+- [Deploy Watcher](https://casper-ecosystem.github.io/rustSDK/api-wasm/classes/DeployWatcher.html)
+- [DeploySubscription](https://casper-ecosystem.github.io/rustSDK/api-wasm/classes/DeploySubscription.html)
+- [EventParseResult](https://casper-ecosystem.github.io/rustSDK/api-wasm/classes/EventParseResult.html)
+
 ### Types
 
 - [Current exposed types](https://casper-ecosystem.github.io/rustSDK/api-wasm/modules.html)
@@ -1317,5 +1470,4 @@ make test
 
 - Expose more CL Types and Casper Client result Types
 - EventStream
-- Keygen
 - Wallet connect