Martinh/sdk layout

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-0.ts

@@ -0,0 +1,6 @@
+const exampleLayout = [
+  { name: 'sourceChain', binary: 'uint', size: 2 },
+  { name: 'orderSender', binary: 'bytes', size: 32 },
+  { name: 'redeemer', binary: 'bytes', size: 32 },
+  { name: 'redeemerMessage', binary: 'bytes', lengthSize: 4 },
+] as const;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-1.ts

@@ -0,0 +1,4 @@
+const chainCustomConversion = {
+  to: (chainId: number) => toChain(chainId),
+  from: (chain: Chain) => chainToChainId(chain),
+} satisfies CustomConversion<number, Chain>;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-10.ts

@@ -0,0 +1,6 @@
+// Validate data structure before serialization
+const exampleFill = {
+  sourceChain: 6,
+  orderSender: new Uint8Array(32), // ensure correct size and type
+  // more fields...
+};

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-11.ts

@@ -0,0 +1,5 @@
+try {
+  const deserialized = deserializeLayout(fillLayout, data);
+} catch (error) {
+  console.error('Deserialization failed:', error);
+}

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-12.ts

@@ -0,0 +1,6 @@
+const commonLayout = [
+  { name: 'chainId', binary: 'uint', size: 2 },
+  { name: 'address', binary: 'bytes', size: 32 },
+];
+
+// Reuse the common layout in different contexts

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-13.ts

@@ -0,0 +1,9 @@
+const switchLayout = {
+  binary: 'switch',
+  idSize: 1, // size of the payload ID
+  idTag: 'messageType', // tag to identify the type of message
+  layouts: [
+    [[1, 'messageType1'], fillLayout], // layout for type 1
+    [[2, 'messageType2'], fastFillLayout], // layout for type 2
+  ],
+} as const satisfies Layout;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-14.ts

@@ -0,0 +1,8 @@
+const fixedConversionLayout = {
+  binary: 'uint',
+  size: 2,
+  custom: {
+    to: 'Ethereum',
+    from: chainToChainId('Ethereum'),
+  },
+} as const satisfies Layout;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-15.ts

@@ -0,0 +1,3 @@
+const omittedFieldLayout = [
+  { name: 'sourceChain', binary: 'uint', size: 2, omit: true }, // omitted from deserialization
+] as const satisfies Layout;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-16.ts

@@ -0,0 +1,9 @@
+const vaaLayout = [
+  { name: 'version', binary: 'uint', size: 1 },
+  { name: 'guardianSetIndex', binary: 'uint', size: 4 },
+  { name: 'timestamp', binary: 'uint', size: 4 },
+  { name: 'emitterChain', binary: 'uint', size: 2 },
+  { name: 'emitterAddress', binary: 'bytes', size: 32 },
+  { name: 'sequence', binary: 'uint', size: 8 },
+  { name: 'consistencyLevel', binary: 'uint', size: 1 },
+] as const satisfies Layout;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-17.ts

@@ -0,0 +1,11 @@
+const vaaData = {
+  version: 1,
+  guardianSetIndex: 5,
+  timestamp: 1633000000,
+  emitterChain: 2, // Ethereum
+  emitterAddress: new Uint8Array(32).fill(0),
+  sequence: BigInt(1),
+  consistencyLevel: 1,
+};
+
+const serializedVAA = serializeLayout(vaaLayout, vaaData);

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-18.ts

@@ -0,0 +1,9 @@
+const customPayloadLayout = [
+  { name: 'protocolId', binary: 'uint', size: 4 },
+  { name: 'payload', binary: 'bytes', lengthSize: 4 },
+] as const satisfies Layout;
+
+const serializedCustomPayload = serializeLayout(customPayloadLayout, {
+  protocolId: 1234,
+  payload: new Uint8Array([0x01, 0x02, 0x03]),
+});

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-19.ts

@@ -0,0 +1,4 @@
+const commonLayouts = [
+  { name: 'chainId', binary: 'uint', size: 2 },
+  { name: 'address', binary: 'bytes', size: 32 },
+];

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-2.ts

@@ -0,0 +1,5 @@
+try {
+  deserializeLayout(fillLayout, corruptedData);
+} catch (error) {
+  console.error('Error during deserialization:', error.message);
+}

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-3.ts

