Skip to content

Commit

Permalink
Merge pull request #86 from Entropy-Foundation/rename_to_quant
Browse files Browse the repository at this point in the history
rename octa to quant
  • Loading branch information
so-kkroy22 authored Sep 28, 2024
2 parents b710f2d + 13bd660 commit 90751ef
Show file tree
Hide file tree
Showing 209 changed files with 1,181 additions and 1,202 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The Aptos Core project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the following so that you can understand what actions will and will not be tolerated.
The Supra Core project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the following so that you can understand what actions will and will not be tolerated.

## Our Pledge

Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
---
id: contributing
title: Contributing to Aptos Core
title: Contributing to Supra Core
---

# Contributing

Our goal is to make contributing to Aptos Core easy and transparent. See [Aptos Community](https://aptos.dev/community) for full details. This page describes [our development process](#our-development-process).
Our goal is to make contributing to Supra Core easy and transparent. See [Supra Community](https://aptos.dev/community) for full details. This page describes [our development process](#our-development-process).

## Aptos Core
## Supra Core

To contribute to the Aptos Core implementation, first start with the proper development copy.
To contribute to the Supra Core implementation, first start with the proper development copy.
You may want to use the GitHub interface to fork [aptos-core](https://github.com/aptos-labs/aptos-core) and check out your fork.
For development environment setup and first build, see [Building Aptos From Source](https://aptos.dev/guides/building-from-source)
For development environment setup and first build, see [Building Supra From Source](https://aptos.dev/guides/building-from-source)

## Our Development Process

### Code Style, Hints, and Testing

Refer to our Coding Guidelines for the [Move](https://aptos.dev/move/book/coding-conventions/) and [Rust](./RUST_CODING_STYLE.md) programming languages for detailed guidance about how to contribute to the project.

Also, please ensure you follow our [Secure Coding Guidelines](./RUST_SECURE_CODING.md) to contribute to Aptos securely.
Also, please ensure you follow our [Secure Coding Guidelines](./RUST_SECURE_CODING.md) to contribute to Supra securely.


### Documentation

Aptos Core's developer website is also open source (the code can be found in this [repository](https://github.com/aptos-labs/developer-docs). It is built using [Docusaurus](https://docusaurus.io/):
Supra Core's developer website is also open source (the code can be found in this [repository](https://github.com/aptos-labs/developer-docs). It is built using [Docusaurus](https://docusaurus.io/):

If you know Markdown, you can already contribute!

Expand Down Expand Up @@ -106,4 +106,4 @@ It is important that the project history is bisect-able so that when regressions

## Issues

Aptos Core uses [GitHub issues](https://github.com/aptos-labs/aptos-core/issues) to track bugs. Please include necessary information and instructions to reproduce your issue.
Supra Core uses [GitHub issues](https://github.com/aptos-labs/aptos-core/issues) to track bugs. Please include necessary information and instructions to reproduce your issue.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a href="https://aptos.dev">
<img width="100%" src="./.assets/aptos_banner.png" alt="Aptos Banner" />
<img width="100%" src="./.assets/aptos_banner.png" alt="Supra Banner" />
</a>

---
Expand All @@ -9,19 +9,19 @@
[![codecov](https://codecov.io/gh/aptos-labs/aptos-core/branch/main/graph/badge.svg?token=X01RKXSGDE)](https://codecov.io/gh/aptos-labs/aptos-core)
[![Discord chat](https://img.shields.io/discord/945856774056083548?style=flat-square)](https://discord.gg/aptosnetwork)

Aptos is a layer 1 blockchain bringing a paradigm shift to Web3 through better technology and user experience. Built with Move to create a home for developers building next-gen applications.
Supra is a layer 1 blockchain bringing a paradigm shift to Web3 through better technology and user experience. Built with Move to create a home for developers building next-gen applications.

## Getting Started

* [Aptos Foundation](https://aptosfoundation.org/)
* [Aptos Developer Network](https://aptos.dev)
* [Guide - Integrate with the Aptos Blockchain](https://aptos.dev/guides/system-integrators-guide)
* [Supra Foundation](https://aptosfoundation.org/)
* [Supra Developer Network](https://aptos.dev)
* [Guide - Integrate with the Supra Blockchain](https://aptos.dev/guides/system-integrators-guide)
* [Tutorials](https://aptos.dev/tutorials)
* Follow us on [Twitter](https://twitter.com/Aptos).
* Join us on the [Aptos Discord](https://discord.gg/aptosnetwork).
* Follow us on [Twitter](https://twitter.com/Supra).
* Join us on the [Supra Discord](https://discord.gg/aptosnetwork).

## Contributing

You can learn more about contributing to the Aptos project by reading our [Contribution Guide](https://github.com/aptos-labs/aptos-core/blob/main/CONTRIBUTING.md) and by viewing our [Code of Conduct](https://github.com/aptos-labs/aptos-core/blob/main/CODE_OF_CONDUCT.md).
You can learn more about contributing to the Supra project by reading our [Contribution Guide](https://github.com/aptos-labs/aptos-core/blob/main/CONTRIBUTING.md) and by viewing our [Code of Conduct](https://github.com/aptos-labs/aptos-core/blob/main/CODE_OF_CONDUCT.md).

Aptos Core is licensed under [Apache 2.0](https://github.com/aptos-labs/aptos-core/blob/main/LICENSE).
Supra Core is licensed under [Apache 2.0](https://github.com/aptos-labs/aptos-core/blob/main/LICENSE).
16 changes: 8 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Aptos Release Process
# Supra Release Process

## Naming Conventions for Branches and Tags

Expand All @@ -20,22 +20,22 @@
All current development occurs on the `main` branch. All new feature developments have a feature flag to gate it off during development. Feature flags are turned on *after* the development is complete and passes Governance.

### devnet branch
The `devnet` branch is created on the `main` branch every week. It is used to deploy devnet and allows the Aptos Community to explore the most recent changes to the Aptos node binary and Aptos framework. Follow along in our [#devnet-release](https://discord.com/channels/945856774056083548/956692649430093904) channel on [Discord](https://discord.gg/aptosnetwork).
The `devnet` branch is created on the `main` branch every week. It is used to deploy devnet and allows the Supra Community to explore the most recent changes to the Supra node binary and Supra framework. Follow along in our [#devnet-release](https://discord.com/channels/945856774056083548/956692649430093904) channel on [Discord](https://discord.gg/aptosnetwork).

### aptos-release-v*X.Y* release branches
These are release branches based on Aptos release planning timeline. They are created off
These are release branches based on Supra release planning timeline. They are created off
the `main` branch every 1-2 months.

### aptos-node-v*X.Y.Z* release tag
The aptos node release tags are created for validator/fullnode deployment of the given release branch. The minor number *Z* will increment when a new hot-fix release is required on the release branch. Aptos team will publish the matching tag docker images on [Aptos Docker Hub](https://hub.docker.com/r/aptoslabs/validator/tags) when it's available.
The aptos node release tags are created for validator/fullnode deployment of the given release branch. The minor number *Z* will increment when a new hot-fix release is required on the release branch. Supra team will publish the matching tag docker images on [Supra Docker Hub](https://hub.docker.com/r/aptoslabs/validator/tags) when it's available.

### aptos-framework-v*X.Y.Z* release tag
The aptos framework release tags are created to facilitate the on-chain framework upgrade of the given release branch. The minor number *Z* will increment when a new hot-fix release or a new framework update is required on this release branch.

### aptos-cli-v*X.Y.Z* release tag
The aptos cli release tags are created to track the CLI versions for community to use when developing on the Aptos network. It's always recommended to upgrade your CLI when a new version is released, for the best user experience. Learn how to update to the [latest CLI version](https://aptos.dev/tools/aptos-cli/install-cli/install-from-brew/#upgrading-the-cli).
The aptos cli release tags are created to track the CLI versions for community to use when developing on the Supra network. It's always recommended to upgrade your CLI when a new version is released, for the best user experience. Learn how to update to the [latest CLI version](https://aptos.dev/tools/aptos-cli/install-cli/install-from-brew/#upgrading-the-cli).

## Aptos Release Lifecycle
## Supra Release Lifecycle
(The time length here is a rough estimate, it varies depends on each release.)
* [day 0] A release branch `aptos-release-vx.y` will be created, with a commit hash `abcde`. The full test suite will be triggered for the commit hash for validation.
* [day 1] The release will be deployed to **devnet**.
Expand All @@ -48,10 +48,10 @@ The aptos cli release tags are created to track the CLI versions for community t
* [day 24] Proposals executed on-chain if passed voting.

## Release Announcement
* Each of the network release will be announced on Aptos Network [Discord](https://discord.gg/aptosnetwork). Follow mainnet-release, testnet-release, devnet-release channel to get updates.
* Each of the network release will be announced on Supra Network [Discord](https://discord.gg/aptosnetwork). Follow mainnet-release, testnet-release, devnet-release channel to get updates.
* When a release is ready to deploy, a [Github release page](https://github.com/aptos-labs/aptos-core/releases) will be created in this repo as well. You can search for the most recent release version titled with "[Mainnet]" for production usage.

## How we test each release at Aptos
## How we test each release at Supra
### Blockchain
* We write and maintain high quality unit tests to verify code behavior and according to the specifications. Check out our [Codecov](https://app.codecov.io/gh/aptos-labs/aptos-core)!
* Integration tests run on each PR verifying each component’s correctness.
Expand Down
24 changes: 12 additions & 12 deletions RUST_CODING_STYLE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Coding Guidelines for Aptos Core
# Coding Guidelines for Supra Core

This document describes the coding guidelines for the [Aptos Core](https://github.com/aptos-labs/aptos-core) Rust codebase. For the Move language, see the [Move Coding Conventions](https://aptos.dev/move/book/SUMMARY).
Secure coding guidance is provided in the [Aptos Rust Secure Coding Guidelines](./RUST_SECURE_CODING.md).
This document describes the coding guidelines for the [Supra Core](https://github.com/aptos-labs/aptos-core) Rust codebase. For the Move language, see the [Move Coding Conventions](https://aptos.dev/move/book/SUMMARY).
Secure coding guidance is provided in the [Supra Rust Secure Coding Guidelines](./RUST_SECURE_CODING.md).

## Code formatting & Code analysis

Expand Down Expand Up @@ -44,7 +44,7 @@ struct Point {

### Terminology

The Aptos codebase uses inclusive terminology (similar to other projects such as [the Linux kernel](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=49decddd39e5f6132ccd7d9fdc3d7c470b0061bb)). The terms below are recommended when appropriate.
The Supra codebase uses inclusive terminology (similar to other projects such as [the Linux kernel](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=49decddd39e5f6132ccd7d9fdc3d7c470b0061bb)). The terms below are recommended when appropriate.

- allowlist - a set of entities allowed access
- blocklist - a set of entities that are blocked from access
Expand All @@ -68,7 +68,7 @@ Document the following for each function:

### README.md for top-level directories and other major components

Each major component of Aptos Core needs to have a `README.md` file. Major components are:
Each major component of Supra Core needs to have a `README.md` file. Major components are:

- top-level directories (e.g. `aptos-core/network`, `aptos-core/language`)
- the most important crates in the system (e.g. `vm-runtime`)
Expand Down Expand Up @@ -111,11 +111,11 @@ For the external API of this crate refer to [Link to rustdoc API].

## Contributing

Refer to the Aptos Project contributing guide [LINK].
Refer to the Supra Project contributing guide [LINK].

## License

Refer to the Aptos Project License [LINK].
Refer to the Supra Project License [LINK].
```

A good example of README.md is `aptos-core/network/README.md` that describes the networking crate.
Expand Down Expand Up @@ -264,9 +264,9 @@ mod tests {

_Property-based tests_

Aptos contains [property-based tests](https://blog.jessitron.com/2013/04/25/property-based-testing-what-is-it/) written in Rust using the [`proptest` framework](https://github.com/AltSysrq/proptest). Property-based tests generate random test cases and assert that invariants, also called _properties_, hold for the code under test.
Supra contains [property-based tests](https://blog.jessitron.com/2013/04/25/property-based-testing-what-is-it/) written in Rust using the [`proptest` framework](https://github.com/AltSysrq/proptest). Property-based tests generate random test cases and assert that invariants, also called _properties_, hold for the code under test.

Some examples of properties tested in Aptos:
Some examples of properties tested in Supra:

- Every serializer and deserializer pair is tested for correctness with random inputs to the serializer. Any pair of functions that are inverses of each other can be tested this way.
- The results of executing common transactions through the VM are tested using randomly generated scenarios and verified with an _Oracle_.
Expand All @@ -281,7 +281,7 @@ References:

### Conditional compilation of tests

Aptos [conditionally
Supra [conditionally
compiles](https://doc.rust-lang.org/stable/reference/conditional-compilation.html)
code that is _only relevant for tests, but does not consist of tests_ (unitary
or otherwise). Examples of this include proptest strategies, implementations
Expand All @@ -301,7 +301,7 @@ As a consequence, it is recommended that you set up your test-only code in the f

**For production crates:**

Production crates are defined as the set of crates that create externally published artifacts, e.g. the Aptos validator,
Production crates are defined as the set of crates that create externally published artifacts, e.g. the Supra validator,
the Move compiler, and so on.

For the sake of example, we'll consider you are defining a test-only helper function `foo` in `foo_crate`:
Expand Down Expand Up @@ -349,7 +349,7 @@ elements in another crate need to activate the "fuzzing" feature through the
`[features]` section in their `Cargo.toml`. [Integration
tests](https://doc.rust-lang.org/rust-by-example/testing/integration_testing.html)
can neither rely on the `test` flag nor do they have a proper `Cargo.toml` for
feature activation. In the Aptos codebase, we therefore recommend that
feature activation. In the Supra codebase, we therefore recommend that
_integration tests which depend on test-only code in their tested crate_ be
extracted to their own test-only crate. See `language/move-binary-format/serializer_tests`
for an example of such an extracted integration test.
Expand Down
Loading

0 comments on commit 90751ef

Please sign in to comment.