add params to disable script (#254)

client/docs/swagger-ui/swagger.yaml

@@ -49604,6 +49604,21 @@ paths:
                       applied
 
                       for Move execute messages.
+                  vesting:
+                    description: Vesting is the vesting contract info for tally.
+                    type: object
+                    properties:
+                      module_addr:
+                        type: string
+                        description: module_addr is the address of the vesting module.
+                      module_name:
+                        type: string
+                        description: module_name is the name of the vesting module.
+                      creator_addr:
+                        type: string
+                        description: >-
+                          creator_addr is the address of the creator of the
+                          vesting contract.
             description: >-
               QueryParamsResponse is the response type for the Query/Params RPC
               method.
@@ -51611,6 +51626,9 @@ paths:
                   contract_shared_revenue_ratio:
                     type: string
                     title: 'CSR: Percentage of fees distributed to developers'
+                  script_enabled:
+                    type: boolean
+                    title: flag whether to enable script execution
                   allowed_publishers:
                     type: array
                     items:
@@ -52888,6 +52906,12 @@ paths:
                           type: string
                           format: byte
                           description: Hash of the l2 output.
+                        l1_block_number:
+                          type: string
+                          format: uint64
+                          description: >-
+                            The l1 block number that the output root was
+                            submitted in.
                         l1_block_time:
                           type: string
                           format: date-time
@@ -53032,6 +53056,10 @@ paths:
                     type: string
                     format: byte
                     description: Hash of the l2 output.
+                  l1_block_number:
+                    type: string
+                    format: uint64
+                    description: The l1 block number that the output root was submitted in.
                   l1_block_time:
                     type: string
                     format: date-time
@@ -53150,6 +53178,12 @@ paths:
                           type: string
                           format: byte
                           description: Hash of the l2 output.
+                        l1_block_number:
+                          type: string
+                          format: uint64
+                          description: >-
+                            The l1 block number that the output root was
+                            submitted in.
                         l1_block_time:
                           type: string
                           format: date-time
@@ -53297,6 +53331,10 @@ paths:
                     type: string
                     format: byte
                     description: Hash of the l2 output.
+                  l1_block_number:
+                    type: string
+                    format: uint64
+                    description: The l1 block number that the output root was submitted in.
                   l1_block_time:
                     type: string
                     format: date-time
@@ -85581,6 +85619,21 @@ definitions:
           Low threshold functions for emergency and expedited proposal.
           These are Move function identifiers and can only be applied
           for Move execute messages.
+      vesting:
+        description: Vesting is the vesting contract info for tally.
+        type: object
+        properties:
+          module_addr:
+            type: string
+            description: module_addr is the address of the vesting module.
+          module_name:
+            type: string
+            description: module_name is the name of the vesting module.
+          creator_addr:
+            type: string
+            description: >-
+              creator_addr is the address of the creator of the vesting
+              contract.
     description: Params defines the parameters for the x/gov module.
   initia.gov.v1.Proposal:
     type: object
@@ -86338,6 +86391,21 @@ definitions:
               Low threshold functions for emergency and expedited proposal.
               These are Move function identifiers and can only be applied
               for Move execute messages.
+          vesting:
+            description: Vesting is the vesting contract info for tally.
+            type: object
+            properties:
+              module_addr:
+                type: string
+                description: module_addr is the address of the vesting module.
+              module_name:
+                type: string
+                description: module_name is the name of the vesting module.
+              creator_addr:
+                type: string
+                description: >-
+                  creator_addr is the address of the creator of the vesting
+                  contract.
     description: QueryParamsResponse is the response type for the Query/Params RPC method.
   initia.gov.v1.QueryProposalResponse:
     type: object
@@ -86956,6 +87024,21 @@ definitions:
     description: |-
       QueryProposalsResponse is the response type for the Query/Proposals RPC
       method.
+  initia.gov.v1.Vesting:
+    type: object
+    properties:
+      module_addr:
+        type: string
+        description: module_addr is the address of the vesting module.
+      module_name:
+        type: string
+        description: module_name is the name of the vesting module.
+      creator_addr:
+        type: string
+        description: creator_addr is the address of the creator of the vesting contract.
+    description: |-
+      Vesting defines the vesting contract info for MsgVestingVote.
+      At tally time, gov module would check vesting token amount.
   initia.move.v1.Module:
     type: object
     properties:
@@ -86996,6 +87079,9 @@ definitions:
       contract_shared_revenue_ratio:
         type: string
         title: 'CSR: Percentage of fees distributed to developers'
+      script_enabled:
+        type: boolean
+        title: flag whether to enable script execution
       allowed_publishers:
         type: array
         items:
@@ -87177,6 +87263,9 @@ definitions:
           contract_shared_revenue_ratio:
             type: string
             title: 'CSR: Percentage of fees distributed to developers'
+          script_enabled:
+            type: boolean
+            title: flag whether to enable script execution
           allowed_publishers:
             type: array
             items:
@@ -87788,6 +87877,10 @@ definitions:
             type: string
             format: byte
             description: Hash of the l2 output.
+          l1_block_number:
+            type: string
+            format: uint64
+            description: The l1 block number that the output root was submitted in.
           l1_block_time:
             type: string
             format: date-time
@@ -87852,6 +87945,10 @@ definitions:
         type: string
         format: byte
         description: Hash of the l2 output.
+      l1_block_number:
+        type: string
+        format: uint64
+        description: The l1 block number that the output root was submitted in.
       l1_block_time:
         type: string
         format: date-time
@@ -87910,6 +88007,10 @@ definitions:
                   type: string
                   format: byte
                   description: Hash of the l2 output.
+                l1_block_number:
+                  type: string
+                  format: uint64
+                  description: The l1 block number that the output root was submitted in.
                 l1_block_time:
                   type: string
                   format: date-time
@@ -88098,6 +88199,10 @@ definitions:
             type: string
             format: byte
             description: Hash of the l2 output.
+          l1_block_number:
+            type: string
+            format: uint64
+            description: The l1 block number that the output root was submitted in.
           l1_block_time:
             type: string
             format: date-time
@@ -88135,6 +88240,10 @@ definitions:
             type: string
             format: byte
             description: Hash of the l2 output.
+          l1_block_number:
+            type: string
+            format: uint64
+            description: The l1 block number that the output root was submitted in.
           l1_block_time:
             type: string
             format: date-time
@@ -88168,6 +88277,10 @@ definitions:
                   type: string
                   format: byte
                   description: Hash of the l2 output.
+                l1_block_number:
+                  type: string
+                  format: uint64
+                  description: The l1 block number that the output root was submitted in.
                 l1_block_time:
                   type: string
                   format: date-time

proto/initia/move/v1/types.proto

@@ -30,9 +30,12 @@ message Params {
     (amino.dont_omitempty) = true
   ];
 
+  // flag whether to enable script execution
+  bool script_enabled = 4;
+
   // It is a list of addresses with permission to distribute contracts,
   // and an empty list is interpreted as allowing anyone to distribute.
-  repeated string allowed_publishers = 4
+  repeated string allowed_publishers = 5
       [(gogoproto.moretags) = "yaml:\"allowed_publishers\"", (amino.dont_omitempty) = true];
 }
 
