@phala/cloud 0.2.0 → 0.2.1-beta.2

package/dist/actions/cvms/commit_cvm_provision.d.ts

@@ -4,7 +4,19 @@ import { type Client } from "../../client";
  * Commit CVM Provision (Create CVM from provisioned data)
  *
  * This action creates a CVM using previously provisioned data and encrypted environment variables.
- * It should be called after `provisionCvm` to complete the CVM deployment process.
+ * It MUST be called after `provisionCvm` to complete the CVM deployment process.
+ *
+ * ## Two-Step Deployment Flow
+ *
+ * 1. **Provision** (`provisionCvm`): Prepares resources and returns `compose_hash` (and `app_id` for PHALA KMS)
+ * 2. **Commit** (this function): Creates the actual CVM using provisioned data
+ *
+ * ## KMS Type and app_id Source
+ *
+ * The `app_id` source depends on the KMS type used during provisioning:
+ *
+ * - **PHALA KMS** (default): `app_id` is obtained from centralized KMS - returned by `provisionCvm()`
+ * - **ETHEREUM/BASE KMS** (on-chain): `app_id` must be obtained by deploying your contract and interacting with the on-chain KMS - NOT provided by `provisionCvm()`
  *
  * @example
  * ```typescript
@@ -12,20 +24,43 @@ import { type Client } from "../../client";
  *
  * const client = createClient();
  *
- * // First, provision the CVM
- * const provision = await provisionCvm(client, appCompose);
+ * // Example 1: PHALA KMS (default - app_id from provision)
+ * const provision = await provisionCvm(client, {
+ *   name: "my-cvm",
+ *   instance_type: "tdx.small",
+ *   kms: "PHALA",  // or omit for default
+ *   compose_file: { docker_compose_file: "..." },
+ * });
  *
- * // Then, commit the provision with encrypted environment variables
+ * // app_id is provided by provision API
  * const cvm = await commitCvmProvision(client, {
- *   encrypted_env: "hex-encoded-encrypted-environment-data", // String, not array
- *   app_id: provision.app_id,
+ *   app_id: provision.app_id,           // From provision response
  *   compose_hash: provision.compose_hash,
- *   kms_id: "your-kms-id",
- *   contract_address: "0x123...",
- *   deployer_address: "0x456..."
+ *   encrypted_env: "...",
+ * });
+ *
+ * // Example 2: On-chain KMS (app_id from contract deployment)
+ * const provision = await provisionCvm(client, {
+ *   name: "my-cvm",
+ *   instance_type: "tdx.small",
+ *   kms: "ETHEREUM",  // or "BASE" for Base network
+ *   compose_file: { docker_compose_file: "..." },
  * });
  *
- * console.log(cvm.id);
+ * // Step 1: Deploy your contract and get app_id from on-chain KMS
+ * const contractTx = await deployContract({
+ *   kmsContract: "0x...",
+ *   // ... contract deployment params
+ * });
+ * const appId = await getAppIdFromKms(contractTx);
+ *
+ * // Step 2: Commit with app_id from on-chain interaction
+ * const cvm = await commitCvmProvision(client, {
+ *   app_id: appId,                        // From on-chain KMS, NOT from provision
+ *   compose_hash: provision.compose_hash, // From provision response
+ *   contract_address: "0x123...",         // Your deployed contract
+ *   deployer_address: "0x456...",         // Deployer address
+ * });
  * ```
  *
  * ## Returns
@@ -34,9 +69,22 @@ import { type Client } from "../../client";
  *
  * The created CVM details including id, name, status, and other metadata. Return type depends on schema parameter.
  *
- * ## Parameters
+ * ## Required Parameters
+ *
+ * - **app_id**: Application identifier
+ *   - For PHALA KMS: Use `provision.app_id` from `provisionCvm()` response
+ *   - For ETHEREUM/BASE KMS (on-chain): Obtain from your on-chain KMS contract deployment
+ * - **compose_hash**: Must be obtained from `provisionCvm()` response (used to retrieve provision data from Redis)
+ *
+ * ## Optional Parameters
+ *
+ * - **encrypted_env**: Hex-encoded encrypted environment variables
+ * - **env_keys**: List of environment variable keys to allow
+ * - **kms_id**: KMS instance identifier (if using specific KMS)
+ * - **contract_address**: On-chain KMS contract address (required for ETHEREUM/BASE KMS)
+ * - **deployer_address**: Deployer address for on-chain verification (required for ETHEREUM/BASE KMS)
  *
