You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Upgrade to Avalanche v1.10.0
* Reduce gas target to 15M from 150M for Songbird nodes
* Disable add permissionless validator/delegator txs before Cortina time
* Return delegators for all nodes in getCurrentValidators if COMPLETE_GET_VALIDATORS env variable is set to true
* patch(ci): update upload-artifacts to v4
* Set Cortina times for Coston and Costwo
* Enable Ethereum prefixed signatures on X-chain
* Updated Cortina times for Coston and Costwo networks
* Updated readme and config for testnet release
* Update Cortina times for Flare and Songbird network files
* Update build-container.yml: remove arm v7 platform
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
1
# go-flare
2
2
3
-
go-flare is a modified version of [avalanchego@v1.9.0](https://github.com/ava-labs/avalanchego/releases/tag/v1.9.0) and [coreth@v0.11.0](https://github.com/ava-labs/coreth/releases/tag/v0.11.0), incorporating specific features for Flare and Songbird networks. These features include prioritized contract handling and the invocation of the daemon contract.
3
+
go-flare is a modified version of [avalanchego@v1.10.0](https://github.com/ava-labs/avalanchego/releases/tag/v1.10.0) and [coreth@v0.12.0](https://github.com/ava-labs/coreth/releases/tag/v0.12.0), incorporating specific features for Flare and Songbird networks. These features include prioritized contract handling and the invocation of the daemon contract.
4
+
5
+
**Networks should be updated to this version before**
6
+
7
+
-**Songbird: May 6, 2025 at 12 UTC**
8
+
-**Flare: May 13, 2025 at 12 UTC**
9
+
4
10
5
-
All nodes should upgrade to the version 1.9.1 **before the following dates**:
6
-
- Coston2 network: November 26, 2024 at 12:00:00 UTC
7
-
- Flare network: December 17, 2024 at 12:00:00 UTC
8
-
- Coston network: January 7, 2025 at 12:00:00 UTC
9
-
- Songbird network: January 28, 2025 at 12:00:00 UTC
After adding the APT repository, install avalanchego by running:
75
+
After adding the APT repository, install `avalanchego` by running:
74
76
75
77
```sh
76
78
sudo apt update
@@ -85,9 +87,9 @@ The Avalanche binary to be executed is named `avalanchego`.
85
87
86
88
### Docker Install
87
89
88
-
Make sure docker is installed on the machine - so commands like `docker run` etc. are available.
90
+
Make sure Docker is installed on the machine - so commands like `docker run` etc. are available.
89
91
90
-
Building the docker image of latest avalanchego branch can be done by running:
92
+
Building the Docker image of latest `avalanchego` branch can be done by running:
91
93
92
94
```sh
93
95
./scripts/build_image.sh
@@ -99,7 +101,7 @@ To check the built image, run:
99
101
docker image ls
100
102
```
101
103
102
-
The image should be tagged as `avaplatform/avalanchego:xxxxxxxx`, where `xxxxxxxx` is the shortened commit of the Avalanche source it was built from. To run the avalanche node, run:
104
+
The image should be tagged as `avaplatform/avalanchego:xxxxxxxx`, where `xxxxxxxx` is the shortened commit of the Avalanche source it was built from. To run the Avalanche node, run:
103
105
104
106
```sh
105
107
docker run -ti -p 9650:9650 -p 9651:9651 avaplatform/avalanchego:xxxxxxxx /avalanchego/build/avalanchego
@@ -133,7 +135,7 @@ See [this tutorial.](https://docs.avax.network/build/tutorials/platform/create-a
133
135
134
136
## Bootstrapping
135
137
136
-
A node needs to catch up to the latest network state before it can participate in consensus and serve API calls. This process, called bootstrapping, currently takes several days for a new node connected to Mainnet.
138
+
A node needs to catch up to the latest network state before it can participate in consensus and serve API calls. This process (called bootstrapping) currently takes several days for a new node connected to Mainnet.
137
139
138
140
A node will not [report healthy](https://docs.avax.network/build/avalanchego-apis/health) until it is done bootstrapping.
139
141
@@ -143,15 +145,15 @@ The bottleneck during bootstrapping is typically database IO. Using a more power
143
145
144
146
## Generating Code
145
147
146
-
Avalanchego uses multiple tools to generate efficient and boilerplate code.
148
+
AvalancheGo uses multiple tools to generate efficient and boilerplate code.
147
149
148
150
### Running protobuf codegen
149
151
150
152
To regenerate the protobuf go code, run `scripts/protobuf_codegen.sh` from the root of the repo.
151
153
152
154
This should only be necessary when upgrading protobuf versions or modifying .proto definition files.
153
155
154
-
To use this script, you must have [buf](https://docs.buf.build/installation) (v1.7.0), protoc-gen-go (v1.28.0) and protoc-gen-go-grpc (v1.2.0) installed.
156
+
To use this script, you must have [buf](https://docs.buf.build/installation) (v1.11.0), protoc-gen-go (v1.28.0) and protoc-gen-go-grpc (v1.2.0) installed.
Going forward, AvalancheGo will use [gomock](https://github.com/golang/mock)for mocking in unit tests.
191
+
To regenerate the [gomock](https://github.com/golang/mock)code, run `scripts/mock.gen.sh` from the root of the repo.
190
192
191
-
Example usage:
193
+
This should only be necessary when modifying exported interfaces or after modifying `scripts/mock.mockgen.txt`.
192
194
193
-
```sh
194
-
mockgen -destination vms/platformvm/state/mock_diff.go -package state github.com/ava-labs/avalanchego/vms/platformvm/state Diff
195
-
```
195
+
## Versioning
196
+
197
+
### Version Semantics
198
+
199
+
AvalancheGo is first and foremost a client for the Avalanche network. The versioning of AvalancheGo follows that of the Avalanche network.
200
+
201
+
-`v0.x.x` indicates a development network version.
202
+
-`v1.x.x` indicates a production network version.
203
+
-`vx.[Upgrade].x` indicates the number of network upgrades that have occurred.
204
+
-`vx.x.[Patch]` indicates the number of client upgrades that have occurred since the last network upgrade.
205
+
206
+
### Library Compatibility Guarantees
207
+
208
+
Because AvalancheGo's version denotes the network version, it is expected that interfaces exported by AvalancheGo's packages may change in `Patch` version updates.
196
209
197
-
This makes a mock implementation of the `Diff` interface from `github.com/ava-labs/avalanchego/vms/platformvm/state`and puts it at `vms/platformvm/state/mock_diff.go`. The struct implementing the mock will be in the `state` package.
210
+
### API Compatibility Guarantees
198
211
199
-
See `gomock` documentation for more information.
212
+
APIs exposed when running AvalancheGo will maintain backwards compatibility, unless the functionality is explicitly deprecated and announced when removed.
200
213
201
214
## Supported Platforms
202
215
@@ -232,4 +245,4 @@ To officially support a new platform, one must satisfy the following requirement
232
245
233
246
**We and our community welcome responsible disclosures.**
234
247
235
-
If you've discovered a security vulnerability, please report it via our [bug bounty program](https://hackenproof.com/avalanche/). Valid reports will be eligible for a reward (terms and conditions apply).
248
+
Please refer to our [Security Policy](SECURITY.md) and [Security Advisories](https://github.com/ava-labs/avalanchego/security/advisories).
0 commit comments