docs: update README for v0.1.0 (#365)

Co-authored-by: Alisander Qoshqosh <[email protected]>
OpenZeppelin · Oct 17, 2024 · 68745a7 · 68745a7
1 parent 1703d1e
commit 68745a7
Show file tree

Hide file tree

Showing 18 changed files with 32 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -3,11 +3,6 @@
 **A library for secure smart contract development** written in Rust for
 [Arbitrum Stylus](https://docs.arbitrum.io/stylus/stylus-gentle-introduction).
 
-> [!WARNING]
-> This project is still in a very early and experimental phase. It has never
-> been audited nor thoroughly reviewed for security vulnerabilities. Do not use
-> in production.
-
 ## Features
 
 - Security-first smart contracts, ported from the [`openzeppelin-contracts`]
@@ -23,16 +18,21 @@
 
 ## Usage
 
-The library has not been published yet to `crates.io`, and this will be the case
-until we reach a stable version. However, one can [specify a git dependency] in
-a `Cargo.toml`, like so:
+You can import OpenZeppelin Contracts from crates.io by adding the following
+line to your `Cargo.toml` (We recommend pinning to a specific version):
 
 ```toml
 [dependencies]
-openzeppelin-stylus = { git = "https://github.com/OpenZeppelin/rust-contracts-stylus" }
+openzeppelin-stylus = "0.1.0"
 ```
 
-We recommend pinning to a specific version -- expect rapid iteration.
+Optionally, you can specify a git dependency if you want to have the latest
+changes from the `main` branch:
+
+```toml
+[dependencies]
+openzeppelin-stylus = { git = "https://github.com/OpenZeppelin/rust-contracts-stylus" }
+```
 
 Once defined as a dependency, use one of our pre-defined implementations by
 importing them:
@@ -48,7 +48,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20)]
 impl Erc20Example { }
 ```
@@ -65,7 +65,7 @@ For more information on what this library will include in the future, see our
 [specify a git dependency]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories
 [examples]: ./examples
 [basic]: ./examples/basic
-[roadmap]: https://github.com/OpenZeppelin/rust-contracts-stylus/milestone/1
+[roadmap]: https://github.com/OpenZeppelin/rust-contracts-stylus/milestone/2
 
 ## Contribute
 
@@ -75,10 +75,7 @@ the [contribution guide](CONTRIBUTING.md)!
 
 ## Security
 
-> [!WARNING]
-> This project is still in a very early and experimental phase. It has never
-> been audited nor thoroughly reviewed for security vulnerabilities. Do not use
-> in production.
+Past audits can be found in [`audits/`](./audits).
 
 Refer to our [Security Policy](SECURITY.md) for more details.
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -1,8 +1,5 @@
 # Security
 
-> [!WARNING]
-> This project is still in a very early and experimental phase. It has never
-> been audited nor thoroughly reviewed for security vulnerabilities. Do not use
-> in production.
+Past audits can be found in [`audits/`](./audits).
 
 Please report any security issues you find to [email protected].
diff --git a/contracts/src/lib.rs b/contracts/src/lib.rs
@@ -6,10 +6,6 @@ A library for secure smart contract development written in Rust for
 This library offers common smart contract primitives and affordances that take
 advantage of the nature of Stylus.
 
-> This project is still in a very early and experimental phase. It has never
-> been audited nor thoroughly reviewed for security vulnerabilities. Do not use
-> in production.
-
 ## Usage
 
 To start using it, add `openzeppelin-stylus` to your `Cargo.toml`, or simply run
@@ -36,7 +32,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20)]
 impl MyContract { }
 ```

