Skip to content

Commit fb74a38

Browse files
authored
Merge pull request #1320 from o1-labs/dw/rename-openmina-to-mina-rust-repo
Website: rename repo from openmina to mina-rust
2 parents 3b94cd8 + 49a7ddf commit fb74a38

18 files changed

+89
-89
lines changed

website/docs/developers/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ components:
128128

129129
You can run a different set of tests. The command `make help` will give you the
130130
whole set of targets. You can also visit the file
131-
[ci.yaml](https://github.com/o1-labs/openmina/blob/develop/.github/workflows/ci.yaml)
131+
[ci.yaml](https://github.com/o1-labs/mina-rust/blob/develop/.github/workflows/ci.yaml)
132132
to explore the targets used for testing in our continuous integration
133133
environment.
134134

@@ -286,7 +286,7 @@ make build-testing
286286
- **Discord**:
287287
[OpenMina Community](https://discord.com/channels/484437221055922177/1290662938734231552)
288288
- **Forums**: [Mina Protocol Forums](https://forums.minaprotocol.com/)
289-
- **Issues**: [GitHub Issues](https://github.com/o1-labs/openmina/issues)
289+
- **Issues**: [GitHub Issues](https://github.com/o1-labs/mina-rust/issues)
290290
- **API Docs**:
291291
[Rust Documentation](https://o1-labs.github.io/openmina/api-docs/)
292292

website/docs/developers/libp2p.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ specific purpose, which lets us neatly organize the various functions of the P2P
4545
network. It allows us to separate concerns, making the network architecture
4646
easier to manage and debug.
4747

48-
![LibP2P Stack Layers](https://github.com/openmina/openmina/assets/60480123/25bb08e8-d877-42b6-9c1f-b2ce29b14520)
48+
![LibP2P Stack Layers](https://github.com/o1-labs/mina-rust/assets/60480123/25bb08e8-d877-42b6-9c1f-b2ce29b14520)
4949

5050
_Above: A simplified overview of the Rust node LibP2P networking stack. The
5151
abstraction is in ascending order, i.e. the layers at the top have more
@@ -117,7 +117,7 @@ efficient routing and data lookup.
117117
The term "XOR" stands for "exclusive or," which is a logical operation that
118118
outputs true only when the inputs differ (one is true, the other is false).
119119

120-
![Kademlia Binary Tree](https://github.com/openmina/openmina/assets/60480123/4e57f9b9-9e68-4400-b0ad-ff17c14766a1)
120+
![Kademlia Binary Tree](https://github.com/o1-labs/mina-rust/assets/60480123/4e57f9b9-9e68-4400-b0ad-ff17c14766a1)
121121

122122
_Above: A Kademlia binary tree organized into four distinct buckets (marked in
123123
orange) of varying sizes._
@@ -142,7 +142,7 @@ network consisting of devices with limited resources. To make the most of a
142142
single connection, we employ _multiplexing_, which means having multiple data
143143
streams transmitted over a single network connection concurrently.
144144

145-
![Yamux Multiplexing](https://github.com/openmina/openmina/assets/60480123/5f6a48c7-bbae-4ca2-9189-badae2369f3d)
145+
![Yamux Multiplexing](https://github.com/o1-labs/mina-rust/assets/60480123/5f6a48c7-bbae-4ca2-9189-badae2369f3d)
146146

147147
### Yamux Implementation
148148

@@ -184,11 +184,11 @@ The Noise protocol implemented by libp2p uses the
184184
[XX](http://www.noiseprotocol.org/noise.html#interactive-handshake-patterns-fundamental)
185185
handshake pattern, which happens in the following stages:
186186

187-
![Noise Handshake Step 1](https://github.com/openmina/openmina/assets/60480123/a1b2b2bf-980e-459c-8375-9e8b6162b6d1)
187+
![Noise Handshake Step 1](https://github.com/o1-labs/mina-rust/assets/60480123/a1b2b2bf-980e-459c-8375-9e8b6162b6d1)
188188

189189
**Step 1**: Alice sends Bob her ephemeral public key (32 bytes).
190190

191-
![Noise Handshake Step 2](https://github.com/openmina/openmina/assets/60480123/721103dd-0bb9-4f0b-8998-97b0cc19f6fc)
191+
![Noise Handshake Step 2](https://github.com/o1-labs/mina-rust/assets/60480123/721103dd-0bb9-4f0b-8998-97b0cc19f6fc)
192192

193193
**Step 2**: Bob responds to Alice with a message that contains:
194194

@@ -199,7 +199,7 @@ handshake pattern, which happens in the following stages:
199199
`identity_sig`, Noise's static public key and the tag (MAC) of the payload (16
200200
bytes)
201201

202-
![Noise Handshake Step 3](https://github.com/openmina/openmina/assets/60480123/b7ed062d-2204-4b94-87af-abc6eecd7013)
202+
![Noise Handshake Step 3](https://github.com/o1-labs/mina-rust/assets/60480123/b7ed062d-2204-4b94-87af-abc6eecd7013)
203203

204204
**Step 3**: Alice responds to Bob with her own message that contains:
205205

website/docs/developers/p2p-networking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ propagation by leveraging the poll-based approach:
170170
#### Data Structure
171171

172172
A special
173-
[distributed pool data structure](https://github.com/openmina/openmina/blob/develop/core/src/distributed_pool.rs)
173+
[distributed pool data structure](https://github.com/o1-labs/mina-rust/blob/develop/core/src/distributed_pool.rs)
174174
efficiently tracks sent messages:
175175

176176
- **Append-Only Log**: Each entry indexed by number

website/docs/developers/scripts/setup/clone-and-build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
git clone https://github.com/o1-labs/openmina.git
2-
cd openmina
1+
git clone https://github.com/o1-labs/mina-rust.git
2+
cd mina-rust
33

44
# Download required circuits
55
echo "Downloading required circuits..."

website/docs/developers/updating-ocaml-node.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ node references in the Mina Rust Node. The OCaml node releases are used to
99
verify that the current Mina Rust Node version maintains compatibility with the
1010
official Mina Protocol implementation through end-to-end and scenario testing.
1111
This guide walks through the process based on the workflow used in
12-
[PR #1236](https://github.com/o1-labs/openmina/pull/1236).
12+
[PR #1236](https://github.com/o1-labs/mina-rust/pull/1236).
1313

1414
## 1. Check for New Releases
1515

@@ -35,7 +35,7 @@ update process:
3535
**Example usage:**
3636

3737
For example, to update from `3.2.0-alpha1` to `3.2.0-beta1` (as done in commit
38-
[31caeee6](https://github.com/o1-labs/openmina/commit/31caeee6af7bf20b8578a23bf69718dbe68fe5cc)):
38+
[31caeee6](https://github.com/o1-labs/mina-rust/commit/31caeee6af7bf20b8578a23bf69718dbe68fe5cc)):
3939

4040
```bash
4141
./website/docs/developers/scripts/update-ocaml-node.sh 7f94ae0b 978866cd "3.2.0-alpha1" "3.2.0-beta1"
@@ -79,7 +79,7 @@ After making updates:
7979
## 5. Commit Structure
8080

8181
Following the pattern from commit
82-
[31caeee6](https://github.com/o1-labs/openmina/commit/31caeee6af7bf20b8578a23bf69718dbe68fe5cc):
82+
[31caeee6](https://github.com/o1-labs/mina-rust/commit/31caeee6af7bf20b8578a23bf69718dbe68fe5cc):
8383

8484
1. **Main Update Commit**: "OCaml nodes: bump up to release [version]"
8585
- Updates 6 files: CI workflows, Docker compose, and testing configurations
@@ -90,5 +90,5 @@ Following the pattern from commit
9090

9191
- [Mina Protocol Releases](https://github.com/MinaProtocol/mina/releases/)
9292
- [Mina Rust Node Architecture Documentation](./architecture.md)
93-
- [Example PR #1236](https://github.com/o1-labs/openmina/pull/1236)
93+
- [Example PR #1236](https://github.com/o1-labs/mina-rust/pull/1236)
9494
- [Node Operators Guide](../node-operators/getting-started.md)

website/docs/developers/webrtc.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -73,21 +73,21 @@ ICE dynamically selects the best path based on connectivity and performance.
7373
## Mina Rust Node WebRTC Implementation
7474

7575
The Mina Rust Node's WebRTC implementation is located in
76-
[`p2p/src/webrtc/`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/index.html)
76+
[`p2p/src/webrtc/`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/index.html)
7777
and provides a structured approach to peer-to-peer connections for blockchain
7878
communication.
7979

8080
### Key Components
8181

82-
#### Host Resolution ([`host.rs`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/host/index.html))
82+
#### Host Resolution ([`host.rs`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/host/index.html))
8383

8484
Handles different address types:
8585

8686
- Domain names (with DNS resolution)
8787
- IPv4/IPv6 addresses
8888
- Multiaddr protocol integration
8989

90-
#### Signaling Messages ([`signal.rs`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/index.html))
90+
#### Signaling Messages ([`signal.rs`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/index.html))
9191

9292
Defines the core signaling data structures:
9393

@@ -96,15 +96,15 @@ Defines the core signaling data structures:
9696
- **Answer**: Response containing SDP and identity information
9797
- **Connection Response**: Handles acceptance, rejection, and error states
9898

99-
#### Signaling Methods ([`signaling_method/`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signaling_method/index.html))
99+
#### Signaling Methods ([`signaling_method/`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signaling_method/index.html))
100100

101101
Supports multiple signaling transport methods:
102102

103103
- HTTP/HTTPS direct connections
104104
- HTTPS proxy with cluster support
105105
- P2P relay through existing peers
106106

107-
#### Connection Authentication ([`connection_auth.rs`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/connection_auth/index.html))
107+
#### Connection Authentication ([`connection_auth.rs`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/connection_auth/index.html))
108108

109109
Provides cryptographic authentication:
110110

@@ -127,32 +127,32 @@ The Mina Rust Node's WebRTC implementation includes several security measures:
127127
### Connection Flow
128128

129129
1. **Offer Creation**: Initiating peer creates an
130-
[offer](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/struct.Offer.html)
130+
[offer](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/struct.Offer.html)
131131
with SDP, identity, and target information using
132-
[`Offer::new()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/struct.Offer.html#method.new)
132+
[`Offer::new()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/struct.Offer.html#method.new)
133133
2. **Signaling**: Offer is transmitted through the configured
134-
[signaling method](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signaling_method/enum.SignalingMethod.html)
134+
[signaling method](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signaling_method/enum.SignalingMethod.html)
135135
using
136-
[`SignalingMethod::http_url()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signaling_method/enum.SignalingMethod.html#method.http_url)
136+
[`SignalingMethod::http_url()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signaling_method/enum.SignalingMethod.html#method.http_url)
137137
for HTTP-based methods
138138
3. **Offer Processing**: Receiving peer validates chain ID, identity, and
139139
capacity using
140-
[`Offer::chain_id()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/struct.Offer.html#method.chain_id)
140+
[`Offer::chain_id()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/struct.Offer.html#method.chain_id)
141141
and
142-
[`Offer::identity()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/struct.Offer.html#method.identity)
142+
[`Offer::identity()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/struct.Offer.html#method.identity)
143143
4. **Answer Generation**: If accepted, receiving peer creates an
144-
[answer](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/struct.Answer.html)
144+
[answer](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/struct.Answer.html)
145145
with SDP using
146-
[`Answer::new()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/struct.Answer.html#method.new)
146+
[`Answer::new()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/struct.Answer.html#method.new)
147147
5. **Connection Response**: Response is wrapped in
148-
[`P2pConnectionResponse`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/signal/enum.P2pConnectionResponse.html)
148+
[`P2pConnectionResponse`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/signal/enum.P2pConnectionResponse.html)
149149
indicating acceptance or rejection
150150
6. **Authentication**: Final handshake using encrypted
151-
[connection authentication](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/connection_auth/struct.ConnectionAuth.html)
151+
[connection authentication](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/connection_auth/struct.ConnectionAuth.html)
152152
created via
153-
[`ConnectionAuth::new()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/connection_auth/struct.ConnectionAuth.html#method.new)
153+
[`ConnectionAuth::new()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/connection_auth/struct.ConnectionAuth.html#method.new)
154154
and encrypted with
155-
[`ConnectionAuth::encrypt()`](https://o1-labs.github.io/openmina/api-docs/p2p/webrtc/connection_auth/struct.ConnectionAuth.html#method.encrypt)
155+
[`ConnectionAuth::encrypt()`](https://o1-labs.github.io/mina-rust/api-docs/p2p/webrtc/connection_auth/struct.ConnectionAuth.html#method.encrypt)
156156

157157
### Integration with Mina Rust Node Architecture
158158

website/docs/node-operators/alpha-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Ensure you have **Docker** installed:
2020

2121
1. **Download the Latest Release**:
2222
- Visit the
23-
[Open Mina Releases](https://github.com/openmina/openmina/releases).
23+
[Open Mina Releases](https://github.com/o1-labs/mina-rust/releases).
2424
- Download the latest `openmina-vX.Y.Z-docker-compose.zip`.
2525

2626
2. **Extract the Files**:

website/docs/node-operators/archive-node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ node. The archiver process is responsible for storing the blocks in the database
6767
by receiving the blocks from the openmina node.
6868

6969
See
70-
[docker-compose.archive.devnet.yml](https://github.com/o1-labs/openmina/blob/develop/docker-compose.archive.devnet.yml)
70+
[docker-compose.archive.devnet.yml](https://github.com/o1-labs/mina-rust/blob/develop/docker-compose.archive.devnet.yml)
7171
for more details.
7272

7373
### Starting the setup

website/docs/node-operators/block-producer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Ensure Docker and Docker Compose are installed on your system -
1515

1616
1. **Download the Latest Release**
1717

18-
- Visit the [Open Mina Releases](https://github.com/openmina/openmina/releases)
18+
- Visit the [Open Mina Releases](https://github.com/o1-labs/mina-rust/releases)
1919
- Download the latest `openmina-vX.Y.Z-docker-compose.zip`
2020
- Extract the Files:
2121

@@ -27,7 +27,7 @@ Ensure Docker and Docker Compose are installed on your system -
2727

2828
2. **Prepare Your Keys**
2929

30-
[Docker Compose](https://github.com/o1-labs/openmina/blob/develop/docker-compose.block-producer.yml)
30+
[Docker Compose](https://github.com/o1-labs/mina-rust/blob/develop/docker-compose.block-producer.yml)
3131
references `openmina-workdir`. It stores a private key and logs for block
3232
production. Place your block producer's private key into the
3333
`openmina-workdir` directory and name it `producer-key`:

website/docs/node-operators/building-from-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ overridden:
5959

6060
For detailed information about all available command-line parameters and
6161
advanced configuration options, please refer to the
62-
[Rust API Documentation](https://o1-labs.github.io/openmina/api-docs/cli/commands/node/struct.Node.html)
62+
[Rust API Documentation](https://o1-labs.github.io/mina-rust/api-docs/cli/commands/node/struct.Node.html)
6363
which contains comprehensive documentation for all supported parameters
6464
including:
6565

0 commit comments

Comments
 (0)