Merge pull request #2244 from oasisprotocol/lw/rofl-cleanup

ts-web/rt: cleanup rofl and roflmarket types

Author: lukaw3d

client-sdk/ts-web/rt/src/rofl.ts

@@ -42,44 +42,54 @@ export class Wrapper extends wrapper.Base {
         super(runtimeID);
     }
 
+    /** Create a new ROFL application. */
     callCreate() {
         return this.call<types.RoflCreate, void>(METHOD_CREATE);
     }
 
+    /** Update a ROFL application. */
     callUpdate() {
         return this.call<types.RoflUpdate, void>(METHOD_UPDATE);
     }
 
+    /** Remove a ROFL application. */
     callRemove() {
         return this.call<types.RoflRemove, void>(METHOD_REMOVE);
     }
 
+    /** Register a new ROFL App instance replica. */
     callRegister() {
         return this.call<types.RoflRegister, void>(METHOD_REGISTER);
     }
 
+    /** Returns the configuration for the given ROFL application. */
     queryApp() {
         return this.query<types.RoflAppQuery, types.RoflAppConfig>(METHOD_APP);
     }
 
+    /** Returns all ROFL app configurations. */
     queryApps() {
         return this.query<void, types.RoflAppConfig[]>(METHOD_APPS);
     }
 
+    /** Returns a specific registered instance replica for the given ROFL application. */
     queryAppInstance() {
         return this.query<types.RoflAppInstanceQuery, types.RoflRegistration>(METHOD_APP_INSTANCE);
     }
 
+    /** Returns a list of all registered instances replicas for the given ROFL application. */
     queryAppInstances() {
         return this.query<types.RoflAppQuery, types.RoflRegistration[]>(METHOD_APP_INSTANCES);
     }
 
+    /** Returns the minimum stake thresholds for managing ROFL. */
     queryStakeThresholds() {
         return this.query<void, types.RoflStakeThresholds>(METHOD_STAKE_THRESHOLDS);
     }
 
+    /** Queries the module parameters */
     queryParameters() {
-        return this.query<void, types.RoflParameters>(METHOD_PARAMETERS);
+        return this.query<void, void>(METHOD_PARAMETERS);
     }
 }
 

client-sdk/ts-web/rt/src/roflmarket.ts

@@ -45,76 +45,93 @@ export class Wrapper extends wrapper.Base {
         super(runtimeID);
     }
 
+    /** Creates a new machine provider. */
     callProviderCreate() {
         return this.call<types.RoflmarketProviderCreate, void>(METHOD_PROVIDER_CREATE);
     }
 
+    /** Updates an existing provider. */
     callProviderUpdate() {
         return this.call<types.RoflmarketProviderUpdate, void>(METHOD_PROVIDER_UPDATE);
     }
 
+    /** Updates offers for a provider. */
     callProviderUpdateOffers() {
         return this.call<types.RoflmarketProviderUpdateOffers, void>(METHOD_PROVIDER_UPDATE_OFFERS);
     }
 
+    /** Removes a provider. */
     callProviderRemove() {
         return this.call<types.RoflmarketProviderRemove, void>(METHOD_PROVIDER_REMOVE);
     }
 
+    /** Creates a new machine instance. */
     callInstanceCreate() {
         return this.call<types.RoflmarketInstanceCreate, void>(METHOD_INSTANCE_CREATE);
     }
 
+    /** Tops up a machine instance. */
     callInstanceTopUp() {
         return this.call<types.RoflmarketInstanceTopUp, void>(METHOD_INSTANCE_TOP_UP);
     }
 
+    /** Cancels a machine instance. */
     callInstanceCancel() {
         return this.call<types.RoflmarketInstanceCancel, void>(METHOD_INSTANCE_CANCEL);
     }
 
+    /** Executes commands on a machine instance. */
     callInstanceExecuteCmds() {
         return this.call<types.RoflmarketInstanceExecuteCmds, void>(METHOD_INSTANCE_EXECUTE_CMDS);
     }
 
