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

update docs #2

Merged
merged 1 commit into from
Dec 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ exclude = [
[package]
name = "openbrush"
version = "3.0.0-beta"
authors = ["Supercolony <green.baneling@supercolony.net>"]
authors = ["Brushfam <green@727.ventures>"]
edition = "2018"

license = "MIT"
readme = "README.md"
repository = "https://github.com/Supercolony-net/openbrush-contracts"
repository = "https://github.com/727-Ventures/openbrush-contracts"
documentation = "https://docs.openbrush.io"
homepage = "https://supercolony.net"
homepage = "https://727.ventures"
description = "OpenBrush library for smart contract development on ink!."
keywords = ["wasm", "supercolony", "smart-contracts", "blockchain", "ink"]
keywords = ["wasm", "brushfam", "smart-contracts", "blockchain", "ink"]
categories = ["no-std", "embedded"]
include = ["Cargo.toml", "src/**/*.rs"]

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
<img src="https://user-images.githubusercontent.com/18346821/183483033-2cd46f58-7c29-4cd8-ad1c-b633f9673e13.png"/>
</p>

[![Docs](https://img.shields.io/badge/docs-%F0%9F%93%84-blue)](https://supercolony-net.github.io/openbrush-contracts)
[![Docs](https://img.shields.io/badge/docs-%F0%9F%93%84-blue)](https://727-Ventures.github.io/openbrush-contracts)
[![telegram chat](https://img.shields.io/badge/Telegram-blue.svg?style=flat-square)](https://t.me/openbrush)
[![element chat](https://img.shields.io/badge/Element-green.svg?style=flat-square)](https://matrix.to/#/!utTuYglskDvqRRMQta:matrix.org?via=matrix.org&via=t2bot.io&via=matrix.parity.io)
[![discord chat](https://img.shields.io/badge/Discord-purple.svg?style=flat-square)](https://discord.gg/ZGdpEwFrJ8)

OpenBrush was created by [Supercolony](supercolony.net) to make ink! development faster, safer and easier. We plan to integrate most of the features
OpenBrush was created by [Brushfam](727.ventures) to make ink! development faster, safer and easier. We plan to integrate most of the features
OpenBrush into ink!. OpenBrush provides documentation with FAQ section.

You can ask questions regarding ink! development on Element, Discord, or Telegram OpenBrush channels by the links above.
Expand Down Expand Up @@ -104,13 +104,13 @@ The callee contract should implement that trait.

### Additional stuff

- You can use [`test_utils`](https://github.com/Supercolony-net/openbrush-contracts/blob/main/lang/src/test_utils.rs#L39)
- You can use [`test_utils`](https://github.com/727-Ventures/openbrush-contracts/blob/main/lang/src/test_utils.rs#L39)
to simplify unit testing of you code.
- You can use [`traits`](https://github.com/Supercolony-net/openbrush-contracts/blob/main/lang/src/traits.rs) that provides some additional
- You can use [`traits`](https://github.com/727-Ventures/openbrush-contracts/blob/main/lang/src/traits.rs) that provides some additional
functionality for your code.
- Read our **documentation** in [doc](https://supercolony-net.github.io/openbrush-contracts).
- Read our **documentation** in [doc](https://727-Ventures.github.io/openbrush-contracts).
- Go through our **examples** in [examples](examples) to check hot to use the library and ink!.
- Check the [**example of project struct**](https://github.com/Supercolony-net/openbrush-contracts/tree/main/example_project_structure) and [according documentation](https://docs.openbrush.io/smart-contracts/example/overview).
- Check the [**example of project struct**](https://github.com/727-Ventures/openbrush-contracts/tree/main/example_project_structure) and [according documentation](https://docs.openbrush.io/smart-contracts/example/overview).

Not sure where to start? Use [the interactive generator](https://openbrush.io) to bootstrap your contract and learn about the components offered in OpenBrush.

Expand All @@ -121,14 +121,14 @@ The identifiers of events must be based on the name of the trait. At the moment,
but it must be fixed with this [issue](https://github.com/paritytech/ink/issues/809).

### Issues to be resolved before the library becomes production-ready:
* [Standard token naming convention](https://github.com/Supercolony-net/openbrush-contracts/issues/1)
* [Event's identifiers are based on the naming of the storage structure](https://github.com/Supercolony-net/openbrush-contracts/issues/2)
* [Standard token naming convention](https://github.com/727-Ventures/openbrush-contracts/issues/1)
* [Event's identifiers are based on the naming of the storage structure](https://github.com/727-Ventures/openbrush-contracts/issues/2)

### Other Issues open:

* [#[ink::trait_definition] doesn't support generics and default implementation](https://github.com/Supercolony-net/openbrush-contracts/issues/4)
* [Library provides implementation in Rust level instead of ink! level](https://github.com/Supercolony-net/openbrush-contracts/issues/5)
* [List of issues, solving each of them can simplify usage of library](https://github.com/Supercolony-net/openbrush-contracts/issues/8)
* [#[ink::trait_definition] doesn't support generics and default implementation](https://github.com/727-Ventures/openbrush-contracts/issues/4)
* [Library provides implementation in Rust level instead of ink! level](https://github.com/727-Ventures/openbrush-contracts/issues/5)
* [List of issues, solving each of them can simplify usage of library](https://github.com/727-Ventures/openbrush-contracts/issues/8)
* After [Storage rework](https://github.com/paritytech/ink/pull/1217) we need to refactor upgradeable contracts.

## Roadmap 🚗
Expand Down
8 changes: 4 additions & 4 deletions contracts/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[package]
name = "openbrush_contracts"
version = "3.0.0-beta"
authors = ["Supercolony <green.baneling@supercolony.net>"]
authors = ["Brushfam <green@727.ventures>"]
edition = "2021"

license = "MIT"
readme = "README.md"
repository = "https://github.com/Supercolony-net/openbrush-contracts"
repository = "https://github.com/727-Ventures/openbrush-contracts"
documentation = "https://docs.openbrush.io"
homepage = "https://supercolony.net"
homepage = "https://727.ventures"
description = "Reusable implementations of contracts and traits for interaction with them."
keywords = ["wasm", "supercolony", "smart-contracts", "blockchain", "ink"]
keywords = ["wasm", "brushfam", "smart-contracts", "blockchain", "ink"]
categories = ["no-std", "embedded"]
include = ["Cargo.toml", "src/**/*.rs"]

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The list of standalone blockchain/parachains that support ink! smart contracts:

### Overview

- To deploy contract you should build your own contract or get some example from [Openbrush](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples). You can find instruction how to build ink! smart contract in [docs](https://ink.substrate.io/getting-started/building-your-contract)
- To deploy contract you should build your own contract or get some example from [Openbrush](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples). You can find instruction how to build ink! smart contract in [docs](https://ink.substrate.io/getting-started/building-your-contract)
- You have to choose substrate network to deploy your contract.
There are several option you have:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: PSP22 Burnable
---

This example shows how you can reuse the implementation of
[PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) token with [PSP22Burnable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet/extensions/burnable.rs) extension via `pallet-assets` chain extension.
[PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) token with [PSP22Burnable](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet/extensions/burnable.rs) extension via `pallet-assets` chain extension.

## How to use this extension

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 1
title: PSP22 Metadata
---

This example shows how you can reuse the implementation of [PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) token with the [PSP22Metadata](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet/extensions/metadata.rs) extension via `pallet-assets` chain extension.
This example shows how you can reuse the implementation of [PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) token with the [PSP22Metadata](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet/extensions/metadata.rs) extension via `pallet-assets` chain extension.

First, you should implement basic version of [PSP22 Pallet](/smart-contracts/PSP22-Pallet).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: PSP22 Mintable
---

This example shows how you can reuse the implementation of
[PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) token with [PSP22Mintable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet/extensions/mintable.rs) extension via `pallet-assets` chain extension.
[PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) token with [PSP22Mintable](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet/extensions/mintable.rs) extension via `pallet-assets` chain extension.

## How to use this extension

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22-Pallet/psp22-pallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 9
title: PSP22 Pallet
---

This example shows how you can reuse the implementation of [PSP22 Pallet](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) via `pallet-assets` chain extension. Also, this example shows how you can customize the logic, for example, to get current `asset_id`.
This example shows how you can reuse the implementation of [PSP22 Pallet](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22_pallet) via `pallet-assets` chain extension. Also, this example shows how you can customize the logic, for example, to get current `asset_id`.

## Step 1: Import default implementation

Expand Down Expand Up @@ -91,7 +91,7 @@ pub mod my_psp22_pallet {

```

You can check an example of the usage of [PSP22 Pallet](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_pallet).
You can check an example of the usage of [PSP22 Pallet](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_pallet).

Also you can use extensions for PSP22 token:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/burnable.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: PSP22 Burnable
---

This example shows how you can reuse the implementation of
[PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22Burnable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/burnable.rs) extension.
[PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22Burnable](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/burnable.rs) extension.

## How to use this extension

Expand All @@ -23,4 +23,4 @@ impl PSP22Burnable for Contract {}
```

And that's it! Your `PSP22` is now extended by the `PSP22Burnable` extension and ready to use its functions!
You can check an example of the usage of [PSP22 Burnable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/burnable).
You can check an example of the usage of [PSP22 Burnable](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/burnable).
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/capped.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 7
title: PSP22 Capped
---

This example shows how you can reuse the implementation of [PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) token with the [PSP22Capped](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/capped.rs) extension.
This example shows how you can reuse the implementation of [PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) token with the [PSP22Capped](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/capped.rs) extension.

First, you should implement basic version of [PSP22](/smart-contracts/PSP22).

Expand Down Expand Up @@ -129,6 +129,6 @@ pub mod my_psp22 {
}
```

You can check an implementation example of [PSP22 Capped](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/capped).
You can check an implementation example of [PSP22 Capped](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/capped).

You can also check the documentation for the basic implementation of [PSP22](/smart-contracts/PSP22).
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/flashmint.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 5
title: PSP22 FlashMint
---

This example shows how you can reuse the implementation of [PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22FlashMint](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/flashmint.rs) extension, which allows the user to perform a flash loan on the token by minting the borrowed amount and then burning it along with fees for the loan.
This example shows how you can reuse the implementation of [PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22FlashMint](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/flashmint.rs) extension, which allows the user to perform a flash loan on the token by minting the borrowed amount and then burning it along with fees for the loan.

## 1. Implement the FlashMint extension

Expand All @@ -22,4 +22,4 @@ impl FlashLender for Contract {}
```

And that's it! Your `PSP22` is now extended by the `PSP22FlashMint` extension and ready to use its functions!
You can check the full example of the implementation of this extension [here](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/flashmint).
You can check the full example of the implementation of this extension [here](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/flashmint).
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 1
title: PSP22 Metadata
---

This example shows how you can reuse the implementation of [PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) token with the [PSP22Metadata](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/metadata.rs) extension.
This example shows how you can reuse the implementation of [PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) token with the [PSP22Metadata](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/metadata.rs) extension.

First, you should implement basic version of [PSP22](/smart-contracts/PSP22).

Expand Down Expand Up @@ -117,6 +117,6 @@ pub mod my_psp22 {
}
```

You can check an example of the usage of [PSP22 Metadata](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/metadata).
You can check an example of the usage of [PSP22 Metadata](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/metadata).

You can also check the documentation for the basic implementation of [PSP22](/smart-contracts/PSP22).
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/mintable.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: PSP22 Mintable
---

This example shows how you can reuse the implementation of
[PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22Mintable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/mintable.rs) extension.
[PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22Mintable](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/mintable.rs) extension.

## How to use this extension

Expand All @@ -22,6 +22,6 @@ use openbrush::contracts::psp22::extensions::mintable::*;
impl PSP22Mintable for Contract {}
```

You can check an example of the usage of [PSP22 Mintable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/mintable).
You can check an example of the usage of [PSP22 Mintable](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/mintable).

And that's it! Your `PSP22` is now extended by the `PSP22Mintable` extension and ready to use its functions!
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/pausable.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 6
title: PSP22 Pausable
---

This example shows how you can implement a [PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) contract with a [Pausable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/security/pausable) extension. See an example of [PSP22Pausable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/pausable) implementation.
This example shows how you can implement a [PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) contract with a [Pausable](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/security/pausable) extension. See an example of [PSP22Pausable](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/pausable) implementation.

First, you should implement basic version of [PSP22](/smart-contracts/PSP22).

Expand Down Expand Up @@ -145,6 +145,6 @@ pub mod my_psp22_pausable {
}
```

You can check an implementation example of [PSP22 Pausable](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/pausable).
You can check an implementation example of [PSP22 Pausable](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/pausable).

You can also check the documentation for the basic implementation of [PSP22](/smart-contracts/PSP22).
4 changes: 2 additions & 2 deletions docs/docs/smart-contracts/PSP22/Extensions/wrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 4
title: PSP22 Wrapper
---

This example shows how you can reuse the implementation of [PSP22](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22 Wrapper](https://github.com/Supercolony-net/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/wrapper.rs) extension, which allows you to wrap your `PSP22` token in a `PSP22Wrapper` token which can be used for example for governance.
This example shows how you can reuse the implementation of [PSP22](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22) token with [PSP22 Wrapper](https://github.com/727-Ventures/openbrush-contracts/tree/main/contracts/src/token/psp22/extensions/wrapper.rs) extension, which allows you to wrap your `PSP22` token in a `PSP22Wrapper` token which can be used for example for governance.

First, you should implement basic version of [PSP22](/smart-contracts/PSP22).

Expand Down Expand Up @@ -113,6 +113,6 @@ pub mod my_psp22_wrapper {
}
```

You can check an example of the usage of [PSP22 Wrapper](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22_extensions/wrapper).
You can check an example of the usage of [PSP22 Wrapper](https://github.com/727-Ventures/openbrush-contracts/tree/main/examples/psp22_extensions/wrapper).

You can also check the documentation for the basic implementation of [PSP22](/smart-contracts/PSP22).
Loading