Consistent case fields(camelCase v.s snake_case) in checkpoint.ts and…

… faucet.ts (MystenLabs#9054) Change names of fields in checkpoint and faucet files of ts-sdk to camelCase. Add `#[serde(rename_all = "camelCase")]` to corresponding files in sui-types.
kemargrant · Mar 10, 2023 · 9b60bf7 · 9b60bf7
1 parent 22df132
commit 9b60bf7
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 43 deletions.
diff --git a/.changeset/witty-baboons-travel.md b/.changeset/witty-baboons-travel.md
@@ -0,0 +1,5 @@
+---
+"@mysten/sui.js": minor
+---
+
+Change all snake_case fields in checkpoint.ts and faucet.ts to camelCase
diff --git a/apps/explorer/src/pages/checkpoints/CheckpointDetail.tsx b/apps/explorer/src/pages/checkpoints/CheckpointDetail.tsx
@@ -108,23 +108,23 @@ function CheckpointDetail() {
                                 <Text variant="p1/medium" color="steel-darker">
                                     {
                                         data.epochRollingGasCostSummary
-                                            .computation_cost
+                                            .computationCost
                                     }
                                 </Text>
                             </DescriptionItem>
                             <DescriptionItem title="Storage Fee">
                                 <Text variant="p1/medium" color="steel-darker">
                                     {
                                         data.epochRollingGasCostSummary
-                                            .storage_cost
+                                            .storageCost
                                     }
                                 </Text>
                             </DescriptionItem>
                             <DescriptionItem title="Storage Rebate">
                                 <Text variant="p1/medium" color="steel-darker">
                                     {
                                         data.epochRollingGasCostSummary
-                                            .storage_rebate
+                                            .storageRebate
                                     }
                                 </Text>
                             </DescriptionItem>

diff --git a/apps/wallet/src/ui/app/shared/faucet/useFaucetMutation.ts b/apps/wallet/src/ui/app/shared/faucet/useFaucetMutation.ts
@@ -16,12 +16,12 @@ export function useFaucetMutation() {
             if (!address) {
                 throw new Error('Failed, wallet address not found.');
             }
-            const { error, transferred_gas_objects } =
+            const { error, transferredGasObjects } =
                 await api.requestSuiFromFaucet(address);
             if (error) {
                 throw new Error(error);
             }
-            return transferred_gas_objects.reduce(
+            return transferredGasObjects.reduce(
                 (total, { amount }) => total + amount,
                 0
             );

diff --git a/crates/sui-cost/tests/snapshots/empirical_transaction_cost__good_snapshot.snap b/crates/sui-cost/tests/snapshots/empirical_transaction_cost__good_snapshot.snap
@@ -4,48 +4,48 @@ expression: common_costs_actual
 ---
 {
   "MergeCoin": {
-    "computation_cost": 176,
-    "storage_cost": 42,
-    "storage_rebate": 0
+    "computationCost": 176,
+    "storageCost": 42,
+    "storageRebate": 0
   },
   "Publish": {
-    "computation_cost": 646,
-    "storage_cost": 140,
-    "storage_rebate": 0
+    "computationCost": 646,
+    "storageCost": 140,
+    "storageRebate": 0
   },
   "SharedCounterAssertValue": {
-    "computation_cost": 212,
-    "storage_cost": 42,
-    "storage_rebate": 21
+    "computationCost": 212,
+    "storageCost": 42,
+    "storageRebate": 21
   },
   "SharedCounterCreate": {
-    "computation_cost": 216,
-    "storage_cost": 42,
-    "storage_rebate": 0
+    "computationCost": 216,
+    "storageCost": 42,
+    "storageRebate": 0
   },
   "SharedCounterIncrement": {
-    "computation_cost": 212,
-    "storage_cost": 42,
-    "storage_rebate": 21
+    "computationCost": 212,
+    "storageCost": 42,
+    "storageRebate": 21
   },
   "SplitCoin": {
-    "computation_cost": 290,
-    "storage_cost": 105,
-    "storage_rebate": 0
+    "computationCost": 290,
+    "storageCost": 105,
+    "storageRebate": 0
   },
   "TransferPortionSuiCoin": {
-    "computation_cost": 139,
-    "storage_cost": 42,
-    "storage_rebate": 0
+    "computationCost": 139,
+    "storageCost": 42,
+    "storageRebate": 0
   },
   "TransferWholeCoin": {
-    "computation_cost": 151,
-    "storage_cost": 42,
-    "storage_rebate": 0
+    "computationCost": 151,
+    "storageCost": 42,
+    "storageRebate": 0
   },
   "TransferWholeSuiCoin": {
-    "computation_cost": 131,
-    "storage_cost": 21,
-    "storage_rebate": 0
+    "computationCost": 131,
+    "storageCost": 21,
+    "storageRebate": 0
   }
 }
diff --git a/crates/sui-open-rpc/spec/openrpc.json b/crates/sui-open-rpc/spec/openrpc.json
@@ -555,9 +555,9 @@
               "networkTotalTransactions": 792385,
               "previousDigest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt",
               "epochRollingGasCostSummary": {
-                "computation_cost": 0,
-                "storage_cost": 0,
-                "storage_rebate": 0
+                "computationCost": 0,
+                "storageCost": 0,
+                "storageRebate": 0
               },
               "timestampMs": 1676911928,
               "endOfEpochData": null,

diff --git a/crates/sui-types/src/gas.rs b/crates/sui-types/src/gas.rs
@@ -50,6 +50,7 @@ macro_rules! ok_or_gas_balance_error {
 }
 
 #[derive(Eq, PartialEq, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub struct GasCostSummary {
     pub computation_cost: u64,
     pub storage_cost: u64,

diff --git a/sdk/typescript/src/types/checkpoints.ts b/sdk/typescript/src/types/checkpoints.ts
@@ -15,9 +15,9 @@ import {
 import { TransactionDigest, TransactionEffectsDigest } from './common';
 
 export const GasCostSummary = object({
-  computation_cost: number(),
-  storage_cost: number(),
-  storage_rebate: number(),
+  computationCost: number(),
+  storageCost: number(),
+  storageRebate: number(),
 });
 export type GasCostSummary = Infer<typeof GasCostSummary>;
 
@@ -36,9 +36,9 @@ export const CheckpointCommitment = union([ECMHLiveObjectSetDigest]);
 export type CheckpointCommitment = Infer<typeof CheckpointCommitment>;
 
 export const EndOfEpochData = object({
-  next_epoch_committee: array(tuple([string(), number()])),
-  next_epoch_protocol_version: number(),
-  checkpoint_commitments: array(CheckpointCommitment),
+  nextEpochCommittee: array(tuple([string(), number()])),
+  nextEpochProtocolVersion: number(),
+  checkpointCommitments: array(CheckpointCommitment),
 });
 export type EndOfEpochData = Infer<typeof EndOfEpochData>;
 

diff --git a/sdk/typescript/src/types/faucet.ts b/sdk/typescript/src/types/faucet.ts
@@ -6,10 +6,10 @@ import { TransactionDigest, ObjectId } from './common';
 export type FaucetCoinInfo = {
   amount: number;
   id: ObjectId;
-  transfer_tx_digest: TransactionDigest;
+  transferTxDigest: TransactionDigest;
 };
 
 export type FaucetResponse = {
-  transferred_gas_objects: FaucetCoinInfo[];
+  transferredGasObjects: FaucetCoinInfo[];
   error: string | null;
 };