Add Wormhole SDK Page

.snippets/code/build/build-multichain-applications/wormhole-sdk/addresses.ts

@@ -1,8 +1,8 @@
-// Its possible to convert a string address to its Native address
+// It's possible to convert a string address to its Native address
 const ethAddr: NativeAddress<'Evm'> = toNative('Ethereum', '0xbeef...');
 
 // A common type in the SDK is the `ChainAddress` which provides
-// the additional context of the `Chain` this address is relevant for.
+// the additional context of the `Chain` this address is relevant for
 const senderAddress: ChainAddress = Wormhole.chainAddress(
   'Ethereum',
   '0xbeef...'

.snippets/code/build/build-multichain-applications/wormhole-sdk/cctp-example-snippet.ts

@@ -1,22 +1,12 @@
  const xfer = await wh.circleTransfer(
-  // amount as bigint (base units)
   req.amount,
-  // sender chain/address
   src.address,
-  // receiver chain/address
   dst.address,
-  // automatic delivery boolean
   req.automatic,
-  // payload to be sent with the transfer
   undefined,
-  // If automatic, native gas can be requested to be sent to the receiver
   req.nativeGas
 );
 
-// Note, if the transfer is requested to be Automatic, a fee for performing the relay
-// will be present in the quote. The fee comes out of the amount requested to be sent.
-// If the user wants to receive 1.0 on the destination, the amount to send should be 1.0 + fee.
-// The same applies for native gas dropoff
 const quote = await CircleTransfer.quoteTransfer(
   src.chain,
   dst.chain,
@@ -34,8 +24,6 @@ if (req.automatic) {
   return;
 }
 
-// Note: Depending on chain finality, this timeout may need to be increased.
-// See https://developers.circle.com/stablecoin/docs/cctp-technical-reference#mainnet for more
 console.log('Waiting for Attestation');
 const attestIds = await xfer.fetchAttestation(60_000);
 console.log(`Got Attestation: `, attestIds);

.snippets/code/build/build-multichain-applications/wormhole-sdk/cctp.ts

@@ -8,10 +8,10 @@ import {
   Wormhole,
   amount,
   wormhole,
-} from "@wormhole-foundation/sdk";
-import evm from "@wormhole-foundation/sdk/evm";
-import solana from "@wormhole-foundation/sdk/solana";
-import { SignerStuff, getSigner, waitForRelay } from "./helpers/index.js";
+} from '@wormhole-foundation/sdk';
+import evm from '@wormhole-foundation/sdk/evm';
+import solana from '@wormhole-foundation/sdk/solana';
+import { SignerStuff, getSigner, waitForRelay } from './helpers/index.js';
 
 /*
 Notes:
@@ -24,19 +24,19 @@ AutoRelayer takes a 0.1usdc fee when xfering to any chain beside goerli, which i
 (async function () {
   // init Wormhole object, passing config for which network
   // to use (e.g. Mainnet/Testnet) and what Platforms to support
-  const wh = await wormhole("Testnet", [evm, solana]);
+  const wh = await wormhole('Testnet', [evm, solana]);
 
   // Grab chain Contexts
-  const sendChain = wh.getChain("Avalanche");
-  const rcvChain = wh.getChain("Solana");
+  const sendChain = wh.getChain('Avalanche');
+  const rcvChain = wh.getChain('Solana');
 
   // Get signer from local key but anything that implements
   // Signer interface (e.g. wrapper around web wallet) should work
   const source = await getSigner(sendChain);
   const destination = await getSigner(rcvChain);
 
   // 6 decimals for USDC (except for bsc, so check decimals before using this)
-  const amt = amount.units(amount.parse("0.2", 6));
+  const amt = amount.units(amount.parse('0.2', 6));
 
   // Choose whether or not to have the attestation delivered for you
   const automatic = false;
@@ -45,7 +45,7 @@ AutoRelayer takes a 0.1usdc fee when xfering to any chain beside goerli, which i
   // during redemption, the receiver gets some amount of native gas transferred to them
   // so that they may pay for subsequent transactions
   // The amount specified here is denominated in the token being transferred (USDC here)
-  const nativeGas = automatic ? amount.units(amount.parse("0.0", 6)) : 0n;
+  const nativeGas = automatic ? amount.units(amount.parse('0.0', 6)) : 0n;
 
   await cctpTransfer(wh, source, destination, {
     amount: amt,
@@ -75,7 +75,7 @@ async function cctpTransfer<N extends Network>(
     amount: bigint;
     automatic: boolean;
     nativeGas?: bigint;
-  },
+  }
 ) {
   // EXAMPLE_CCTP_TRANSFER
   const xfer = await wh.circleTransfer(
@@ -90,17 +90,21 @@ async function cctpTransfer<N extends Network>(
     // payload to be sent with the transfer
     undefined,
     // If automatic, native gas can be requested to be sent to the receiver
-    req.nativeGas,
+    req.nativeGas
   );
 
   // Note, if the transfer is requested to be Automatic, a fee for performing the relay
   // will be present in the quote. The fee comes out of the amount requested to be sent.
   // If the user wants to receive 1.0 on the destination, the amount to send should be 1.0 + fee.
   // The same applies for native gas dropoff
-  const quote = await CircleTransfer.quoteTransfer(src.chain, dst.chain, xfer.transfer);
-  console.log("Quote", quote);
+  const quote = await CircleTransfer.quoteTransfer(
+    src.chain,
+    dst.chain,
+    xfer.transfer
+  );
+  console.log('Quote', quote);
 
-  console.log("Starting Transfer");
+  console.log('Starting Transfer');
   const srcTxids = await xfer.initiateTransfer(src.signer);
   console.log(`Started Transfer: `, srcTxids);
 
@@ -112,11 +116,11 @@ async function cctpTransfer<N extends Network>(
 
   // Note: Depending on chain finality, this timeout may need to be increased.
   // See https://developers.circle.com/stablecoin/docs/cctp-technical-reference#mainnet for more
-  console.log("Waiting for Attestation");
+  console.log('Waiting for Attestation');
   const attestIds = await xfer.fetchAttestation(60_000);
   console.log(`Got Attestation: `, attestIds);
 
-  console.log("Completing Transfer");
+  console.log('Completing Transfer');
   const dstTxids = await xfer.completeTransfer(dst.signer);
   console.log(`Completed Transfer: `, dstTxids);
   // EXAMPLE_CCTP_TRANSFER
@@ -125,16 +129,16 @@ async function cctpTransfer<N extends Network>(
 export async function completeTransfer(
   wh: Wormhole<Network>,
   txid: TransactionId,
-  signer: Signer,
+  signer: Signer
 ): Promise<void> {
   // EXAMPLE_RECOVER_TRANSFER
   // Rebuild the transfer from the source txid
   const xfer = await CircleTransfer.from(wh, txid);
 
   const attestIds = await xfer.fetchAttestation(60 * 60 * 1000);
-  console.log("Got attestation: ", attestIds);
+  console.log('Got attestation: ', attestIds);
 
   const dstTxIds = await xfer.completeTransfer(signer);
-  console.log("Completed transfer: ", dstTxIds);
+  console.log('Completed transfer: ', dstTxIds);
   // EXAMPLE_RECOVER_TRANSFER
-}
+}

.snippets/code/build/build-multichain-applications/wormhole-sdk/config-override.ts

@@ -1,5 +1,3 @@
-// Pass a partial WormholeConfig object to override specific
-// fields in the default config
 const wh = await wormhole('Testnet', [solana], {
   chains: {
     Solana: {

.snippets/code/build/build-multichain-applications/wormhole-sdk/config.ts

@@ -1,19 +1,19 @@
-import { wormhole } from "@wormhole-foundation/sdk";
-import solana from "@wormhole-foundation/sdk/solana";
+import { wormhole } from '@wormhole-foundation/sdk';
+import solana from '@wormhole-foundation/sdk/solana';
 (async function () {
   // EXAMPLE_CONFIG_OVERRIDE
   // Pass a partial WormholeConfig object to override specific
   // fields in the default config
-  const wh = await wormhole("Testnet", [solana], {
+  const wh = await wormhole('Testnet', [solana], {
     chains: {
       Solana: {
         contracts: {
-          coreBridge: "11111111111111111111111111111",
+          coreBridge: '11111111111111111111111111111',
         },
-        rpc: "https://api.devnet.solana.com",
+        rpc: 'https://api.devnet.solana.com',
       },
     },
   });
   // EXAMPLE_CONFIG_OVERRIDE
   console.log(wh.config.chains.Solana);
-})();
+})();

.snippets/code/build/build-multichain-applications/wormhole-sdk/core-bridge.ts

@@ -1,9 +1,6 @@
 const wh = await wormhole('Testnet', [solana]);
-
 const chain = wh.getChain('Solana');
 const { signer, address } = await getSigner(chain);
-
-// Get a reference to the core messaging bridge
 const coreBridge = await chain.getWormholeCore();
 
 // Generate transactions, sign and send them
@@ -12,31 +9,23 @@ const publishTxs = coreBridge.publishMessage(
   address.address,
   // Message to send (payload in VAA)
   encoding.bytes.encode('lol'),
-  // Nonce (user defined, no requirement for a specific value, useful to provide a unique identifier for the message)
+  // Nonce (user defined, no requirement for a specific value)
   0,
-  // ConsistencyLevel (ie finality of the message, see wormhole docs for more)
+  // ConsistencyLevel (ie finality of the message)
   0
 );
 // Send the transaction(s) to publish the message
 const txids = await signSendWait(chain, publishTxs, signer);
 
 // Take the last txid in case multiple were sent
-// the last one should be the one containing the relevant
-// event or log info
 const txid = txids[txids.length - 1];
 
 // Grab the wormhole message id from the transaction logs or storage
 const [whm] = await chain.parseTransaction(txid!.txid);
 
-// Or pull the full message content as an Unsigned VAA
-// const msgs = await coreBridge.parseMessages(txid!.txid);
-// console.log(msgs);
-
 // Wait for the vaa to be signed and available with a timeout
 const vaa = await wh.getVaa(whm!, 'Uint8Array', 60_000);
 console.log(vaa);
-// Also possible to search by txid but it takes longer to show up
-// console.log(await wh.getVaaByTxHash(txid!.txid, "Uint8Array"));
 
 const verifyTxs = coreBridge.verifyMessage(address.address, vaa!);
 console.log(await signSendWait(chain, verifyTxs, signer));