@@ -0,0 +1,6 @@
+const exampleLayout = [
+  { name: 'sourceChain', binary: 'uint', size: 2 },
+  { name: 'orderSender', binary: 'bytes', size: 32 },
+  { name: 'redeemer', binary: 'bytes', size: 32 },
+  { name: 'redeemerMessage', binary: 'bytes', lengthSize: 4 },
+] as const;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-4.ts

@@ -0,0 +1,9 @@
+const examplePayload = {
+  sourceChain: 6,
+  orderSender: new Uint8Array(32),
+  redeemer: new Uint8Array(32),
+  redeemerMessage: new Uint8Array([0x01, 0x02, 0x03]),
+};
+
+const serializedData = serializeLayout(exampleLayout, examplePayload);
+console.log(serializedData);

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-5.ts

@@ -0,0 +1,2 @@
+const deserializedPayload = deserializeLayout(exampleLayout, serializedData);
+console.log(deserializedPayload);

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-6.ts

@@ -0,0 +1,18 @@
+const nestedLayout = [
+  {
+    name: 'source',
+    binary: 'object',
+    layout: [
+      { name: 'chainId', binary: 'uint', size: 2 },
+      { name: 'sender', binary: 'bytes', size: 32 },
+    ],
+  },
+  {
+    name: 'redeemer',
+    binary: 'object',
+    layout: [
+      { name: 'address', binary: 'bytes', size: 32 },
+      { name: 'message', binary: 'bytes', lengthSize: 4 },
+    ],
+  },
+] as const satisfies Layout;

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-7.ts

@@ -0,0 +1,10 @@
+const message: NestedMessage = {
+  source: {
+    chainId: 6,
+    sender: new Uint8Array(32),
+  },
+  redeemer: {
+    address: new Uint8Array(32),
+    message: new Uint8Array([0x01, 0x02, 0x03]),
+  },
+};

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-8.ts

@@ -0,0 +1,4 @@
+const serializedNested = serializeLayout(nestedLayout, message);
+const deserializedNested = deserializeLayout(nestedLayout, serializedNested);
+
+console.log(deserializedNested);

.snippets/code/build/toolkit/wormhole-sdk/sdk-layout/layout-9.ts

@@ -0,0 +1,8 @@
+const SIZE_32 = 32;
+const UINT_TYPE = 'uint';
+
+// Example layout using constants
+const exampleLayout = [
+  { name: 'orderSender', binary: 'bytes', size: SIZE_32 },
+  { name: 'sourceChain', binary: UINT_TYPE, size: 2 },
+] as const;

build/applications/.pages

@@ -1,6 +1,6 @@
 title: Build Frontend Applications
 nav:
  - index.md
- - 'Wormhole SDK': 'wormhole-sdk.md'
+ - wormhole-sdk
  - queries
  - connect

build/applications/wormhole-sdk/.pages

@@ -0,0 +1,6 @@
+title: Wormhole SDK
+nav:
+ - index.md
+ - 'TypeScript SDK' : 'wormhole-sdk.md'
+ - 'Data Layouts': 'sdk-layout.md'
+

build/applications/wormhole-sdk/index.md

@@ -0,0 +1,30 @@
+---
+title: Wormhole SDK
+description: The Wormhole SDK provides tools for cross-chain communication, token bridges, and more, enabling developers to integrate with multiple blockchain environments.
+---
+
+# Wormhole SDK
+
+## Get Started
+
+The Wormhole SDK provides developers with essential tools for cross-chain communication, token bridges, and more. This SDK enables seamless interaction between different blockchain environments with a focus on performance and usability.
+
+<div class="grid cards" markdown>
+
+-   :octicons-book-16:{ .lg .middle } **Wormhole SDK**
+
+    ---
+
+    Learn about the core functionalities of the Wormhole SDK, including how to use its features for building cross-chain applications.
+
+    [:octicons-arrow-right-16: Explore the SDK](/docs/build/applications/wormhole-sdk/wormhole-sdk/)
+
+-   :octicons-code-16:{ .lg .middle } **Layouts**
+
+    ---
+
+    Discover how to define, serialize, and deserialize data structures using the Wormhole SDK's layout system, ensuring efficient cross-chain communication.
+
+    [:octicons-arrow-right-16: Learn about Layouts](/docs/build/applications/wormhole-sdk/sdk-layout/)
+
+</div>