Update schema

babylonlabs-io · Feb 4, 2025 · fbd3b31 · fbd3b31
1 parent 3349a6a
commit fbd3b31
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 36 deletions.
diff --git a/contracts/btc-finality/schema/btc-finality.json b/contracts/btc-finality/schema/btc-finality.json
@@ -231,7 +231,7 @@
         "additionalProperties": false
       },
       {
-        "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards",
+        "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards. It's a Babylon address. If rewards are to be sent to a Consumer address, the staker's equivalent address in that chain will be computed and used.",
         "type": "object",
         "required": [
           "withdraw_rewards"
@@ -915,7 +915,7 @@
         "additionalProperties": false
       },
       {
-        "description": "`PendingRewards` returns the pending rewards for a user on a finality provider. The rewards are returned in the form of a Coin",
+        "description": "`PendingRewards` returns the pending rewards for a staker on a finality provider. The staker address must be its Babylon delegator address. The rewards are returned in the form of a Coin.",
         "type": "object",
         "required": [
           "pending_rewards"
@@ -925,13 +925,13 @@
             "type": "object",
             "required": [
               "fp_pubkey_hex",
-              "user"
+              "staker_addr"
             ],
             "properties": {
               "fp_pubkey_hex": {
                 "type": "string"
               },
-              "user": {
+              "staker_addr": {
                 "type": "string"
               }
             },
@@ -941,7 +941,7 @@
         "additionalProperties": false
       },
       {
-        "description": "`AllPendingRewards` returns the pending rewards for a user on all finality providers.",
+        "description": "`AllPendingRewards` returns the pending rewards for a staker on all finality providers. The staker address must be its Babylon delegator address.",
         "type": "object",
         "required": [
           "all_pending_rewards"
@@ -950,7 +950,7 @@
           "all_pending_rewards": {
             "type": "object",
             "required": [
-              "user"
+              "staker_addr"
             ],
             "properties": {
               "limit": {
@@ -961,6 +961,9 @@
                 "format": "uint32",
                 "minimum": 0.0
               },
+              "staker_addr": {
+                "type": "string"
+              },
               "start_after": {
                 "anyOf": [
                   {
@@ -970,9 +973,6 @@
                     "type": "null"
                   }
                 ]
-              },
-              "user": {
-                "type": "string"
               }
             },
             "additionalProperties": false

diff --git a/contracts/btc-finality/schema/raw/execute.json b/contracts/btc-finality/schema/raw/execute.json
@@ -142,7 +142,7 @@
       "additionalProperties": false
     },
     {
-      "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards",
+      "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards. It's a Babylon address. If rewards are to be sent to a Consumer address, the staker's equivalent address in that chain will be computed and used.",
       "type": "object",
       "required": [
         "withdraw_rewards"

diff --git a/contracts/btc-finality/schema/raw/query.json b/contracts/btc-finality/schema/raw/query.json
@@ -241,7 +241,7 @@
       "additionalProperties": false
     },
     {
-      "description": "`PendingRewards` returns the pending rewards for a user on a finality provider. The rewards are returned in the form of a Coin",
+      "description": "`PendingRewards` returns the pending rewards for a staker on a finality provider. The staker address must be its Babylon delegator address. The rewards are returned in the form of a Coin.",
       "type": "object",
       "required": [
         "pending_rewards"
@@ -251,13 +251,13 @@
           "type": "object",
           "required": [
             "fp_pubkey_hex",
-            "user"
+            "staker_addr"
           ],
           "properties": {
             "fp_pubkey_hex": {
               "type": "string"
             },
-            "user": {
+            "staker_addr": {
               "type": "string"
             }
           },
@@ -267,7 +267,7 @@
       "additionalProperties": false
     },
     {
-      "description": "`AllPendingRewards` returns the pending rewards for a user on all finality providers.",
+      "description": "`AllPendingRewards` returns the pending rewards for a staker on all finality providers. The staker address must be its Babylon delegator address.",
       "type": "object",
       "required": [
         "all_pending_rewards"
@@ -276,7 +276,7 @@
         "all_pending_rewards": {
           "type": "object",
           "required": [
-            "user"
+            "staker_addr"
           ],
           "properties": {
             "limit": {
@@ -287,6 +287,9 @@
               "format": "uint32",
               "minimum": 0.0
             },
+            "staker_addr": {
+              "type": "string"
+            },
             "start_after": {
               "anyOf": [
                 {
@@ -296,9 +299,6 @@
                   "type": "null"
                 }
               ]
-            },
-            "user": {
-              "type": "string"
             }
           },
           "additionalProperties": false

diff --git a/contracts/btc-staking/schema/btc-staking.json b/contracts/btc-staking/schema/btc-staking.json
@@ -231,7 +231,7 @@
         "additionalProperties": false
       },
       {
-        "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards",
+        "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards. It's a Babylon address. If rewards are to be sent to a Consumer address, the staker's equivalent address in that chain will be computed and used.",
         "type": "object",
         "required": [
           "withdraw_rewards"
@@ -915,7 +915,7 @@
         "additionalProperties": false
       },
       {
-        "description": "`PendingRewards` returns the pending rewards for a user on a finality provider. The rewards are returned in the form of a Coin",
+        "description": "`PendingRewards` returns the pending rewards for a staker on a finality provider. The staker address must be its Babylon delegator address. The rewards are returned in the form of a Coin.",
         "type": "object",
         "required": [
           "pending_rewards"
@@ -925,13 +925,13 @@
             "type": "object",
             "required": [
               "fp_pubkey_hex",
-              "user"
+              "staker_addr"
             ],
             "properties": {
               "fp_pubkey_hex": {
                 "type": "string"
               },
-              "user": {
+              "staker_addr": {
                 "type": "string"
               }
             },
@@ -941,7 +941,7 @@
         "additionalProperties": false
       },
       {
-        "description": "`AllPendingRewards` returns the pending rewards for a user on all finality providers.",
+        "description": "`AllPendingRewards` returns the pending rewards for a staker on all finality providers. The staker address must be its Babylon delegator address.",
         "type": "object",
         "required": [
           "all_pending_rewards"
@@ -950,7 +950,7 @@
           "all_pending_rewards": {
             "type": "object",
             "required": [
-              "user"
+              "staker_addr"
             ],
             "properties": {
               "limit": {
@@ -961,6 +961,9 @@
                 "format": "uint32",
                 "minimum": 0.0
               },
+              "staker_addr": {
+                "type": "string"
+              },
               "start_after": {
                 "anyOf": [
                   {
@@ -970,9 +973,6 @@
                     "type": "null"
                   }
                 ]
-              },
-              "user": {
-                "type": "string"
               }
             },
             "additionalProperties": false

diff --git a/contracts/btc-staking/schema/raw/execute.json b/contracts/btc-staking/schema/raw/execute.json
@@ -142,7 +142,7 @@
       "additionalProperties": false
     },
     {
-      "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards",
+      "description": "`WithdrawRewards` is a message sent by anyone on behalf of the staker, to withdraw rewards from BTC staking via the given FP.\n\n`staker_addr` is both the address to claim and receive the rewards. It's a Babylon address. If rewards are to be sent to a Consumer address, the staker's equivalent address in that chain will be computed and used.",
       "type": "object",
       "required": [
         "withdraw_rewards"

diff --git a/contracts/btc-staking/schema/raw/query.json b/contracts/btc-staking/schema/raw/query.json
@@ -241,7 +241,7 @@
       "additionalProperties": false
     },
     {
-      "description": "`PendingRewards` returns the pending rewards for a user on a finality provider. The rewards are returned in the form of a Coin",
+      "description": "`PendingRewards` returns the pending rewards for a staker on a finality provider. The staker address must be its Babylon delegator address. The rewards are returned in the form of a Coin.",
       "type": "object",
       "required": [
         "pending_rewards"
@@ -251,13 +251,13 @@
           "type": "object",
           "required": [
             "fp_pubkey_hex",
-            "user"
+            "staker_addr"
           ],
           "properties": {
             "fp_pubkey_hex": {
               "type": "string"
             },
-            "user": {
+            "staker_addr": {
               "type": "string"
             }
           },
@@ -267,7 +267,7 @@
       "additionalProperties": false
     },
     {
-      "description": "`AllPendingRewards` returns the pending rewards for a user on all finality providers.",
+      "description": "`AllPendingRewards` returns the pending rewards for a staker on all finality providers. The staker address must be its Babylon delegator address.",
       "type": "object",
       "required": [
         "all_pending_rewards"
@@ -276,7 +276,7 @@
         "all_pending_rewards": {
           "type": "object",
           "required": [
-            "user"
+            "staker_addr"
           ],
           "properties": {
             "limit": {
@@ -287,6 +287,9 @@
               "format": "uint32",
               "minimum": 0.0
             },
+            "staker_addr": {
+              "type": "string"
+            },
             "start_after": {
               "anyOf": [
                 {
@@ -296,9 +299,6 @@
                   "type": "null"
                 }
               ]
-            },
-            "user": {
-              "type": "string"
             }
           },
           "additionalProperties": false