@@ -53,6 +56,9 @@ message RawParams {
     (gogoproto.nullable)   = false,
     (amino.dont_omitempty) = true
   ];
+
+  // flag whether to enable script execution
+  bool script_enabled = 4;
 }
 
 // Module is data for the uploaded contract move code

x/move/keeper/msg_server.go

@@ -137,9 +137,15 @@ func (ms MsgServer) ExecuteJSON(context context.Context, req *types.MsgExecuteJS
 }
 
 // Script implements script execution
-func (ms MsgServer) Script(context context.Context, req *types.MsgScript) (*types.MsgScriptResponse, error) {
+func (ms MsgServer) Script(ctx context.Context, req *types.MsgScript) (*types.MsgScriptResponse, error) {
+	if ok, err := ms.ScriptEnabled(ctx); err != nil {
+		return nil, err
+	} else if !ok {
+		return nil, errors.Wrap(types.ErrScriptDisabled, "script execution is disabled")
+	}
+
 	defer telemetry.MeasureSince(time.Now(), "move", "msg", "script")
-	ctx := sdk.UnwrapSDKContext(context)
+
 	if err := req.Validate(ms.ac); err != nil {
 		return nil, err
 	}

x/move/keeper/msg_server_test.go

@@ -66,6 +66,21 @@ func TestScriptMsg(t *testing.T) {
 	require.NoError(t, err)
 }
 
+func Test_ScriptDisabled(t *testing.T) {
+	ctx, input := createDefaultTestInput(t)
+
+	params, err := input.MoveKeeper.GetParams(ctx)
+	require.NoError(t, err)
+
+	params.ScriptEnabled = false
+	err = input.MoveKeeper.SetParams(ctx, params)
+	require.NoError(t, err)
+
+	msgServer := keeper.NewMsgServerImpl(&input.MoveKeeper)
+	_, err = msgServer.Script(ctx, nil)
+	require.ErrorIs(t, err, types.ErrScriptDisabled)
+}
+
 func Test_ExecuteMsg(t *testing.T) {
 	ctx, input := createDefaultTestInput(t)
 	ms := keeper.NewMsgServerImpl(&input.MoveKeeper)

x/move/keeper/params.go

@@ -48,6 +48,16 @@ func (k Keeper) ContractSharedRevenueRatio(ctx context.Context) (math.LegacyDec,
 	return params.ContractSharedRevenueRatio, nil
 }
 
+// ScriptEnabled - script execution enabled
+func (k Keeper) ScriptEnabled(ctx context.Context) (bool, error) {
+	params, err := k.GetParams(ctx)
+	if err != nil {
+		return false, err
+	}
+
+	return params.ScriptEnabled, nil
+}
+
 // SetParams sets the x/move module parameters.
 func (k Keeper) SetParams(ctx context.Context, params types.Params) error {
 	if err := k.SetRawParams(ctx, params.ToRaw()); err != nil {

x/move/types/errors.go

@@ -47,4 +47,7 @@ var (
 
 	// ErrAddressAlreadyTaken error raised when the address is already taken
 	ErrAddressAlreadyTaken = errorsmod.Register(ModuleName, 15, "address already taken")
+
+	// ErrScriptDisabled error raised when the script execution is disabled
+	ErrScriptDisabled = errorsmod.Register(ModuleName, 16, "script execution disabled")
 )

x/move/types/params.go

@@ -14,7 +14,8 @@ import (
 
 // Default parameter values
 const (
-	DefaultBaseDenom = "uinit"
+	DefaultBaseDenom     = "uinit"
+	DefaultScriptEnabled = true
 )
 
 var (
@@ -35,6 +36,7 @@ func DefaultParams() Params {
 		BaseDenom:                  DefaultBaseDenom,
 		BaseMinGasPrice:            DefaultBaseMinGasPrice,
 		ContractSharedRevenueRatio: DefaultContractSharedRevenueRatio,
+		ScriptEnabled:              DefaultScriptEnabled,
 		AllowedPublishers:          nil,
 	}
 }
@@ -74,6 +76,7 @@ func (p Params) ToRaw() RawParams {
 		BaseDenom:                  p.BaseDenom,
 		BaseMinGasPrice:            p.BaseMinGasPrice,
 		ContractSharedRevenueRatio: p.ContractSharedRevenueRatio,
+		ScriptEnabled:              p.ScriptEnabled,
 	}
 }
 
@@ -84,6 +87,7 @@ func (p RawParams) ToParams(allowedPublishers []string) Params {
 		BaseMinGasPrice:            p.BaseMinGasPrice,
 		ContractSharedRevenueRatio: p.ContractSharedRevenueRatio,
 		AllowedPublishers:          allowedPublishers,
+		ScriptEnabled:              p.ScriptEnabled,
 	}
 }