chore: fix comment

XDeFi-tech · May 27, 2024 · 425d3f0 · 425d3f0
1 parent d4b448f
commit 425d3f0
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 37 deletions.
diff --git a/gas-tank/balance-services.md b/gas-tank/balance-services.md
@@ -147,12 +147,12 @@ await fetch(`${GAS_TANK_ENDPOINT}/balances/increase`, {
   },
   body: JSON.stringify({
     address: address, // [!code highlight]
-    tokenAddress: "string", // [!code highlight]
-    chain: "string", // [!code highlight]
-    owner: "string", // [!code highlight]
-    spender: "string", // [!code highlight]
-    value: "string", // [!code highlight]
-    deadline: 0, // [!code highlight]
+    tokenAddress: "string", // Token contract address for deposit // [!code highlight]
+    chain: "string", // The blockchain network [!code highlight]
+    owner: "string", // The owner's address (can match the 'address' field) [!code highlight]
+    spender: "string", // Gas Tank's internal address [!code highlight]
+    value: "string", // Amount of deposited token [!code highlight]
+    deadline: 0, // Date for checking the validity of the signature [!code highlight]
     v: v, // [!code highlight]
     r: r, // [!code highlight]
     s: s // [!code highlight]
@@ -197,10 +197,10 @@ await fetch(`${GAS_TANK_ENDPOINT}/balances/withdraw`, {
   },
   body: JSON.stringify({
     address: address, // [!code highlight]
-    tokenAddress: "string", // [!code highlight]
-    amount: "string", // [!code highlight]
-    chain: "string", // [!code highlight]
-    recipient: "string", // [!code highlight]
+    tokenAddress: "string", // Token contract address for withdraw [!code highlight]
+    amount: "string", // Amount of withdraw token [!code highlight]
+    chain: "string", // The blockchain network [!code highlight]
+    recipient: "string", // The recipient's wallet address [!code highlight]
     message: message, // [!code highlight]
     signature: signature // [!code highlight]
   }),
@@ -240,10 +240,10 @@ await fetch(`${GAS_TANK_ENDPOINT}/balances/transfer`, {
   },
   body: JSON.stringify({
     address: address, // [!code highlight]
-    tokenAddress: "string", // [!code highlight]
-    amount: "string", // [!code highlight]
-    chain: "string", // [!code highlight]
-    recipient: "string", // [!code highlight]
+    tokenAddress: "string", // Token contract address for transfer [!code highlight]
+    amount: "string", // Amount of transfer [!code highlight]
+    chain: "string", // The blockchain network [!code highlight]
+    recipient: "string", // The recipient's wallet address  [!code highlight]
     message: message, // [!code highlight]
     signature: signature, // [!code highlight]
   }),
@@ -274,9 +274,9 @@ await fetch(`${GAS_TANK_ENDPOINT}/balances/consume/quote`, {
     Authorization: `Bearer ${jwtToken}`, // JWT token // [!code highlight]
   },
   body: JSON.stringify({
-    address: "string", // [!code highlight]
-    minDestinationAmount: "string", // [!code highlight]
-    destinationChain: "string", // [!code highlight]
+    address: "string", // Your wallet address // [!code highlight]
+    minDestinationAmount: "string", // Minimum amount of the token to consume // [!code highlight]
+    destinationChain: "string", // The blockchain network // [!code highlight]
   }),
 })
   .then((response) => {
@@ -332,9 +332,9 @@ await fetch(`${GAS_TANK_ENDPOINT}/balances/consume`, {
   },
   body: JSON.stringify({
     address: address, // [!code highlight]
-    minDestinationAmount: "string", // [!code highlight]
-    destinationAddress: "string", // [!code highlight]
-    destinationChain: "string", // [!code highlight]
+    minDestinationAmount: "string", // Minimum amount of the token to consume // [!code highlight]
+    destinationAddress: "string", // The recipient's wallet address // [!code highlight]
+    destinationChain: "string", // The blockchain network // [!code highlight]
     message: message, // [!code highlight]
     signature: signature, // [!code highlight]
   }),

diff --git a/gas-tank/messages-service.md b/gas-tank/messages-service.md
@@ -15,10 +15,10 @@ await fetch(`${GAS_TANK_ENDPOINT}/msg/increase`, {
     "Content-Type": "application/json",
   },
   body: JSON.stringify({
-    owner: "string", // [!code highlight]
-    tokenAddress: "string", // [!code highlight]
-    amount: "string", // [!code highlight]
-    chain: "string", // [!code highlight]
+    owner: "0xOwnerWalletAddress", // The wallet address of the owner // [!code highlight]
+    tokenAddress: "0xTokenContractAddress", // The contract address of the token // [!code highlight]
+    amount: "1", // Amount of the token to deposit // [!code highlight]
+    chain: "ethereum", // The blockchain network, e.g., 'ethereum' // [!code highlight]
   }),
 }).then((response) => {
   console.log(response);
@@ -50,11 +50,11 @@ await fetch(`${GAS_TANK_ENDPOINT}/msg/withdraw`, {
     "Content-Type": "application/json",
   },
   body: JSON.stringify({
-    address: "string", // [!code highlight]
-    tokenAddress: "string", // [!code highlight]
-    amount: "string", // [!code highlight]
-    chain: "string", // [!code highlight]
-    recipient: "string", // [!code highlight]
+    address: "0xYourWalletAddress", // Your wallet address // [!code highlight]
+    tokenAddress: "0xTokenContractAddress", // The contract address of the token // [!code highlight]
+    amount: "1", // Amount of the token to withdraw // [!code highlight]
+    chain: "ethereum", // The blockchain network, e.g., 'ethereum' // [!code highlight]
+    recipient: "0xRecipientWalletAddress", // The recipient's wallet address // [!code highlight]
   }),
 }).then((response) => {
   console.log(response);
@@ -86,11 +86,11 @@ await fetch(`${GAS_TANK_ENDPOINT}/msg/internal-transfer`, {
     "Content-Type": "application/json",
   },
   body: JSON.stringify({
-    address: "string", // [!code highlight]
-    tokenAddress: "string", // [!code highlight]
-    amount: "string", // [!code highlight]
-    chain: "string", // [!code highlight]
-    recipient: "string", // [!code highlight]
+    address: "0xYourWalletAddress", // Your wallet address // [!code highlight]
+    tokenAddress: "0xTokenContractAddress", // The contract address of the token // [!code highlight]
+    amount: "1", // Amount of the token to transfer // [!code highlight]
+    chain: "ethereum", // The blockchain network, e.g., 'ethereum' // [!code highlight]
+    recipient: "0xRecipientWalletAddress", // The recipient's wallet address // [!code highlight]
   }),
 }).then((response) => {
   console.log(response);
@@ -122,9 +122,9 @@ await fetch(`${GAS_TANK_ENDPOINT}/msg/consume`, {
     "Content-Type": "application/json",
   },
   body: JSON.stringify({
-    address: "string", // [!code highlight]
-    minDestinationAmount: "string", // [!code highlight]
-    destinationChain: "string", // [!code highlight]
+    address: "0xYourWalletAddress", // Your wallet address // [!code highlight]
+    minDestinationAmount: "1", // Minimum amount of the token to consume // [!code highlight]
+    destinationChain: "ethereum", // The blockchain network, e.g., 'ethereum' // [!code highlight]
   }),
 }).then((response) => {
   console.log(response);