- * ### schema (optional)
+ * ## Schema Parameter
  *
  * - **Type:** `ZodSchema | false`
  * - **Default:** `CommitCvmProvisionSchema`
@@ -178,7 +226,7 @@ export type CommitCvmProvision = z.infer<typeof CommitCvmProvisionSchema>;
 export declare const CommitCvmProvisionRequestSchema: z.ZodObject<{
     encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     app_id: z.ZodString;
-    compose_hash: z.ZodOptional<z.ZodString>;
+    compose_hash: z.ZodString;
     kms_id: z.ZodOptional<z.ZodString>;
     contract_address: z.ZodOptional<z.ZodString>;
     deployer_address: z.ZodOptional<z.ZodString>;
@@ -186,7 +234,7 @@ export declare const CommitCvmProvisionRequestSchema: z.ZodObject<{
 }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
     encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     app_id: z.ZodString;
-    compose_hash: z.ZodOptional<z.ZodString>;
+    compose_hash: z.ZodString;
     kms_id: z.ZodOptional<z.ZodString>;
     contract_address: z.ZodOptional<z.ZodString>;
     deployer_address: z.ZodOptional<z.ZodString>;
@@ -194,7 +242,7 @@ export declare const CommitCvmProvisionRequestSchema: z.ZodObject<{
 }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
     encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     app_id: z.ZodString;
-    compose_hash: z.ZodOptional<z.ZodString>;
+    compose_hash: z.ZodString;
     kms_id: z.ZodOptional<z.ZodString>;
     contract_address: z.ZodOptional<z.ZodString>;
     deployer_address: z.ZodOptional<z.ZodString>;
@@ -205,7 +253,7 @@ declare const commitCvmProvision: {
     (client: Client, params: z.objectOutputType<{
         encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         app_id: z.ZodString;
-        compose_hash: z.ZodOptional<z.ZodString>;
+        compose_hash: z.ZodString;
         kms_id: z.ZodOptional<z.ZodString>;
         contract_address: z.ZodOptional<z.ZodString>;
         deployer_address: z.ZodOptional<z.ZodString>;
@@ -247,7 +295,7 @@ declare const commitCvmProvision: {
     <T extends z.ZodTypeAny>(client: Client, params: z.objectOutputType<{
         encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         app_id: z.ZodString;
-        compose_hash: z.ZodOptional<z.ZodString>;
+        compose_hash: z.ZodString;
         kms_id: z.ZodOptional<z.ZodString>;
         contract_address: z.ZodOptional<z.ZodString>;
         deployer_address: z.ZodOptional<z.ZodString>;
@@ -258,7 +306,7 @@ declare const commitCvmProvision: {
     (client: Client, params: z.objectOutputType<{
         encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         app_id: z.ZodString;
-        compose_hash: z.ZodOptional<z.ZodString>;
+        compose_hash: z.ZodString;
         kms_id: z.ZodOptional<z.ZodString>;
         contract_address: z.ZodOptional<z.ZodString>;
         deployer_address: z.ZodOptional<z.ZodString>;
@@ -270,7 +318,7 @@ declare const commitCvmProvision: {
     (client: Client, params: z.objectOutputType<{
         encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         app_id: z.ZodString;
-        compose_hash: z.ZodOptional<z.ZodString>;
+        compose_hash: z.ZodString;
         kms_id: z.ZodOptional<z.ZodString>;
         contract_address: z.ZodOptional<z.ZodString>;
         deployer_address: z.ZodOptional<z.ZodString>;
@@ -312,7 +360,7 @@ declare const commitCvmProvision: {
     <T extends z.ZodTypeAny>(client: Client, params: z.objectOutputType<{
         encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         app_id: z.ZodString;
-        compose_hash: z.ZodOptional<z.ZodString>;
+        compose_hash: z.ZodString;
         kms_id: z.ZodOptional<z.ZodString>;
         contract_address: z.ZodOptional<z.ZodString>;
         deployer_address: z.ZodOptional<z.ZodString>;
@@ -323,7 +371,7 @@ declare const commitCvmProvision: {
     (client: Client, params: z.objectOutputType<{
         encrypted_env: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         app_id: z.ZodString;
-        compose_hash: z.ZodOptional<z.ZodString>;
+        compose_hash: z.ZodString;
         kms_id: z.ZodOptional<z.ZodString>;
         contract_address: z.ZodOptional<z.ZodString>;
         deployer_address: z.ZodOptional<z.ZodString>;

package/dist/actions/cvms/get_cvm_list.d.ts

@@ -8,15 +8,15 @@ export declare const GetCvmListRequestSchema: z.ZodObject<{
     user_id: z.ZodOptional<z.ZodString>;
 }, "strict", z.ZodTypeAny, {
     teepod_id?: number | undefined;
+    user_id?: string | undefined;
     page?: number | undefined;
     page_size?: number | undefined;
-    user_id?: string | undefined;
     node_id?: number | undefined;
 }, {
     teepod_id?: number | undefined;
+    user_id?: string | undefined;
     page?: number | undefined;
     page_size?: number | undefined;
-    user_id?: string | undefined;
     node_id?: number | undefined;
 }>;
 export declare const GetCvmListSchema: z.ZodObject<{
@@ -262,8 +262,6 @@ export declare const GetCvmListSchema: z.ZodObject<{
     page_size: z.ZodNumber;
     pages: z.ZodNumber;
 }, "strict", z.ZodTypeAny, {
-    page: number;
-    page_size: number;
     items: {
         status: string;
         name: string;
@@ -318,10 +316,10 @@ export declare const GetCvmListSchema: z.ZodObject<{
         }[];
     }[];
     total: number;
-    pages: number;
-}, {
     page: number;
     page_size: number;
+    pages: number;
+}, {
     items: {
         status: string;
         name: string;
@@ -376,6 +374,8 @@ export declare const GetCvmListSchema: z.ZodObject<{
         allow_upgrade?: boolean | undefined;
     }[];
     total: number;
+    page: number;
+    page_size: number;
     pages: number;
 }>;
 export type GetCvmListRequest = z.infer<typeof GetCvmListRequestSchema>;
@@ -405,13 +405,11 @@ export type GetCvmListResponse = z.infer<typeof GetCvmListSchema>;
 declare const getCvmList: {
     (client: Client, params?: {
         teepod_id?: number | undefined;
+        user_id?: string | undefined;
         page?: number | undefined;
         page_size?: number | undefined;
-        user_id?: string | undefined;
         node_id?: number | undefined;
     } | undefined): Promise<{
-        page: number;
-        page_size: number;
         items: {
             status: string;
             name: string;
@@ -466,22 +464,24 @@ declare const getCvmList: {
             }[];
         }[];
         total: number;
+        page: number;
+        page_size: number;
         pages: number;
     }>;
     <T extends z.ZodTypeAny>(client: Client, params?: {
         teepod_id?: number | undefined;
+        user_id?: string | undefined;
         page?: number | undefined;
         page_size?: number | undefined;
-        user_id?: string | undefined;
         node_id?: number | undefined;
     } | undefined, parameters?: {
         schema: T;
     } | undefined): Promise<z.TypeOf<T>>;
     (client: Client, params?: {
         teepod_id?: number | undefined;
+        user_id?: string | undefined;
         page?: number | undefined;
         page_size?: number | undefined;
-        user_id?: string | undefined;
         node_id?: number | undefined;
     } | undefined, parameters?: {
         schema: false;
@@ -489,13 +489,11 @@ declare const getCvmList: {
 }, safeGetCvmList: {
     (client: Client, params?: {
         teepod_id?: number | undefined;
+        user_id?: string | undefined;
         page?: number | undefined;
         page_size?: number | undefined;
-        user_id?: string | undefined;
         node_id?: number | undefined;
     } | undefined): Promise<import("../..").SafeResult<{
-        page: number;
-        page_size: number;
         items: {
             status: string;
             name: string;
@@ -550,22 +548,24 @@ declare const getCvmList: {
             }[];
         }[];
         total: number;
+        page: number;
+        page_size: number;
         pages: number;
     }>>;
     <T extends z.ZodTypeAny>(client: Client, params?: {
         teepod_id?: number | undefined;
+        user_id?: string | undefined;
         page?: number | undefined;
         page_size?: number | undefined;
-        user_id?: string | undefined;
         node_id?: number | undefined;
     } | undefined, parameters?: {
         schema: T;
     } | undefined): Promise<import("../..").SafeResult<z.TypeOf<T>>>;
     (client: Client, params?: {
         teepod_id?: number | undefined;
+        user_id?: string | undefined;
         page?: number | undefined;
         page_size?: number | undefined;
-        user_id?: string | undefined;
         node_id?: number | undefined;
     } | undefined, parameters?: {
         schema: false;

package/dist/actions/cvms/get_cvm_state.d.ts

@@ -5,23 +5,35 @@ import { type CvmIdInput } from "../../types/cvm_id";
  * CVM state response schema
  */
 export declare const CvmStateSchema: z.ZodObject<{
-    status: z.ZodString;
-    derived_status: z.ZodOptional<z.ZodString>;
-    vm_uuid: z.ZodOptional<z.ZodString>;
+    id: z.ZodOptional<z.ZodString>;
     instance_id: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    status: z.ZodString;
     uptime: z.ZodOptional<z.ZodString>;
+    exited_at: z.ZodOptional<z.ZodString>;
+    boot_progress: z.ZodOptional<z.ZodString>;
+    boot_error: z.ZodOptional<z.ZodString>;
+    shutdown_progress: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     status: string;
+    name: string;
+    id?: string | undefined;
     uptime?: string | undefined;
     instance_id?: string | undefined;
-    vm_uuid?: string | undefined;
-    derived_status?: string | undefined;
+    exited_at?: string | undefined;
+    boot_progress?: string | undefined;
+    boot_error?: string | undefined;
+    shutdown_progress?: string | undefined;
 }, {
     status: string;
+    name: string;
+    id?: string | undefined;
     uptime?: string | undefined;
     instance_id?: string | undefined;
-    vm_uuid?: string | undefined;
-    derived_status?: string | undefined;
+    exited_at?: string | undefined;
+    boot_progress?: string | undefined;
+    boot_error?: string | undefined;
+    shutdown_progress?: string | undefined;
 }>;
 export type CvmState = z.infer<typeof CvmStateSchema>;
 export declare const GetCvmStateRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
@@ -64,10 +76,14 @@ export type GetCvmStateRequest = CvmIdInput;
 declare const getCvmState: {
     (client: Client, params: CvmIdInput): Promise<{
         status: string;
+        name: string;
+        id?: string | undefined;
         uptime?: string | undefined;
         instance_id?: string | undefined;
-        vm_uuid?: string | undefined;
-        derived_status?: string | undefined;
+        exited_at?: string | undefined;
+        boot_progress?: string | undefined;
+        boot_error?: string | undefined;
+        shutdown_progress?: string | undefined;
     }>;
     <T extends z.ZodTypeAny>(client: Client, params: CvmIdInput, parameters: {
         schema: T;
@@ -78,10 +94,14 @@ declare const getCvmState: {
 }, safeGetCvmState: {
     (client: Client, params: CvmIdInput): Promise<import("../..").SafeResult<{
         status: string;
+        name: string;
+        id?: string | undefined;
         uptime?: string | undefined;
         instance_id?: string | undefined;
-        vm_uuid?: string | undefined;
-        derived_status?: string | undefined;
+        exited_at?: string | undefined;
+        boot_progress?: string | undefined;
+        boot_error?: string | undefined;
+        shutdown_progress?: string | undefined;
     }>>;
     <T extends z.ZodTypeAny>(client: Client, params: CvmIdInput, parameters: {
         schema: T;