diff --git a/docs/modules/ROOT/pages/access-control.adoc b/docs/modules/ROOT/pages/access-control.adoc
@@ -21,7 +21,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Ownable)]
 impl MyContract {
  fn normal_thing(&self) {
@@ -90,7 +90,7 @@ pub const MINTER_ROLE: [u8; 32] = [
  166,
 ];
 
-#[external]
+#[public]
 #[inherit(Erc20, AccessControl)]
 impl Example {
  pub const MINTER_ROLE: [u8; 32] = MINTER_ROLE;
@@ -136,7 +136,7 @@ pub const BURNER_ROLE: [u8; 32] = [
  224, 87, 73, 143, 95, 0, 36, 97, 144, 234, 84, 34, 5, 118, 168, 72,
 ];
 
-#[external]
+#[public]
 #[inherit(Erc20, AccessControl)]
 impl Example {
  pub const MINTER_ROLE: [u8; 32] = MINTER_ROLE;

diff --git a/docs/modules/ROOT/pages/deploy.adoc b/docs/modules/ROOT/pages/deploy.adoc
@@ -37,7 +37,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 impl Counter {
  pub fn number(&self) -> U256 {
  self.number.get()

diff --git a/docs/modules/ROOT/pages/erc20-burnable.adoc b/docs/modules/ROOT/pages/erc20-burnable.adoc
@@ -24,7 +24,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20)]
 impl Erc20Example {
  pub fn burn(&mut self, value: U256) -> Result<(), Vec<u8>> {

diff --git a/docs/modules/ROOT/pages/erc20-capped.adoc b/docs/modules/ROOT/pages/erc20-capped.adoc
@@ -26,7 +26,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20, Capped)]
 impl Erc20Example {
  // Add token minting feature.

diff --git a/docs/modules/ROOT/pages/erc20-metadata.adoc b/docs/modules/ROOT/pages/erc20-metadata.adoc
@@ -26,7 +26,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20, Erc20Metadata, Capped, Pausable)]
 impl Erc20Example {
  // ...

diff --git a/docs/modules/ROOT/pages/erc20-pausable.adoc b/docs/modules/ROOT/pages/erc20-pausable.adoc
@@ -26,7 +26,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20, Pausable)]
 impl Erc20Example {
  pub fn burn(&mut self, value: U256) -> Result<(), Vec<u8>> {

diff --git a/docs/modules/ROOT/pages/erc20-permit.adoc b/docs/modules/ROOT/pages/erc20-permit.adoc
@@ -31,7 +31,7 @@ impl IEip712 for Eip712 {
  const VERSION: &'static str = "1";
 }
 
-#[external]
+#[public]
 #[inherit(Erc20Permit<Eip712>)]
 impl Erc20PermitExample {
  // ...

diff --git a/docs/modules/ROOT/pages/erc20.adoc b/docs/modules/ROOT/pages/erc20.adoc
@@ -25,7 +25,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc20, Erc20Metadata)]
 impl GLDToken {}
 ----

diff --git a/docs/modules/ROOT/pages/erc721-burnable.adoc b/docs/modules/ROOT/pages/erc721-burnable.adoc
@@ -24,7 +24,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721)]
 impl Erc721Example {
  pub fn burn(&mut self, token_id: U256) -> Result<(), Vec<u8>> {

diff --git a/docs/modules/ROOT/pages/erc721-consecutive.adoc b/docs/modules/ROOT/pages/erc721-consecutive.adoc
@@ -21,7 +21,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721Consecutive)]
 impl Erc721ConsecutiveExample {
  pub fn burn(&mut self, token_id: U256) -> Result<(), Error> {

diff --git a/docs/modules/ROOT/pages/erc721-enumerable.adoc b/docs/modules/ROOT/pages/erc721-enumerable.adoc
@@ -25,7 +25,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721, Erc721Enumerable)]
 impl Erc721Example {
  pub fn burn(&mut self, token_id: U256) -> Result<(), Vec<u8>> {

diff --git a/docs/modules/ROOT/pages/erc721-metadata.adoc b/docs/modules/ROOT/pages/erc721-metadata.adoc
@@ -26,7 +26,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721, Erc721Metadata)]
 impl Erc721Example {
  // ...

diff --git a/docs/modules/ROOT/pages/erc721-pausable.adoc b/docs/modules/ROOT/pages/erc721-pausable.adoc
@@ -26,7 +26,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721, Pausable)]
 impl Erc721Example {
  pub fn burn(&mut self, token_id: U256) -> Result<(), Vec<u8>> {

diff --git a/docs/modules/ROOT/pages/erc721-uri-storage.adoc b/docs/modules/ROOT/pages/erc721-uri-storage.adoc
@@ -33,7 +33,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721, Erc721Metadata, Erc721UriStorage)]
 impl Erc721MetadataExample {
  pub fn mint(&mut self, to: Address, token_id: U256) -> Result<(), Vec<u8>> {

diff --git a/docs/modules/ROOT/pages/erc721.adoc b/docs/modules/ROOT/pages/erc721.adoc
@@ -32,7 +32,7 @@ sol_storage! {
  }
 }
 
-#[external]
+#[public]
 #[inherit(Erc721, Metadata)]
 impl GameItem {
  pub fn award_item(