Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the external md for node tools #728

Merged
merged 49 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
9fc18de
Add files via upload
0xarmagan Jul 29, 2024
8af54f1
Update 07-24-core-devs-call.md
0xarmagan Jul 29, 2024
1bb846e
fix broken RPC url
vanshika-srivastava Jul 29, 2024
683d1c8
fix all the broken anchors and hyperlinks
vanshika-srivastava Jul 31, 2024
edc86c6
chore: fix some comments (#702)
zhoufanjin Jul 31, 2024
0244f05
shutterized -> to change to shutter enabled
vanshika-srivastava Aug 1, 2024
4a5ca3c
Merge branch 'main' into dev
vanshika-srivastava Aug 1, 2024
8db8770
fix core dev call layout
vanshika-srivastava Aug 2, 2024
4550427
Core Devs Call Notes July 31, 2024
0xarmagan Aug 6, 2024
86d3056
remove custom signer from interact page
vanshika-srivastava Aug 6, 2024
76868df
fix: 07-31-core-devs-call format
zengzengzenghuy Aug 6, 2024
6461c4f
Core Devs Call Notes Aug 7, 2024
0xarmagan Aug 9, 2024
03e5df4
"Liquid Staking" Page Update (#709)
iamjackgale Aug 12, 2024
aa150fb
Update _generate_validator_keys_wagyu.md (#710)
theChim9 Aug 12, 2024
ef62199
Update voluntary-exit.md (#711)
theChim9 Aug 12, 2024
d222223
Add files via upload
0xarmagan Aug 23, 2024
c0deaae
Update 08-21-core-devs-call.md
0xarmagan Aug 23, 2024
5a2569c
Update 08-07-core-devs-call.md
0xarmagan Aug 23, 2024
b35f1e8
Merge branch 'main' into dev
vanshika-srivastava Aug 26, 2024
aec2c12
Updates 08-21-core-devs-call.md for a small typo
vanshika-srivastava Aug 26, 2024
8f6fca4
Core Devs call notes Aug 28
0xarmagan Aug 31, 2024
9b89786
feat: Cookbook Onboard integration (#715)
ClockRide Sep 2, 2024
97b2046
Update 08-28-core-devs-call.md - fix format
vanshika-srivastava Sep 2, 2024
9090c86
Added dRPC to community Faucets (#698)
maradeeym Sep 2, 2024
46c76b9
chore(bridges): update deprecated url to https://github.com/tokenbridge/
zengzengzenghuy Sep 8, 2024
a79b5c3
add section for running node with eth swarm setup
vanshika-srivastava Sep 11, 2024
fed4767
feat(bridges): add Hashi integration overview
zengzengzenghuy Sep 16, 2024
01d820f
chore(bridges): add testnet contracts for Hashi integration
zengzengzenghuy Sep 17, 2024
9e9710c
fix: error
zengzengzenghuy Sep 17, 2024
be2b4fc
Merge branch 'main' into dev
vanshika-srivastava Sep 17, 2024
98c04a7
added custom signers guides
skundu42 Sep 19, 2024
ba01ed5
Add Confidential Computing category and Secret Network tooling (#719)
secretpatrick Sep 20, 2024
294c29b
Updated the faucet link
vanshika-srivastava Sep 21, 2024
d3dacce
fix naming for confidential computing
vanshika-srivastava Sep 21, 2024
c5c2d87
Update release workflow name
gMonty030 Sep 26, 2024
ce14288
Update Faucets.md with Correct faucet link
vanshika-srivastava Sep 26, 2024
e68809a
Update communication.md with new discord link
vanshika-srivastava Sep 26, 2024
6c8aabf
Update staking.md with new discord link
vanshika-srivastava Sep 26, 2024
0154b68
Update docusaurus.config.js
vanshika-srivastava Sep 26, 2024
bbd5a48
Update troubleshooting.md
vanshika-srivastava Sep 26, 2024
ad67463
Update monitoring.md
vanshika-srivastava Sep 26, 2024
03e54a0
Update bug-bounty.md
vanshika-srivastava Sep 26, 2024
231704e
Update depositWithdrawalReward.md
vanshika-srivastava Sep 26, 2024
5caa8fa
Update offlineAndSyncIssue.md
vanshika-srivastava Sep 26, 2024
48a0857
Update changingwc.md
vanshika-srivastava Sep 26, 2024
2d08dad
Update docusaurus.config.js
vanshika-srivastava Sep 26, 2024
13884a1
Add Bee node quickstart guides (#724)
NoahMaizels Sep 30, 2024
f117dcf
Merge main into dev (#727)
vanshika-srivastava Oct 1, 2024
bd734a8
Delete docs/node/Node Tools/eth-swarm.md
vanshika-srivastava Oct 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/about/communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ keywords: [gnosis, gnosis twitter, gnosis telegram, gnosis discord, governance f

## Support

- [Discord](https://discord.gg/gnosischain)
- [Discord](https://discord.gg/gnosis)
- [Validator Resources & Feedback Form](https://tally.so/r/3y4V1W)
- General Inquiries: [[email protected]](mailto:[email protected])

Expand Down
2 changes: 1 addition & 1 deletion docs/about/networks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ keywords:
| CL Explorer | https://gnosischa.in/ | https://beacon.chiadochain.net |
| Fork monitor | https://forkmon.gnosischain.com | https://forkmon.chiadochain.net |
| EthStats | https://ethstats.gnosischain.com | https://ethstats.chiadochain.net |
| Faucet | https://gnosisfaucet.com | https://faucet.chiadochain.net/ |
| Faucet | https://faucet.gnosischain.com/ | https://faucet.chiadochain.net/ |
2 changes: 1 addition & 1 deletion docs/about/specs/bug-bounty.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ More info -> [https://medium.com/immunefi/xdai-stake-hosts-2-000-000-bug-bounty-
## What’s next?

- [Submit a bug](https://bugs.immunefi.com/)
- Any questions about the program? Reach out to us in our [Discord](https://discord.gg/gnosischain) channel!
- Any questions about the program? Reach out to us in our [Discord](https://discord.gg/gnosis) channel!

## FAQ

Expand Down
116 changes: 116 additions & 0 deletions docs/bridges/About Token Bridges/hashi-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
sidebar_position: 5
title: Hashi Integration
description: How do the bridges work after Hashi integration
keywords: [amb bridge, arbitrary message bridge, omnibridge, xdai bridge, hashi]
---

# Hashi integration

The proposal of Hashi integration on Gnosis Chain's bridges (AMB & Omnibridge, xDAI bridge) is [approved by Gnosis DAO members](https://forum.gnosis.io/t/gip-93-should-gnosisdao-support-the-integration-of-hashi-within-gnosis-chains-canonical-bridges/8245/5) on April 2nd, 2024. The integration introduces advanced security measures, mitigates systemic risks, and ensures the Gnosis Chain ecosystem remains resilient against the evolving landscape of security threats. With the efforts from Cross-Chain Alliance and Gnosis team, the integration is going toward production.

## What’s new?

1. Hashi Manager contract: New contract. Set reporters, adapters, and threshold parameters used by the bridge contract.
2. New variables/function:
1. HASHI_ENABLED: New variable. When set to true, every message can be approved by Hashi, but the message need not to be approved by Hashi for it to get executed.
2. HASHI_MANDATORY: New variable. When set to true, every message has to be approved by Hashi before execution.
3. isApprovedByHashi(bytes32 msgId): New public function. Return whether a message w.r.t a message Id is approved by Hashi.
4. setHashiManager(address HashiManager): New function, onlyOwner. Set Hashi Manager contract on the bridge contract.
3. Modified events:
1. xDAI Bridge: in xDAI bridge, a `bytes32 nonce` is added into `UserRequestForAffirmation` and `UserRequestForSignature` events.
1. `event UserRequestForAffirmation(address recipient, uint256 value)` is changed to `event UserRequestForAffirmation(address recipient, uint256 value, bytes32 nonce)`
2. `event UserRequestForSignature(address recipient, uint256 value)` is changed to `UserRequestForSignature(address recipient, uint256 value bytes32 nonce)`

## AMB & Omnibridge

![](../../../static/img/bridges/hashi/Hashi-Gnosis-AMB.png)

For Omnibridge / AMB:

**Ethereum → Gnosis Chain**

1. User approves token for Foreign Omnibridge
2. User calls ForeignOmnibridge.relayTokens(address token, address receiver, uint256 amount)
1. ForeignOmnibridge calls ForeignAMB.requireToPassMessage()
2. ForeignAMB check if HASHI_IS_ENABLED is true, and call Yaho.dispatchMessage
3. Off chain relayer detects MessageDispatched event from Yaho and call Yaho.relayMessagesToAdapters to relay message to each reporters.
4. Reporters relay the messageId and message hash to adapter contract on Gnosis Chain.
5. Light Client based oracle only stores hashes on Gnosis Chain.
3. If Hashi is enabled & mandatory, off chain executor calls Gnosis Chain’s Yaru.executeMessages(), which check if the hash is agreed upon a threshold amount of adapters (set in Hashi Manager contract) adapters and set isApprovedByHashi(messageId) to true eventually.
4. Bridge validators detects UserRequestForAffirmation event and call HomeAMB.executeAffirmation. If Hashi is enabled & mandatory, this step has to wait after step 3.

**Gnosis Chain → Ethereum**

1. User approves token for Home Omnibridge
2. User calls HomeOmnibridge.relayTokens(address token, address receiver, uint256 amount)
1. HomeOmnibridge calls HomeAMB.requireToPassMessage()
2. HomeAMB check if HASHI_IS_ENABLED is true, and call Yaho.dispatchMessage
3. Off chain relayer detects MessageDispatched event from Yaho and call Yaho.relayMessagesToAdapters to relay message to each reporters.
4. Reporters relay the messageId and message hash to adapter contract on Ethereum.
3. Bridge validators detects UserRequestForSignature event and call HomeAMB.submitSignatures.
4. If Hashi is enabled & mandatory, off chain executor calls Ethereum’s Yaru.executeMessages(), which check if the hash is agreed upon adapters and set isApprovedByHashi(messageId) to true eventually.
5. User claims token by calling Ethereum’s ForeignAMB.executeSignatures().

## xDAI briddge

![](../../../static/img/bridges/hashi/Hashi-Gnosis-AMB.png)

**Ethereum → Gnosis Chain**

1. User approves token for Foreign xDAI bridge.
2. User calls ForeignXDAIBridge.relayTokens(address receiver, uint256 amount)
1. ForeignXDAIBridge check if HASHI_IS_ENABLED is true, and call Yaho.dispatchMessage
2. Off chain relayer detects MessageDispatched event from Yaho and call Yaho.relayMessagesToAdapters to relay message to each reporters.
3. Reporters relay the messageId and message hash to adapter contract on Gnosis Chain.
4. Light Client based oracle only stores hashes on Gnosis Chain.
3. If Hashi is enabled & mandatory, off chain executor calls Gnosis Chain’s Yaru.executeMessages(), which check if the hash is agreed upon a threshold amount of adapters (set in Hashi Manager contract) and set isApprovedByHashi(messageId) to true eventually.
4. Bridge validators detects UserRequestForAffirmation event and call HomexDAIBridge.executeAffirmation. If Hashi is enabled & mandatory, this step has to wait after step 3. Block Reward contract emits AddedReceiver event, which will mint equivalent amount of xDAI to receiver in the next block.

**Gnosis Chain → Ethereum**

1. User calls HomexDAIBridge.relayTokens(address receiver, uint256 amount) or transfer xDAI to HomexDAIBridge without msg.data.
1. HomexDAIBridge check if HASHI_IS_ENABLED is true, and call Yaho.dispatchMessage
2. Off chain relayer detects MessageDispatched event from Yaho and call Yaho.relayMessagesToAdapters to relay message to each reporters.
3. Reporters relay the messageId and message hash to adapter contract on Ethereum.
2. Bridge validators detects UserRequestForSignature event and call HomexDAIBridge.submitSignatures.
3. If Hashi is enabled & mandatory, off chain executor calls Ethereum’s Yaru.executeMessages(), which check if the hash is agreed upon adapters and set isApprovedByHashi(messageId) to true eventually.
4. User claims token by calling Ethereum’s ForeignxDAIBridge.executeSignatures(). DAI is transfer to the receiver eventually.

# Testnet environment

For testing purpose, we've set up testnet environemnt. Users are welcome to experiment with the testnet environments:

- Sepolia addresses
1. ForeignAMB: [0x2F62433e00168af10c70bc39e2fDbEe5DaCA257b](https://sepolia.etherscan.io/address/0x2F62433e00168af10c70bc39e2fDbEe5DaCA257b)
2. Hashi Manager: [0x6C5F4F8a719bF054D6b08E3cCc27a5f208Ec8766](https://sepolia.etherscan.io/address/0x6C5F4F8a719bF054D6b08E3cCc27a5f208Ec8766#writeProxyContract)
- Chiado addresses
1. Home AMB: [0xAF18353BF369897Aab18ec225422F921be9F7eC6](https://gnosis-chiado.blockscout.com/address/0xAF18353BF369897Aab18ec225422F921be9F7eC6?tab=contract)
2. Hashi Manager: [0xe505cD6522E9A1c2309a915f83dDCA9addaC0895](https://gnosis-chiado.blockscout.com/address/0xe505cD6522E9A1c2309a915f83dDCA9addaC0895?tab=contract_code)
3. AMB BridgeHelper: [0x3fba3D7Ae204a684E4359A3fC211C18EA155cd78](https://gnosis-chiado.blockscout.com/address/0x3fba3D7Ae204a684E4359A3fC211C18EA155cd78)

## Omnibridge

- Sepolia address
1. Foreign Omnibridge: [0xc4e06E44B2d1e148beFAa3cB2012A985EFe7032a](https://sepolia.etherscan.io/address/0xc4e06E44B2d1e148beFAa3cB2012A985EFe7032a)
2. WETH Router: [0x65E64139f202F89cb6b4bFc140bf01Cda1886465](https://sepolia.etherscan.io/address/0x65E64139f202F89cb6b4bFc140bf01Cda1886465#code)
- Chiado address
1. Home Omnibridge: [0xB866dC5321Ca41a22938A7afD5Bc3c5069975874](https://gnosis-chiado.blockscout.com/address/0xB866dC5321Ca41a22938A7afD5Bc3c5069975874?tab=write_proxy)

## xDAI

- Sepolia addresses
1. Foreign xDAI: [0x97589968FA7ef153af44C6F5d0Fb9AcaEA97AC94](https://sepolia.etherscan.io/address/0x97589968FA7ef153af44C6F5d0Fb9AcaEA97AC94)
2. Hashi Manager: [0x90d3c0c9BCb317E80A459B0126257665186E59fa](https://sepolia.etherscan.io/address/0x90d3c0c9bcb317e80a459b0126257665186e59fa#code)
- Chiado addresses
1. Home xDAI: [0x867696eA1cfA243aB909797022D0A0C99BdACcF1](https://gnosis-chiado.blockscout.com/address/0x867696eA1cfA243aB909797022D0A0C99BdACcF1?tab=contract)
2. Hashi Manager: [0x5b745C021ef62f90862a812EB6763f5758e51eE2](https://gnosis-chiado.blockscout.com/address/0x5b745C021ef62f90862a812EB6763f5758e51eE2?tab=contract)
3. xDAI Bridge Helper: [0xA7bE47d1111baFDb2f0E9ce8D6431508aC2fd98e](https://gnosis-chiado.blockscout.com/address/0xA7bE47d1111baFDb2f0E9ce8D6431508aC2fd98e#code)

## Reference

1. AMB contracts: https://github.com/crosschain-alliance/tokenbridge-contracts/tree/feat/hashi-integration-amb
2. xDAI bridge contracts: https://github.com/crosschain-alliance/tokenbridge-contracts/tree/feat/hashi-integration-xdai-bridge
3. Test: https://github.com/crosschain-alliance/tokenbridge-contracts-migration-tests
4. Audits: https://crosschain-alliance.gitbook.io/hashi/v0.2/audit-report#gnosis-bridge-hashi-integration
5. Hashi: https://crosschain-alliance.gitbook.io/hashi/v0.2/introduction
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you are using OmniBridge for other ERC20 tokens (not xDai to Dai) please see

## Bridge UI is Offline or in Maintenance Mode

We are doing some periodic maintenance and optimization on the Bridge and are now putting the UI into maintenance mode during these times to avoid additional confusion and/or delayed transactions for users. If you started a transaction but it did not complete because of maintenance mode, be assured that funds are safe and will be available once maintenance is complete. If you have questions or concerns during maintenance, please contact us in [Discord channel](https://discord.gg/gnosischain) for up-to-date information.
We are doing some periodic maintenance and optimization on the Bridge and are now putting the UI into maintenance mode during these times to avoid additional confusion and/or delayed transactions for users. If you started a transaction but it did not complete because of maintenance mode, be assured that funds are safe and will be available once maintenance is complete. If you have questions or concerns during maintenance, please contact us in [Discord channel](https://discord.gg/gnosis) for up-to-date information.

## I Only See Bridging in 1 Direction

Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Node FAQs/changingwc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Changing Withdrawal Credential
---

:::info
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosischain) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosis) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
:::

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Node FAQs/depositWithdrawalReward.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Deposit, Withdrawals, and Rewards
---

:::info
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosischain) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosis) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
:::

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Node FAQs/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Monitoring and Alerts
---

:::info
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosischain) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosis) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
:::

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Node FAQs/offlineAndSyncIssue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Offline and Sync Issue
---

:::info
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosischain) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosis) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
:::

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Node FAQs/staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Staking and Liquid Staking
---

:::info
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosischain) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
**Find this document incomplete? Visit our [Discord channel](https://discord.gg/gnosis) or contact us via [Validator Request form](https://tally.so/r/3y4V1W)!**
:::

:::info
Expand Down
10 changes: 5 additions & 5 deletions docs/node/Node Tools/eth-docker.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: eth-docker
title: Eth-docker
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# eth-docker
# Eth-docker

[eth-docker](https://eth-docker.net/) is a docker automation project for Ethereum consensus and execution clients. It aims to make running a Ethereum staking full node simpler than setting everything up manually, while allowing the user choice when it comes to the exact client mix they wish to run.
[Eth-docker](https://eth-docker.net/) is a docker automation project for Ethereum consensus and execution clients. It aims to make running a Ethereum staking full node simpler than setting everything up manually, while allowing the user choice when it comes to the exact client mix they wish to run.

eth-docker allows user to set up Gnosis clients by answering simple dialog-based questions on terminal.
Eth-docker allows user to set up Gnosis clients by answering simple dialog-based questions on terminal.

## References
1. eth-docker Docs: https://eth-docker.net/
1. Eth-docker Docs: https://eth-docker.net/
2. Github: https://github.com/eth-educators/eth-docker


Expand Down
8 changes: 8 additions & 0 deletions docs/node/Node Tools/swarm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
description: Swarm is a peer-to-peer network of Bee nodes that collectively provide censorship resistant decentralised storage and communication services.
keywords: [storage, data storage, decentralized storage, swarm]
---

# Swarm

Swarm is a peer-to-peer network of Bee nodes that collectively provide censorship resistant decentralised storage and communication services. Swarm's mission is to shape the future towards a self-sovereign global society and permissionless open markets by providing scalable base-layer data storage infrastructure for the decentralised internet. Its incentive system is enforced through smart contracts on the Gnosis Chain blockchain and powered by the xBZZ token, making it economically self-sustaining.
Loading
Loading