fix(multisig-protobufs): mark sender field as deprecated and add new …

…field with proper type (#2232)
axelarnetwork · Jan 30, 2025 · ef91531 · ef91531
1 parent ee4809d
commit ef91531
Show file tree

Hide file tree

Showing 7 changed files with 513 additions and 131 deletions.
diff --git a/client/docs/static/openapi/index.html b/client/docs/static/openapi/index.html
diff --git a/client/docs/static/openapi/openapi.yaml b/client/docs/static/openapi/openapi.yaml
@@ -4845,7 +4845,19 @@ paths:
                               "value": "1.212s"
                             }
       requestBody:
-        $ref: "#/components/requestBodies/CreateTransferOperatorshipBody"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                sender:
+                  type: string
+                  format: byte
+                chain:
+                  type: string
+                key_id:
+                  type: string
+        required: true
       tags:
         - MsgService
   /axelar/evm/link:
@@ -8914,7 +8926,27 @@ paths:
                               "value": "1.212s"
                             }
       requestBody:
-        $ref: "#/components/requestBodies/CreateTransferOperatorshipBody"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                sender_str:
+                  type: string
+                  description: >-
+                    Deprecated: This is the original "sender" field, but was
+                    originally declared as a string,
+
+                    rather than a byte array.
+                chain:
+                  type: string
+                key_id:
+                  type: string
+                sender:
+                  type: string
+                  format: byte
+                  title: New "sender" field, using the appropriate type
+        required: true
       tags:
         - MsgService
   /axelar/multisig/start_keygen:
@@ -9103,10 +9135,19 @@ paths:
             schema:
               type: object
               properties:
-                sender:
+                sender_str:
                   type: string
+                  description: >-
+                    Deprecated: This is the original "sender" field, but was
+                    originally declared as a string,
+
+                    rather than a byte array.
                 key_id:
                   type: string
+                sender:
+                  type: string
+                  format: byte
+                  title: New "sender" field, using the appropriate type
         required: true
       tags:
         - MsgService
@@ -9296,8 +9337,13 @@ paths:
             schema:
               type: object
               properties:
-                sender:
+                sender_str:
                   type: string
+                  description: >-
+                    Deprecated: This is the original "sender" field, but was
+                    originally declared as a string,
+
+                    rather than a byte array.
                 key_id:
                   type: string
                 pub_key:
@@ -9306,6 +9352,10 @@ paths:
                 signature:
                   type: string
                   format: byte
+                sender:
+                  type: string
+                  format: byte
+                  title: New "sender" field, using the appropriate type
         required: true
       tags:
         - MsgService
@@ -9495,14 +9545,23 @@ paths:
             schema:
               type: object
               properties:
-                sender:
+                sender_str:
                   type: string
+                  description: >-
+                    Deprecated: This is the original "sender" field, but was
+                    originally declared as a string,
+
+                    rather than a byte array.
                 sig_id:
                   type: string
                   format: uint64
                 signature:
                   type: string
                   format: byte
+                sender:
+                  type: string
+                  format: byte
+                  title: New "sender" field, using the appropriate type
         required: true
       tags:
         - MsgService
@@ -49372,20 +49431,6 @@ components:
                 type: string
                 format: byte
       required: true
-    CreateTransferOperatorshipBody:
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              sender:
-                type: string
-                format: byte
-              chain:
-                type: string
-              key_id:
-                type: string
-      required: true
   schemas:
     google.protobuf.Any:
       type: object
@@ -51423,29 +51468,51 @@ components:
     axelar.multisig.v1beta1.RotateKeyRequest:
       type: object
       properties:
-        sender:
+        sender_str:
           type: string
-          format: byte
+          description: >-
+            Deprecated: This is the original "sender" field, but was originally
+            declared as a string,
+
+            rather than a byte array.
         chain:
           type: string
         key_id:
           type: string
+        sender:
+          type: string
+          format: byte
+          title: New "sender" field, using the appropriate type
     axelar.multisig.v1beta1.RotateKeyResponse:
       type: object
     axelar.multisig.v1beta1.StartKeygenRequest:
       type: object
       properties:
-        sender:
+        sender_str:
           type: string
+          description: >-
+            Deprecated: This is the original "sender" field, but was originally
+            declared as a string,
+
+            rather than a byte array.
         key_id:
           type: string
+        sender:
+          type: string
+          format: byte
+          title: New "sender" field, using the appropriate type
     axelar.multisig.v1beta1.StartKeygenResponse:
       type: object
     axelar.multisig.v1beta1.SubmitPubKeyRequest:
       type: object
       properties:
-        sender:
+        sender_str:
           type: string
+          description: >-
+            Deprecated: This is the original "sender" field, but was originally
+            declared as a string,
+
+            rather than a byte array.
         key_id:
           type: string
         pub_key:
@@ -51454,19 +51521,32 @@ components:
         signature:
           type: string
           format: byte
+        sender:
+          type: string
+          format: byte
+          title: New "sender" field, using the appropriate type
     axelar.multisig.v1beta1.SubmitPubKeyResponse:
       type: object
     axelar.multisig.v1beta1.SubmitSignatureRequest:
       type: object
       properties:
-        sender:
+        sender_str:
           type: string
+          description: >-
+            Deprecated: This is the original "sender" field, but was originally
+            declared as a string,
+
+            rather than a byte array.
         sig_id:
           type: string
           format: uint64
         signature:
           type: string
           format: byte
+        sender:
+          type: string
+          format: byte
+          title: New "sender" field, using the appropriate type
     axelar.multisig.v1beta1.SubmitSignatureResponse:
       type: object
     axelar.nexus.exported.v1beta1.CrossChainAddress: