Skip to content

Commit

Permalink
feat: update docs for ICP (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
frdomovic authored Dec 18, 2024
1 parent e67619d commit 7d85b73
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 10 deletions.
14 changes: 10 additions & 4 deletions docs/02-getting-started/01-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -197,18 +197,24 @@ cargo run -p merod -- --node-name node1 --home data init --server-port 2428 --sw
```

> **_NOTE:_** A `--protocol` flag defines protocol for the context. Currently,
> we support Starknet and NEAR protocol. By default, the protocol is set to NEAR
> protocol, but you can set it explicitly to Starknet by using the following
> command:
> we support Internet Computer (ICP), Starknet and NEAR protocol. By default,
> the protocol is set to NEAR protocol, but you can set it explicitly to
> Starknet or ICP by using the following commands:
>
> ```bash title="Terminal"
> cargo run -p merod -- --node-name node1 --home data init --server-port 2428 --swarm-port 2528 --protocol starknet
> ```
>
> ```bash title="Terminal"
> cargo run -p merod -- --node-name node1 --home data init --server-port 2428 --swarm-port 2528 --protocol icp
> ```
> You can also view these settings in the config.toml file located within the
> node folder.
>
> ![NearConfig](/init/near-config.png) >![SnConfgi](/init/sn-config.png)
> **Near** ![NearConfig](/init/near-config.png) **Starknet**
> ![SnConfig](/init/sn-config.png) **Internet Computer (ICP)**
> ![ICPConfig](/init/icp-config.png)
#### 2. Run node
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Calimero currently supports the following blockchain protocols:

- NEAR
- Starknet
- Internet Computer (ICP)

<div style={{ display: 'flex', justifyContent: 'center' }}>

Expand All @@ -22,6 +23,7 @@ graph TD
A[Calimero] --> B[Integrations]
B --> C[NEAR]
B --> D[Starknet]
B --> E[ICP]
```

</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,20 @@ import TabItem from '@theme/TabItem';
defaultValue="starknet"
values={[
{label: 'Starknet', value: 'starknet'},
{label: 'ICP', value: 'icp'},
]}>

<TabItem value="starknet">
```bash title="Start node with Starknet protocol"
cargo run -p merod -- --node-name node1 --home data init --server-port 2428 --swarm-port 2528 --protocol starknet
```
</TabItem>
<TabItem value="starknet">
```bash title="Start node with Starknet protocol"
cargo run -p merod -- --node-name node1 --home data init --server-port 2428 --swarm-port 2528 --protocol starknet
```
</TabItem>
<TabItem value="icp">
```bash title="Start node with Internet Computer (ICP)"
cargo run -p merod -- --node-name node1 --home data init --server-port 2428 --swarm-port 2528 --protocol icp
```
</TabItem>

</Tabs>

**Note**: NEAR protocol is set by default, so if user wants to use NEAR
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,6 @@
},
"engines": {
"node": ">=20.13"
}
},
"packageManager": "[email protected]+sha512.38dc6fba8dba35b39340b9700112c2fe1e12f10b17134715a4aa98ccf7bb035e76fd981cf0bb384dfa98f8d6af5481c2bef2f4266a24bfa20c34eb7147ce0b5e"
}
Binary file added static/init/icp-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7d85b73

Please sign in to comment.