overview pages, batch vaa additions

src/SUMMARY.md

@@ -53,11 +53,11 @@
     - [NFT Module](./technical/evm/nftLayer.md)
     - [Relayer Module](./technical/evm/relayer.md)
     - [Best Practices](./technical/evm/bestPractices.md)
-  - [Solana]()
-  - [Cosmos]()
-  - [Algorand]()
-  - [Near]()
-  - [Aptos]()
+  - [Solana](./technical/solana/overview.md)
+  - [Cosmos](./technical/cosmos/overview.md)
+  - [Algorand](./technical/algorand/overview.md)
+  - [Near](./technical/near/overview.md)
+  - [Aptos](./technical/aptos/overview.md)
   - [Sui]()
 
 - [Relayers](./technical/relayer/overview.md)

src/technical/algorand/overview.md

@@ -0,0 +1,9 @@
+# Algorand
+
+The implementation contracts for Wormhole's official Algorand integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/algorand).
+
+An overview of the contracts and how they work is outlined [here](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/algorand/README.md).
+
+The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
+
+The Algorand integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).

src/technical/aptos/overview.md

@@ -0,0 +1,9 @@
+# Aptos
+
+Aptos is currently only supported in testnet.
+
+The official Wormhole integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/aptos/integration).
+
+Information for how to integrate with these contracts can be found [here](https://github.com/wormhole-foundation/wormhole/tree/aptos/integration/aptos/README.md).
+
+The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).

src/technical/cosmos/overview.md

@@ -0,0 +1,9 @@
+# Cosmos
+
+The implementation contracts for Wormhole's official Cosmos integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/cosmwasm).
+
+The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
+
+Cosmos is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/rust) useful.
+
+The Cosmos integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).

src/technical/evm/bestPractices.md

@@ -120,14 +120,18 @@ function receiveVAA(bytes32 memory batchVAA) public {
     // Headless VAAs are verifiable by parseAndVerifyVM.
 
     (IWormhole.VM2 memory vm2, bool valid, string memory reason) =
-        core_bridge.parseAndVerifyBatchVM(batchVAA, true)
+        core_bridge.parseAndVerifyBatchVM(batchVAA, true);
 
     // I know from sendMyMessage that the first VAA is a token bridge VAA,
     // so let's hand that off to the token bridge module.
-    bytes vaaData = token_bridge.completeTransferWithPayload(vm2.payloads[0])
+    bytes vaaData = token_bridge.completeTransferWithPayload(vm2.payloads[0]);
 
     // The second VAA is my message, let's hand that off to my module.
-    processMyMessage(vm2.payloads[1])
+    processMyMessage(vm2.payloads[1]);
+
+    // Lastly, uncache the headless VAAs from the core bridge.
+    // This refunds a significant amount of gas.
+    core_bridge.clearBatchCache(vm2.hashes);
 }
 ```
 

src/technical/evm/coreLayer.md

@@ -24,8 +24,9 @@ The Wormhole Core Layer effectively only has two important interactions -- (1) e
 ### Emitting a VAA
 
 There are two forms that VAAs can be emitted within Wormhole:
+
 - Single VAA: all messages will be emitted in this format
-- Batch VAA: messages that are generated from the same transaction will be emitted in this format. This feature was developed to provide an easier paradigm for composability and better gas efficiency for more involved cross-chain activity. 
+- Batch VAA: messages that are generated from the same transaction will be emitted in this format. This feature was developed to provide an easier paradigm for composability and better gas efficiency for more involved cross-chain activity.
 
 To emit a VAA, always use `publishMessage` which takes in the following arguments:
 
@@ -41,17 +42,18 @@ To emit a VAA, always use `publishMessage` which takes in the following argument
 `publishMessage` will output a `sequence` (uint64) that is used in conjunction with `emitterChainID` and `emitterAddress` to retrive the generated VAA from the Guardian Network.
 
 > How Batch VAAs are generated
-> 
-> There are two mechanisms that allow messages to be Batched together that represent a base and more advanced level of compsability.
-> 
+>
+> There are two mechanisms that allow messages to be Batched together that represent a base and more advanced level of composability.
+>
 > 1. All messages originating from the same transaction will be batched together.
 > 2. Messages that originate from the same transaction and are assigned the same nonce are additionally batched together.
 >
 > _Note: Single VAAs will always be emitted for each message within a transaction, regardless of if a message is included in a batch or not._
 >
 > Here is an example of how messages generated from the same transaction may be batched together:
-> 
+>
 > A transaction X that generates 6 messages [A, B, C, D, E, F] that are assigned `nonce` [1, 2, 2, 3, 3, 4] respectively will generate the following VAAs:
+>
 > - (1) full transaction batch VAA
 >   - [A, B, C, D, E, F]
 > - (2) smaller batch VAA
@@ -65,7 +67,6 @@ To emit a VAA, always use `publishMessage` which takes in the following argument
 >   - [E]
 >   - [F]
 
-
 ### Parsing and Verifying a VAA
 
 Parsing and Verifying a VAA will depend on the type of VAA that your application expects: a Single VAA or a Batch VAA.
@@ -81,18 +82,9 @@ To properly parse and verify a single VAA, always use `parseAndVerifyVM` which t
 2. `valid` (bool): Boolean that reflects whether or not the VAA was properly signed by the Guardian Network
 3. `reason` (string): Explanatory error message if a VAA is invalid, or an empty string if it is valid.
 
-<!--
-TODO
-everything about this
 **Batch VAA**
-
-
 To properly parse and verify a batch VAA, always use `parseAndVerifyBatchVM` which takes in two arguments: `encodedVM` (bytes) and `cache` (bool).
 
-Batch VAAs are designed so that relayers can choose to submit any subset of the observations batched together. It is the receiving contract's responsiblity to verify that all VAAs contained in a batch are submitted.
+In most scenarios, you'll want to set `cache` equal to true.
 
----
-
-Code recommendation, write the code which expects to receive a VAA to utilize parseAndVerifyVM(? unsure if this is the correct call). That way, your code will be able to handle either type 1 VAAs (single VAAs), or type 3 VAAs (headless VAAs). This allows it to utilize both single & batch VAAs and dramatically increases composability. \*this only requires like two or three lines of code, so this would be a good candidate for a code example which shows how to properly use batch vaas without breaking composability. Should note that the module code still ALWAYS needs to verify, but should do so with the 'single' message verifying and then expose that function publicly in order to enable composability.
-
--->
+This will return a VM2 object, containing all the 'headless' VAAs contained inside the batch VAA. These headless VAAs can be verified by `parseAndVerifyVM`, which means that modules which verify messages can be agnostic as to if the message was original part of a batch VAA or a single VAA. This is gone into in more depth in the [Best Practices](./bestPractices.md) section.

src/technical/near/overview.md

@@ -0,0 +1,9 @@
+# NEAR
+
+The implementation contracts for Wormhole's official NEAR integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/near).
+
+The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
+
+NEAR is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/rust) useful.
+
+The NEAR integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).

src/technical/solana/overview.md

@@ -0,0 +1,9 @@
+# Solana
+
+The implementation contracts for Wormhole's official Solana integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/solana).
+
+The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
+
+Solana is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/rust) useful.
+
+The Solana integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).