feat(dfx-orbit): dfx-orbit version 0.4

.release.json

@@ -179,7 +179,7 @@
       "newVersion": null
     },
     "dfx-orbit": {
-      "currentVersion": "0.3.0",
+      "currentVersion": "0.4.0",
       "dependentProjects": [
         {
           "source": "integration-tests",

tests/integration/Cargo.toml

@@ -7,7 +7,7 @@ edition = '2021'
 [dependencies]
 candid = { workspace = true }
 candid_parser = { workspace = true }
-dfx-orbit = { path = '../../tools/dfx-orbit', version = '0.3.0' }
+dfx-orbit = { path = '../../tools/dfx-orbit', version = '0.4.0' }
 flate2 = { workspace = true }
 hex = { workspace = true }
 orbit-essentials = { path = '../../libs/orbit-essentials', version = '0.0.2-alpha.4' }

tests/integration/src/dfx_orbit.rs

@@ -199,7 +199,9 @@ async fn setup_dfx_orbit(station_id: Principal) -> DfxOrbit {
         network: String::from("test"),
         url: format!("http://localhost:{}", port),
     };
-    DfxOrbit::new(orbit_agent, config, logger).await.unwrap()
+    DfxOrbit::new(orbit_agent, config, None, logger)
+        .await
+        .unwrap()
 }
 
 /// Create the dfx user's identities and add them to the station

tests/integration/src/dfx_orbit/assets.rs

@@ -8,11 +8,12 @@ use crate::{
     utils::execute_request,
     CanisterIds, TestEnv,
 };
+use dfx_orbit::DfxOrbit;
 use pocket_ic::PocketIc;
 use rand::{thread_rng, Rng};
 use station_api::{
-    AddRequestPolicyOperationInput, CallExternalCanisterResourceTargetDTO,
-    ExecutionMethodResourceTargetDTO, RequestOperationInput, RequestPolicyRuleDTO,
+    AddRequestPolicyOperationInput, CallExternalCanisterResourceTargetDTO, CreateRequestInput,
+    ExecutionMethodResourceTargetDTO, GetRequestInput, RequestOperationInput, RequestPolicyRuleDTO,
     RequestSpecifierDTO, ValidationMethodResourceTargetDTO,
 };
 use std::{
@@ -30,7 +31,7 @@ fn assets_upload() {
         ..
     } = setup_new_env();
 
-    let (_dfx_principal, _dfx_user) = setup_dfx_user(&env, &canister_ids);
+    let (dfx_principal, _dfx_user) = setup_dfx_user(&env, &canister_ids);
 
     // Install the assets canister under orbit control
     let asset_canister = create_canister(&mut env, canister_ids.station);
@@ -83,9 +84,17 @@ fn assets_upload() {
 
         // As dfx user: Request to have Prepare permission for asset_canister
         let _response = dfx_orbit
-            .request_prepare_permission(asset_canister, None, None)
+            .station
+            .request(CreateRequestInput {
+                operation: DfxOrbit::grant_permission_request(asset_canister, dfx_principal)
+                    .unwrap(),
+                title: None,
+                summary: None,
+                execution_plan: None,
+            })
             .await
             .unwrap();
+
         tokio::time::sleep(Duration::from_secs(1)).await;
 
         // Test that we can retreive the sources from `dfx.json`
@@ -100,27 +109,33 @@ fn assets_upload() {
             .upload(asset_canister, &sources_path, false)
             .await
             .unwrap();
+
         let response = dfx_orbit
-            .request_commit_batch(
-                asset_canister,
-                batch_id.clone(),
-                evidence.clone(),
-                None,
-                None,
-            )
+            .station
+            .request(CreateRequestInput {
+                operation: DfxOrbit::commit_batch_input(
+                    asset_canister,
+                    batch_id.clone(),
+                    evidence.clone(),
+                )
+                .unwrap(),
+                title: None,
+                summary: None,
+                execution_plan: None,
+            })
             .await
             .unwrap();
 
         // Check whether the request passes the asset check
-        dfx_orbit
-            .check_evidence(
-                asset_canister,
-                response.request.id,
-                batch_id,
-                hex::encode(evidence),
-            )
+        let response = dfx_orbit
+            .station
+            .review_id(GetRequestInput {
+                request_id: response.request.id,
+            })
             .await
             .unwrap();
+        DfxOrbit::check_evidence(&response, asset_canister, batch_id, hex::encode(evidence))
+            .unwrap();
 
         // NOTE: We need to wait until the certified state becomes available.
         // Since we are in live mode, we can not simply advance pocketIC by some

tests/integration/src/dfx_orbit/review.rs

@@ -3,8 +3,8 @@ use pocket_ic::PocketIc;
 use station_api::{
     AuthScopeDTO, CallExternalCanisterOperationInput, CanisterMethodDTO,
     EditPermissionOperationInput, GetNextApprovableRequestInput, GetRequestInput,
-    ListRequestsInput, ListRequestsOperationTypeDTO, RequestApprovalStatusDTO,
-    RequestOperationInput, RequestResourceActionDTO, ResourceDTO, SubmitRequestApprovalInput,
+    ListRequestsInput, ListRequestsOperationTypeDTO, RequestOperationInput,
+    RequestResourceActionDTO, ResourceDTO,
 };
 
 use crate::{
@@ -123,13 +123,9 @@ fn review() {
         assert_eq!(next_request.request.id, id_request.request.id);
 
         // Approve the request
-        let _response = dfx_orbit
+        dfx_orbit
             .station
-            .submit(SubmitRequestApprovalInput {
-                decision: RequestApprovalStatusDTO::Approved,
-                request_id: submitted_request.id,
-                reason: None,
-            })
+            .approve(submitted_request.id, None)
             .await
             .unwrap();
     });

tools/dfx-orbit/Cargo.toml

@@ -1,7 +1,7 @@
 
 [package]
 name = 'dfx-orbit'
-version = '0.3.0'
+version = '0.4.0'
 description = 'Command line tool for interacting with the Orbit digital asset manager on the ICP blockchain.'
 authors.workspace = true
 edition.workspace = true

tools/dfx-orbit/README.md

@@ -65,7 +65,7 @@ Tell the command line tool where to find the orbit station:
 - Copy the wallet ID
 - Store the station details locally. If your wallet is called `shiny` and is running locally, the command is:
   ```
-  dfx-orbit station add shiny --station-id "$WALLET_ID" --network local --url https://orbitwallet.io
+  dfx-orbit station add shiny --station-id "$WALLET_ID" --network ic
   ```
 - Verify that the station is in your list of stations:
   ```
@@ -104,15 +104,6 @@ Initially you are likely to have only permission to see your own profile:
 ]
 ```
 
-Without permission to make and view requests, you will not be able to do much. It is recommended to make a `Developer` group with the following permissions:
-
-| Name in UI   | Privilege in `dfx-orbit me` | Name in error messages | Used for                         |
-| ------------ | --------------------------- | ---------------------- | -------------------------------- |
-| Request/List | `ListRequests`              | `Request(List)`        | `dfx-orbit review list`          |
-| Request/Read | Not Shown                   | `Request(Read(Id))`    | `dfx-orbit review id REQUEST_ID` |
-
-TODO: It would be nice to be able to link directly to a permission. E.g. this could open the permissions page and focus on one specific permission: https://orbitwallet.io/en/settings/user-groups/permissions#Request/List
-
 ## Make canister calls with Orbit
 
 Instead of using `dfx canister call CANISTER METHOD ARGUMENTS` use `dfx-orbit request canister call CANISTER METHOD ARGUMENTS`.
@@ -180,7 +171,7 @@ If not, please transfer the control of the canister to the orbit station.
 Note: Uploaded assets are not published. They are only prepared for release.
 
 ```
-dfx-orbit asset request-prepare-permission frontend
+dfx-orbit request asset prepare-permission frontend
 ```
 
 In case you want to verify, whether you have the `Prepare` permission on the asset canister,
@@ -202,7 +193,7 @@ dfx identity get-principal
 A developer may upload one or more directories of HTTP assets with:
 
 ```
-dfx-orbit asset upload CANISTER_NAME SOME_DIR/ OTHER_DIR/
+dfx-orbit request asset upload CANISTER_NAME SOME_DIR/ OTHER_DIR/
 ```
 
 This will upload the assets to the asset canister and then request the orbit station to publish
@@ -213,12 +204,9 @@ the assets.
 After the request has been made, the reviewers can locally verify the request:
 
 ```
-dfx-orbit asset check --then-approve CANISTER REQUEST_ID BATCH_ID SOME_DIR/ OTHER_DIR/
+dfx-orbit verify asset upload CANISTER REQUEST_ID BATCH_ID SOME_DIR/ OTHER_DIR/
 ```
 
-The exact command is printed in the output of `dfx-orbit asset upload` and must be distributed
-from the proposer to the verifiers.
-
 > The verifiers needs to have the same set of data as was used in the request.
 > How the verifier accomplishes this is outside the scope of this document.
 >

tools/dfx-orbit/src/args.rs

@@ -1,19 +1,18 @@
 //! Command line interface for `dfx-orbit`.
-pub mod asset;
 pub mod request;
 pub mod review;
 pub mod station;
+pub mod verify;
 
-use asset::AssetArgs;
 use clap::{Parser, Subcommand};
 use request::RequestArgs;
 use review::ReviewArgs;
 use station::StationArgs;
+use verify::VerifyArgs;
 
 /// Manages Orbit on the Internet Computer.
-// TODO: Better version information
 #[derive(Parser, Debug)]
-#[clap(version, about, long_about = None)]
+#[clap(version, about)]
 pub struct DfxOrbitArgs {
     /// Increase verbosity level
     #[clap(short, long, action = clap::ArgAction::Count, conflicts_with = "quiet")]
@@ -27,6 +26,11 @@ pub struct DfxOrbitArgs {
     #[clap(short, long)]
     pub(crate) station: Option<String>,
 
+    // TODO: Allow to specify --network, to overwrite the network specified by the station
+    /// The user identity to run this command as
+    #[clap(short, long)]
+    pub(crate) identity: Option<String>,
+
     /// Manage Orbit stations.
     #[clap(subcommand)]
     pub(crate) command: DfxOrbitSubcommands,
@@ -41,10 +45,17 @@ pub enum DfxOrbitSubcommands {
     Station(StationArgs),
     /// Make requests to Orbit
     Request(RequestArgs),
+    /// Verify requests
+    Verify(VerifyArgs),
     /// View and decide on requests.
     Review(ReviewArgs),
-    /// Manage assets stored in an asset canister through Orbit
-    Asset(AssetArgs),
     /// Gets the caller's profile on an Orbit station.
-    Me,
+    Me(MeArgs),
+}
+
+#[derive(Debug, Clone, Parser)]
+pub struct MeArgs {
+    /// Return output as JSON
+    #[clap(short, long)]
+    pub(crate) json: bool,
 }