Skip to content

Commit 0afd95a

Browse files
peterwhtcmichi
andauthored
chore: update refs to Use Ink (#342)
* chore: update GitHub links to use-ink * chore: update email to [email protected] and org name * chore: update from Parity's ink! * chore: update contracts-ui links * fix: docusaurus field organizatioName to proper GitHub user * chore: update wording in all version of CosmWasm guide --------- Co-authored-by: Michael Müller <[email protected]>
1 parent 2508960 commit 0afd95a

File tree

100 files changed

+382
-382
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+382
-382
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `ink-docs`
22

3-
This is the documentation portal for [ink!](https://github.com/paritytech/ink). The latest version is always available at [https://use.ink](https://use.ink).
3+
This is the documentation portal for [ink!](https://github.com/use-ink/ink). The latest version is always available at [https://use.ink](https://use.ink).
44

55
Run it locally via
66

@@ -15,8 +15,8 @@ yarn start --locale es
1515
We want to provide comprehensive documentation for anything you need to work with ink! here.
1616

1717
If you spot gaps in the information provided, or are uncertain about any
18-
specific area, please do <a href="https://github.com/paritytech/ink-docs/issues">log an issue</a>
19-
or <a href="https://github.com/paritytech/ink-docs/pulls">make a pull-request</a>.
18+
specific area, please do <a href="https://github.com/use-ink/ink-docs/issues">log an issue</a>
19+
or <a href="https://github.com/use-ink/ink-docs/pulls">make a pull-request</a>.
2020

2121
We really want to have good documentation here and allow people to be productive
2222
right from the start.

docs/basics/cross-contract-calling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If you want to interact with a contract that is already on-chain you will need t
3434

3535
### `BasicContractRef` walkthrough
3636

37-
We will walk through the [`cross-contract-calls`](https://github.com/paritytech/ink-examples/tree/master/cross-contract-calls)
37+
We will walk through the [`cross-contract-calls`](https://github.com/use-ink/ink-examples/tree/master/cross-contract-calls)
3838
example in order to demonstrate how cross-contract calls using contract references work.
3939

4040
The general workflow will be:

docs/basics/environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Substrate types, you have to make sure to configure that chain's
1414
`Environment` for your contract!
1515
:::
1616

17-
ink! defines a trait [`Environment`](https://paritytech.github.io/ink/ink_env/trait.Environment.html)
18-
and also a default implementation of that trait ‒ [`DefaultEnvironment`](https://paritytech.github.io/ink/ink_env/enum.DefaultEnvironment.html).
17+
ink! defines a trait [`Environment`](https://use-ink.github.io/ink/ink_env/trait.Environment.html)
18+
and also a default implementation of that trait ‒ [`DefaultEnvironment`](https://use-ink.github.io/ink/ink_env/enum.DefaultEnvironment.html).
1919

2020
These are the types that ink! uses, if no explicit steps are taken:
2121

@@ -49,7 +49,7 @@ type as Ethereum for their `AccountId`.
4949

5050
Most Substrate chains stay with the default Substrate types though and
5151
ink! just uses those by default as well. It is possible to configure
52-
a different environment in the contract macro ([documentation here](https://paritytech.github.io/ink/ink/attr.contract.html#header-arguments))
52+
a different environment in the contract macro ([documentation here](https://use-ink.github.io/ink/ink/attr.contract.html#header-arguments))
5353
though:
5454

5555
```rust

docs/basics/events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ mod erc20 {
5757
}
5858
```
5959

60-
See our [`ERC20 example contract`](https://github.com/paritytech/ink-examples/blob/main/erc20/lib.rs)
60+
See our [`ERC20 example contract`](https://github.com/use-ink/ink-examples/blob/main/erc20/lib.rs)
6161
for an elaborate example which uses events.
6262

6363
## Event Definition
@@ -82,7 +82,7 @@ pub struct Transferred {
8282
amount: u128,
8383
}
8484
```
85-
> Note that generics are [not currently supported](https://github.com/paritytech/ink/issues/2044)
85+
> Note that generics are [not currently supported](https://github.com/use-ink/ink/issues/2044)
8686
> , so the concrete types of `Environment`
8787
> specific types such as `AccountId` must match up with the types used in the contract.
8888

docs/basics/metadata.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ It may _optionally_ include the following keys:
8787
:::info
8888

8989
If you're interested in the code reference from `cargo-contract`
90-
see [here](https://github.com/paritytech/cargo-contract/blob/30ba1ec545d01c0479fe47c97d2c8911ab868d46/crates/metadata/src/lib.rs#L157).
90+
see [here](https://github.com/use-ink/cargo-contract/blob/30ba1ec545d01c0479fe47c97d2c8911ab868d46/crates/metadata/src/lib.rs#L157).
9191

9292
:::
9393

@@ -111,15 +111,15 @@ It can _optionally_ include the following keys:
111111
"name": "flipper",
112112
"version": "4.0.0-beta.1",
113113
"authors": [
114-
"Parity Technologies <[email protected]>"
114+
"Use Ink <[email protected]>"
115115
]
116116
}
117117
```
118118

119119
:::info
120120

121121
If you're interested in the code reference from `cargo-contract`
122-
see [here](https://github.com/paritytech/cargo-contract/blob/30ba1ec545d01c0479fe47c97d2c8911ab868d46/crates/metadata/src/lib.rs#L432).
122+
see [here](https://github.com/use-ink/cargo-contract/blob/30ba1ec545d01c0479fe47c97d2c8911ab868d46/crates/metadata/src/lib.rs#L432).
123123

124124
:::
125125

@@ -149,7 +149,7 @@ The ink! metadata consists of the following **required** sections
149149
:::info
150150

151151
If you're interested in the code reference from `ink!`
152-
see [here](https://github.com/paritytech/ink/blob/c8aa3ee41112b327d4f3cb3959f188945c8ccace/crates/metadata/src/lib.rs#L90).
152+
see [here](https://github.com/use-ink/ink/blob/c8aa3ee41112b327d4f3cb3959f188945c8ccace/crates/metadata/src/lib.rs#L90).
153153

154154
:::
155155

docs/basics/trait-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Through the `#[ink::trait_definition]` proc. macro it is now possible to define
1111
This allows to define shared smart contract interfaces to different concrete implementations.
1212
Note that this ink! trait definition can be defined anywhere, even in another crate!
1313

14-
See our [`ERC20-Trait example contract`](https://github.com/paritytech/ink-examples/blob/main/trait-erc20/lib.rs)
14+
See our [`ERC20-Trait example contract`](https://github.com/use-ink/ink-examples/blob/main/trait-erc20/lib.rs)
1515
for an elaborate example which uses trait definitions.
1616

1717
### Example

docs/basics/upgradeability.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ self.env().lock_delegate_dependency(&code_hash);
278278

279279
Note that these two methods can be called by anybody executing the contract, so it is the
280280
responsibility of the contract developer to ensure correct access control.
281-
You can take a look at our [`upgradeable-contracts/delegator`](https://github.com/paritytech/ink-examples/tree/main/upgradeable-contracts#delegator)
281+
You can take a look at our [`upgradeable-contracts/delegator`](https://github.com/use-ink/ink-examples/tree/main/upgradeable-contracts#delegator)
282282
example, which demonstrates the usage of these two functions.
283283

284284
## Note on the usage of wildcard selectors
@@ -290,12 +290,12 @@ Since ink! 5 we have restricted the usage of the wildcard selector due to
290290
[security reasons](https://blog.openzeppelin.com/security-review-ink-cargo-contract#custom-selectors-could-facilitate-proxy-selector-clashing-attacks).
291291

292292
:::danger Beware
293-
Due to [IIP-2](https://github.com/paritytech/ink/issues/1676), ink! only allows
293+
Due to [IIP-2](https://github.com/use-ink/ink/issues/1676), ink! only allows
294294
to contain a single message with a well-known selector `@` when the other message
295295
with the wildcard selector `_` is defined.
296296
:::
297297

298-
See [example](https://github.com/paritytech/ink-examples/tree/main/wildcard-selector)
298+
See [example](https://github.com/use-ink/ink-examples/tree/main/wildcard-selector)
299299
for illustration on how it can be used in practice.
300300

301301
## Note on `CallFlags`
@@ -314,7 +314,7 @@ Some useful properties:
314314

315315
Following [Substrate's runtime upgradeability](https://docs.substrate.io/maintain/runtime-upgrades/)
316316
philosophy, ink! also supports an easy way to update your contract code via the special function
317-
[`set_code_hash()`](https://paritytech.github.io/ink/ink_env/fn.set_code_hash.html).
317+
[`set_code_hash()`](https://use-ink.github.io/ink/ink_env/fn.set_code_hash.html).
318318

319319
### Properties
320320

@@ -426,4 +426,4 @@ for more details.
426426
## Examples
427427

428428
Examples of upgradable contracts can be found in the
429-
[ink! repository](https://github.com/paritytech/ink-examples/tree/main/upgradeable-contracts).
429+
[ink! repository](https://github.com/use-ink/ink-examples/tree/main/upgradeable-contracts).

docs/basics/verification/contract-verification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ It should contain a key-value `image` after the `contract` information:
5555
"name": "flipper",
5656
"version": "4.3.0",
5757
"authors": [
58-
"Parity Technologies <[email protected]>"
58+
"Use Ink <[email protected]>"
5959
]
6060
},
6161
"image": "paritytech/contracts-verifiable:4.0.0-alpha",
@@ -118,4 +118,4 @@ of all contracts to be visible. Specify a relative manifest path to the root con
118118
:::
119119

120120
You can find a Dockerfile and further documentation on image usage
121-
in [the `cargo-contract` repository](https://github.com/paritytech/cargo-contract/tree/master/build-image)
121+
in [the `cargo-contract` repository](https://github.com/use-ink/cargo-contract/tree/master/build-image)

docs/brand-assets/cargo-contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hide_table_of_contents: true
66

77
## `cargo-contract` Logo
88

9-
The following is the logo for our command-line tool [`cargo-contract`](https://github.com/paritytech/cargo-contract).
9+
The following is the logo for our command-line tool [`cargo-contract`](https://github.com/use-ink/cargo-contract).
1010

1111
<div className="black-container">
1212
<img src="/img/cargo-contract-logo.svg" alt="cargo-contract logo" className="brand-asset" />

docs/brand-assets/community-badges.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,33 @@ if you could add one of those!
1010
## Built _with_ ink!
1111
### Normal Design
1212

13-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://github.com/paritytech/ink)
13+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/badge.svg)](https://github.com/use-ink/ink)
1414

1515
```markdown
16-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://github.com/paritytech/ink)
16+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/badge.svg)](https://github.com/use-ink/ink)
1717
```
1818

1919
### Flat Design
2020

21-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge_flat.svg)](https://github.com/paritytech/ink)
21+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/badge_flat.svg)](https://github.com/use-ink/ink)
2222

2323
```markdown
24-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge_flat.svg)](https://github.com/paritytech/ink)
24+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/badge_flat.svg)](https://github.com/use-ink/ink)
2525
```
2626

2727
## Built _for_ ink!
2828
### Normal Design
2929

30-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/built-for-ink.svg)](https://github.com/paritytech/ink)
30+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/built-for-ink.svg)](https://github.com/use-ink/ink)
3131

3232
```markdown
33-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/built-for-ink.svg)](https://github.com/paritytech/ink)
33+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/built-for-ink.svg)](https://github.com/use-ink/ink)
3434
```
3535

3636
### Flat Design
3737

38-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/built-for-ink-flat.svg)](https://github.com/paritytech/ink)
38+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/built-for-ink-flat.svg)](https://github.com/use-ink/ink)
3939

4040
```markdown
41-
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/built-for-ink-flat.svg)](https://github.com/paritytech/ink)
41+
[![Built with ink!](https://raw.githubusercontent.com/use-ink/ink/master/.images/built-for-ink-flat.svg)](https://github.com/use-ink/ink)
4242
```

docs/datastructures/storage-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ number of elements, instead.
6262
## Eager Loading vs. Lazy Loading
6363
ink! provides means of breaking the storage up into smaller pieces, which can be loaded
6464
on demand, with the
65-
[`Lazy`](https://paritytech.github.io/ink/ink/storage/struct.Lazy.html) primitive.
65+
[`Lazy`](https://use-ink.github.io/ink/ink/storage/struct.Lazy.html) primitive.
6666
Wrapping any storage field inside a `Lazy` struct makes the storage
6767
struct in which that field appears also
6868
non-`Packed`, preventing it from being eagerly loaded during arbitrary storage operations:

docs/datastructures/storagevec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ This can be undesirable:
8484
The cost of reading or writing a _single_ element grows linearly
8585
corresponding to the number of elements in the vector (its length).
8686
Additionally, the maximum capacity of the _whole_ vector is limited by
87-
the size of [ink!'s static buffer](https://github.com/paritytech/ink/blob/master/ARCHITECTURE.md#communication-with-the-pallet)
87+
the size of [ink!'s static buffer](https://github.com/use-ink/ink/blob/master/ARCHITECTURE.md#communication-with-the-pallet)
8888
used during ABI encoding and decoding (default 16 KiB).
8989

9090
`StorageVec` on the other hand allows to access each element individually.

docs/examples/contracts.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ hide_title: true
88

99
# Smart Contract Examples
1010

11-
We have a repository <a href="https://github.com/paritytech/ink-examples/tree/main">`ink-examples`</a>,
11+
We have a repository <a href="https://github.com/use-ink/ink-examples/tree/main">`ink-examples`</a>,
1212
in which you find a number of contracts written in ink!.
1313
Some of the most interesting ones:
1414

1515
<div className="row">
1616
<div className="col text--center">
17-
<a href="https://github.com/paritytech/ink-examples/tree/main/flipper"><img src="/img/icons/flipper.svg" width="100" /></a>
17+
<a href="https://github.com/use-ink/ink-examples/tree/main/flipper"><img src="/img/icons/flipper.svg" width="100" /></a>
1818
<p>
1919
Our "Hello, World!".<br/>
20-
<a href="https://github.com/paritytech/ink-examples/tree/main/flipper">» view example</a>
20+
<a href="https://github.com/use-ink/ink-examples/tree/main/flipper">» view example</a>
2121
</p>
2222
</div>
2323
<div className="col text--center">
24-
<a href="https://github.com/paritytech/ink-examples/tree/main/erc20"><img src="/img/icons/erc20.svg" width="100" /></a>
24+
<a href="https://github.com/use-ink/ink-examples/tree/main/erc20"><img src="/img/icons/erc20.svg" width="100" /></a>
2525
<p>
2626
An ERC-20 implementation.<br/>
27-
<a href="https://github.com/paritytech/ink-examples/tree/main/erc20">» view example</a>
27+
<a href="https://github.com/use-ink/ink-examples/tree/main/erc20">» view example</a>
2828
</p>
2929
</div>
3030
<div className="col text--center">
31-
<a href="https://github.com/paritytech/ink-examples/tree/main/erc721"><img src="/img/icons/nft.svg" width="100" /></a>
31+
<a href="https://github.com/use-ink/ink-examples/tree/main/erc721"><img src="/img/icons/nft.svg" width="100" /></a>
3232
<p>
33-
<a href="https://github.com/paritytech/ink-examples/tree/main/erc721">» view ERC-721</a>
33+
<a href="https://github.com/use-ink/ink-examples/tree/main/erc721">» view ERC-721</a>
3434
<br/>
35-
<a href="https://github.com/paritytech/ink-examples/tree/main/erc1155">» view ERC-1155</a>
35+
<a href="https://github.com/use-ink/ink-examples/tree/main/erc1155">» view ERC-1155</a>
3636
</p>
3737
</div>
3838
</div>
@@ -41,24 +41,24 @@ Some of the most interesting ones:
4141

4242
<div className="row">
4343
<div className="col text--center">
44-
<a href="https://github.com/paritytech/ink-examples/tree/main/upgradeable-contracts"><img src="/img/icons/upgradable.svg" width="100" /></a>
44+
<a href="https://github.com/use-ink/ink-examples/tree/main/upgradeable-contracts"><img src="/img/icons/upgradable.svg" width="100" /></a>
4545
<p>
4646
An upgradeable contract.<br/>
47-
<a href="https://github.com/paritytech/ink-examples/tree/main/upgradeable-contracts">» view example</a>
47+
<a href="https://github.com/use-ink/ink-examples/tree/main/upgradeable-contracts">» view example</a>
4848
</p>
4949
</div>
5050
<div className="col text--center">
51-
<a href="https://github.com/paritytech/ink-examples/tree/main/multisig"><img src="/img/icons/multisig.svg" width="100" /></a>
51+
<a href="https://github.com/use-ink/ink-examples/tree/main/multisig"><img src="/img/icons/multisig.svg" width="100" /></a>
5252
<p>
5353
A multi-signature wallet.<br/>
54-
<a href="https://github.com/paritytech/ink-examples/tree/main/multisig">» view example</a>
54+
<a href="https://github.com/use-ink/ink-examples/tree/main/multisig">» view example</a>
5555
</p>
5656
</div>
5757
<div className="col text--center">
58-
<a href="https://github.com/paritytech/ink-examples/tree/main/rand-extension"><img src="/img/icons/rand-extension.svg" width="100" /></a>
58+
<a href="https://github.com/use-ink/ink-examples/tree/main/rand-extension"><img src="/img/icons/rand-extension.svg" width="100" /></a>
5959
<p>
6060
Allow runtime access.<br/>
61-
<a href="https://github.com/paritytech/ink-examples/tree/main/rand-extension">» view example</a>
61+
<a href="https://github.com/use-ink/ink-examples/tree/main/rand-extension">» view example</a>
6262
</p>
6363
</div>
6464
</div>
@@ -67,24 +67,24 @@ Some of the most interesting ones:
6767

6868
<div className="row">
6969
<div className="col text--center">
70-
<a href="https://github.com/paritytech/ink-examples/tree/main/upgradeable-contracts/delegator"><img src="/img/icons/delegator.svg" width="100" /></a>
70+
<a href="https://github.com/use-ink/ink-examples/tree/main/upgradeable-contracts/delegator"><img src="/img/icons/delegator.svg" width="100" /></a>
7171
<p>
7272
Cross-contract calls.<br/>
73-
<a href="https://github.com/paritytech/ink-examples/tree/main/upgradeable-contracts/delegator">» view example</a>
73+
<a href="https://github.com/use-ink/ink-examples/tree/main/upgradeable-contracts/delegator">» view example</a>
7474
</p>
7575
</div>
7676
<div className="col text--center">
77-
<a href="https://github.com/paritytech/ink-examples/tree/main/trait-erc20"><img src="/img/icons/trait-erc20.svg" width="100" /></a>
77+
<a href="https://github.com/use-ink/ink-examples/tree/main/trait-erc20"><img src="/img/icons/trait-erc20.svg" width="100" /></a>
7878
<p>
7979
Implements an <code>Erc20</code> trait.<br/>
80-
<a href="https://github.com/paritytech/ink-examples/tree/main/trait-erc20">» view example</a>
80+
<a href="https://github.com/use-ink/ink-examples/tree/main/trait-erc20">» view example</a>
8181
</p>
8282
</div>
8383
<div className="col text--center">
84-
<a href="https://github.com/paritytech/ink-examples/tree/main/dns"><img src="/img/icons/dns.svg" width="100" /></a>
84+
<a href="https://github.com/use-ink/ink-examples/tree/main/dns"><img src="/img/icons/dns.svg" width="100" /></a>
8585
<p>
8686
Simple <code>DomainNameService</code>.<br/>
87-
<a href="https://github.com/paritytech/ink-examples/tree/main/dns">» view example</a>
87+
<a href="https://github.com/use-ink/ink-examples/tree/main/dns">» view example</a>
8888
</p>
8989
</div>
9090
</div>

docs/examples/dapps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ link! is a URL shortener dApp. It consists of a frontend and an ink! contract.
3232

3333
link! uses [`polkadot-js/api`](https://github.com/polkadot-js/api) under the hood.
3434
The entire source code (contract + frontend) is located here:
35-
[https://github.com/paritytech/link](https://github.com/paritytech/link).
35+
[https://github.com/use-ink/link](https://github.com/use-ink/link).
3636

3737
You can view an online demo of the dApp here: [https://tiny.ink](https://tiny.ink).
3838

0 commit comments

Comments
 (0)