Skip to content

Commit 82c07e6

Browse files
chore: update and fix getting-started path
1 parent a59318a commit 82c07e6

File tree

12 files changed

+19
-0
lines changed

12 files changed

+19
-0
lines changed

content/tutorial/00-setup/00-getting-started/README.md renamed to content/tutorial/00-setup/00-getting-started/00-getting-started/README.md

File renamed without changes.

content/tutorial/00-setup/00-getting-started/app-a/src/lib/run.ts renamed to content/tutorial/00-setup/00-getting-started/00-getting-started/app-a/src/lib/run.ts

File renamed without changes.

content/tutorial/00-setup/00-getting-started/app-b/src/lib/run.ts renamed to content/tutorial/00-setup/00-getting-started/00-getting-started/app-b/src/lib/run.ts

File renamed without changes.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"title": "Getting started",
3+
"scope": {
4+
"prefix": "/src/lib/",
5+
"name": "src"
6+
},
7+
"focus": "/src/lib/run.ts"
8+
}

content/tutorial/00-setup/01-provider-adapters/README.md renamed to content/tutorial/00-setup/00-getting-started/01-provider-adapters/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ While these tutorials use **Ethers v5**, here's how you would initialize each ad
1919

2020
### EthersV5 Adapter
2121
```typescript
22+
/// file: run.ts
2223
import { setGlobalAdapter } from '@cowprotocol/cow-sdk'
2324
import { EthersV5Adapter } from '@cowprotocol/sdk-ethers-v5-adapter'
2425
import { ethers } from 'ethers'
@@ -32,6 +33,7 @@ setGlobalAdapter(adapter)
3233

3334
### EthersV6 Adapter
3435
```typescript
36+
/// file: run.ts
3537
import { setGlobalAdapter } from '@cowprotocol/cow-sdk'
3638
import { EthersV6Adapter } from '@cowprotocol/sdk-ethers-v6-adapter'
3739
import { ethers } from 'ethers' // v6
@@ -45,6 +47,7 @@ setGlobalAdapter(adapter)
4547

4648
### Viem Adapter
4749
```typescript
50+
/// file: run.ts
4851
import { setGlobalAdapter } from '@cowprotocol/cow-sdk'
4952
import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
5053
import { createWalletClient, custom } from 'viem'
@@ -66,6 +69,7 @@ setGlobalAdapter(adapter)
6669
Different Ethereum libraries have different APIs:
6770

6871
```typescript
72+
/// file: run.ts
6973
// Ethers v5
7074
const provider = new ethers.providers.Web3Provider(window.ethereum)
7175
const signer = provider.getSigner()
@@ -96,6 +100,7 @@ This means you set up your preferred Ethereum library once, and all SDK componen
96100
For these tutorials, we'll use **Ethers v5**:
97101

98102
```typescript
103+
/// file: run.ts
99104
import { setGlobalAdapter } from '@cowprotocol/cow-sdk'
100105
import { EthersV5Adapter } from '@cowprotocol/sdk-ethers-v5-adapter'
101106

@@ -117,6 +122,7 @@ setGlobalAdapter(adapter)
117122
If you need to change the signer (e.g., user switches accounts), you can update it:
118123

119124
```typescript
125+
/// file: run.ts
120126
// Update signer without recreating the adapter
121127
const newSigner = provider.getSigner()
122128
adapter.setSigner(newSigner)
@@ -147,6 +153,7 @@ When running the script, we may be asked to connect a wallet. We can use Rabby f
147153
An example output should look like:
148154

149155
```json
156+
/// file: output.json
150157
{
151158
"adapterType": "EthersV5Adapter",
152159
"chainId": 100,

content/tutorial/00-setup/01-provider-adapters/app-a/src/lib/run.ts renamed to content/tutorial/00-setup/00-getting-started/01-provider-adapters/app-a/src/lib/run.ts

File renamed without changes.

content/tutorial/00-setup/01-provider-adapters/app-b/src/lib/run.ts renamed to content/tutorial/00-setup/00-getting-started/01-provider-adapters/app-b/src/lib/run.ts

File renamed without changes.

content/tutorial/00-setup/01-provider-adapters/meta.json renamed to content/tutorial/00-setup/00-getting-started/01-provider-adapters/meta.json

File renamed without changes.

content/tutorial/03-umbrella-sdk/01-unified-approach/01-simple-setup/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ const signature = await cowSdk.orderSigning.signOrder(order, chainId, signer)
8585
Example output:
8686

8787
```json
88+
/// file: output.json
8889
{
8990
"cowSdkInitialized": true,
9091
"availableModules": {

content/tutorial/03-umbrella-sdk/01-unified-approach/02-complete-workflow/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ To run the code, press the "Run" button in the bottom right panel.
102102
Example output:
103103

104104
```json
105+
/// file: output.json
105106
{
106107
"appDataHash": "0xe269b...",
107108
"expectedBuyAmount": "400000000000000000000",

0 commit comments

Comments
 (0)