+    /** Returns the provider descriptor. */
     queryProvider() {
         return this.query<types.RoflmarketProviderQuery, types.RoflmarketProvider>(METHOD_PROVIDER);
     }
 
+    /** Returns all provider descriptors. */
     queryProviders() {
         return this.query<void, types.RoflmarketProvider[]>(METHOD_PROVIDERS);
     }
 
+    /** Returns the specified offer. */
     queryOffer() {
         return this.query<types.RoflmarketOfferQuery, types.RoflmarketOffer>(METHOD_OFFER);
     }
 
+    /** Returns all offers of a given provider. */
     queryOffers() {
         return this.query<types.RoflmarketProviderQuery, types.RoflmarketOffer[]>(METHOD_OFFERS);
     }
 
+    /** Returns the machine instance descriptor. */
     queryInstance() {
         return this.query<types.RoflmarketInstanceQuery, types.RoflmarketInstance>(METHOD_INSTANCE);
     }
 
+    /** Returns all instances of a given provider. */
     queryInstances() {
         return this.query<types.RoflmarketProviderQuery, types.RoflmarketInstance[]>(
             METHOD_INSTANCES,
         );
     }
 
+    /** Returns all queued commands of a given machine instance. */
     queryInstanceCommands() {
         return this.query<types.RoflmarketInstanceQuery, types.RoflmarketQueuedCommand[]>(
             METHOD_INSTANCE_COMMANDS,
         );
     }
 
+    /** Returns the stake requirements. */
     queryStakeThresholds() {
         return this.query<void, types.RoflmarketStakeThresholds>(METHOD_STAKE_THRESHOLDS);
     }
 
+    /** Returns the module parameters. */
     queryParameters() {
-        return this.query<void, types.RoflmarketParameters>(METHOD_PARAMETERS);
+        return this.query<void, void>(METHOD_PARAMETERS);
     }
 }
 

client-sdk/ts-web/rt/src/types.ts

@@ -987,8 +987,6 @@ export interface RoflmarketStakeThresholds {
     provider_create: BaseUnits;
 }
 
-export interface RoflmarketParameters {}
-
 // Event types
 export interface RoflmarketProviderCreatedEvent {
     address: Uint8Array;
@@ -1034,33 +1032,10 @@ export interface RoflmarketInstanceCommandQueuedEvent {
 
 // Types for rofl module
 
-export interface RoflQuotePolicy {
-    ias?: {
-        disabled?: boolean;
-        allowed_quote_statuses?: number[];
-        gid_blacklist?: number[];
-        min_tcb_evaluation_data_number?: number;
-    };
-    pcs?: {
-        disabled?: boolean;
-        tcb_validity_period: number;
-        min_tcb_evaluation_data_number: number;
-        fmspc_blacklist?: string[];
-        tdx?: {
-            // TDX-specific policy fields
-        };
-    };
-}
-
-export interface RoflEnclaveIdentity {
-    mr_enclave: Uint8Array;
-    mr_signer: Uint8Array;
-}
-
 export interface RoflAllowedEndorsement {
-    any?: {};
-    role_compute?: {};
-    role_observer?: {};
+    any?: oasis.types.NotModeled;
+    role_compute?: oasis.types.NotModeled;
+    role_observer?: oasis.types.NotModeled;
     entity?: Uint8Array;
     node?: Uint8Array;
 }
@@ -1076,8 +1051,8 @@ export enum FeePolicy {
 }
 
 export interface RoflAppAuthPolicy {
-    quotes: RoflQuotePolicy;
-    enclaves: RoflEnclaveIdentity[];
+    quotes: oasis.types.SGXPolicy;
+    enclaves: oasis.types.SGXEnclaveIdentity[];
     endorsements: RoflAllowedEndorsement[];
     fees: FeePolicy;
     max_expiration: oasis.types.longnum;
@@ -1152,8 +1127,6 @@ export interface RoflRegistration {
     metadata?: {[key: string]: string};
 }
 
-export interface RoflParameters {}
-
 export interface RoflStakeThresholds {
     app_create?: BaseUnits;
 }