Skip to content

Commit

Permalink
Fix versioned links (#2166)
Browse files Browse the repository at this point in the history
* Update links from 4.x to 5.x

* Link to 5.x branch instead of `main`

* Fix comment

* Fix comment style
  • Loading branch information
cmichi committed Mar 19, 2024
1 parent 2713674 commit d16ad5f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ mod flipper {
}
}
```
The [`flipper/src/lib.rs`](https://github.com/paritytech/ink-examples/blob/v4.0.1/flipper/lib.rs)
The [`flipper/src/lib.rs`](https://github.com/paritytech/ink-examples/blob/v5.x.x/flipper/lib.rs)
file in our examples folder contains exactly this code. Run `cargo contract build` to build your
first ink! smart contract.

Expand Down Expand Up @@ -243,11 +243,11 @@ See [here](https://paritytech.github.io/ink/ink/attr.contract.html) for a more d
### Trait Definitions

Use `#[ink::trait_definition]` to define your very own trait definitions that are then implementable by ink! smart contracts.
See e.g. the [`examples/trait-erc20`](https://github.com/paritytech/ink-examples/blob/v4.0.1/trait-erc20/lib.rs#L20-L22) contract on how to utilize it or [the documentation](https://paritytech.github.io/ink/ink/attr.trait_definition.html) for details.
See e.g. the [`examples/trait-erc20`](https://github.com/paritytech/ink-examples/blob/v5.x.x/trait-erc20/lib.rs#L20-L22) contract on how to utilize it or [the documentation](https://paritytech.github.io/ink/ink/attr.trait_definition.html) for details.

### Off-chain Testing

The `#[ink::test]` procedural macro enables off-chain testing. See e.g. the [`examples/erc20`](https://github.com/paritytech/ink-examples/blob/v4.0.1/erc20/lib.rs#L276-L277) contract on how to utilize those or [the documentation](https://paritytech.github.io/ink/ink/attr.test.html) for details.
The `#[ink::test]` procedural macro enables off-chain testing. See e.g. the [`examples/erc20`](https://github.com/paritytech/ink-examples/blob/v5.x.x/erc20/lib.rs#L276-L277) contract on how to utilize those or [the documentation](https://paritytech.github.io/ink/ink/attr.test.html) for details.

## Developer Documentation

Expand Down
3 changes: 2 additions & 1 deletion crates/env/src/engine/off_chain/test_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ pub fn recorded_events() -> impl Iterator<Item = EmittedEvent> {
/// remaining value in the contract
/// * `expected_value_transferred_to_beneficiary`: The value which should have been
/// transferred to the `expected_beneficiary`.
///
/// # Usage
///
/// ```no_compile
Expand All @@ -395,7 +396,7 @@ pub fn recorded_events() -> impl Iterator<Item = EmittedEvent> {
/// );
/// ```
///
/// See our [`contract-terminate`](https://github.com/paritytech/ink-examples/tree/main/contract-terminate)
/// See our [`contract-terminate`](https://github.com/paritytech/ink-examples/tree/v5.x.x/contract-terminate)
/// example for a complete usage exemplification.
pub fn assert_contract_termination<T, F>(
should_terminate: F,
Expand Down
2 changes: 1 addition & 1 deletion crates/metadata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The ink! metadata is used to describe a contracts properties in a platform indep
way. To learn more about it see [the section in the ink! docs](http://use.ink/basics/metadata).

__Note:__ The metadata version is independent of the ink! version!
The version 3 of the metadata which is described here is also valid for ink! v4.
The version 4 of the metadata which is described here is used in ink! v5.

## Metadata JSON Schema

Expand Down

0 comments on commit d16ad5f

Please sign in to comment.