feedback tweaks

Author: MasterHW

examples/with-iota/src/index.ts

@@ -39,10 +39,17 @@ async function main() {
     IOTA_PUBLIC_KEY,
   } = process.env;
 
+  // *** ENVIRONMENT CHECKING *** //
+
   if (IOTA_ADDRESS === undefined || IOTA_PUBLIC_KEY === undefined) {
     throw new Error('IOTA_ADDRESS or IOTA_PUBLIC_KEY not set in .env.local');
   }
 
+  const publicKey = new Ed25519PublicKey(Buffer.from(IOTA_PUBLIC_KEY!, 'hex'));
+  if (publicKey.toIotaAddress() !== IOTA_ADDRESS) {
+    throw new Error('IOTA_PUBLIC_KEY does not match IOTA_ADDRESS');
+  }
+
   // sending to the same address
   const recipient = IOTA_ADDRESS;
   const amount = 1_000_000n; // 0.001 IOTA
@@ -54,12 +61,9 @@ async function main() {
     defaultOrganizationId: ORGANIZATION_ID!,
   });
 
-  const provider = new IotaClient({ url: getFullnodeUrl('testnet') });
-  const publicKey = new Ed25519PublicKey(Buffer.from(IOTA_PUBLIC_KEY!, 'hex'));
+  // *** TRANSACTION BUILDING *** //
 
-  if (publicKey.toIotaAddress() !== IOTA_ADDRESS) {
-    throw new Error('IOTA_PUBLIC_KEY does not match IOTA_ADDRESS');
-  }
+  const provider = new IotaClient({ url: getFullnodeUrl('testnet') });
 
   // fetch the user's IOTA coin objects
   const coins = await provider.getCoins({
@@ -78,7 +82,7 @@ async function main() {
       version: coins.data[0]!.version,
       digest: coins.data[0]!.digest,
     },
-  ]);
+  ]); // separate intended send amount from gas payment
   const coin = tx.splitCoins(tx.gas, [tx.pure('u64', amount)]);
   tx.transferObjects([coin], tx.pure.address(recipient));
 
@@ -97,6 +101,8 @@ async function main() {
   const signature = Buffer.from(r + s, 'hex');
   const serialized = toSerializedSignature({ signature, pubKey: publicKey });
 
+  // *** EXECUTION *** //
+
   const result = await provider.executeTransactionBlock({
     transactionBlock: Buffer.from(txBytes).toString('base64'),
     signature: serialized,

examples/with-sui/src/index.ts

@@ -43,6 +43,11 @@ async function main() {
     throw new Error('SUI_ADDRESS or SUI_PUBLIC_KEY not set in .env.local');
   }
 
+  const publicKey = new Ed25519PublicKey(Buffer.from(SUI_PUBLIC_KEY!, 'hex'));
+  if (publicKey.toSuiAddress() !== SUI_ADDRESS) {
+    throw new Error('SUI_PUBLIC_KEY does not match SUI_ADDRESS');
+  }
+
   // sending to the same address
   const recipient = SUI_ADDRESS;
   const amount = 1_000_000n; // 0.001 SUI
@@ -54,12 +59,9 @@ async function main() {
     defaultOrganizationId: ORGANIZATION_ID!,
   });
 
-  const provider = new SuiClient({ url: getFullnodeUrl('testnet') });
-  const publicKey = new Ed25519PublicKey(Buffer.from(SUI_PUBLIC_KEY!, 'hex'));
+  // *** TRANSACTION BUILDING *** //
 
-  if (publicKey.toSuiAddress() !== SUI_ADDRESS) {
-    throw new Error('SUI_PUBLIC_KEY does not match SUI_ADDRESS');
-  }
+  const provider = new SuiClient({ url: getFullnodeUrl('testnet') });
 
   // fetch the user's SUI coin objects
   const coins = await provider.getCoins({
@@ -78,7 +80,7 @@ async function main() {
       version: coins.data[0]!.version,
       digest: coins.data[0]!.digest,
     },
-  ]);
+  ]); // separate intended send amount from gas payment
   const coin = tx.splitCoins(tx.gas, [tx.pure('u64', amount)]);
   tx.transferObjects([coin], tx.pure.address(recipient));
 
@@ -97,6 +99,8 @@ async function main() {
   const signature = Buffer.from(r + s, 'hex');
   const serialized = toSerializedSignature({ signature, pubKey: publicKey });
 
+  // *** EXECUTION *** //
+
   const result = await provider.executeTransactionBlock({
     transactionBlock: Buffer.from(txBytes).toString('base64'),
     signature: serialized,