-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(devx): Add versioning. Switched to absolute imports everywhere, …
…added a devnet docs folder, and a version switcher.
- Loading branch information
1 parent
5ede929
commit 04382ed
Showing
379 changed files
with
43,884 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/content/about-iota/iota-architecture/protocol-upgrades.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/content/about-iota/iota-architecture/transaction-lifecycle.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
docs/site/versioned_docs/version-devnet/_snippets/address-prefix.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
You can pass literal addresses and objects IDs by prefixing them with '@'. This is needed to distinguish a hexadecimal value from an address in some situations. | ||
|
||
For addresses that are in your local wallet, you can use their alias instead (passing them without '@', for example, --transfer-objects my_alias). |
5 changes: 5 additions & 0 deletions
5
docs/site/versioned_docs/version-devnet/_snippets/app-examples-swap-source.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
:::info | ||
|
||
You can view the [complete source code for this app example](https://github.com/iotaledger/iota/tree/develop/examples/trading) in the IOTA repository. | ||
|
||
::: |
6 changes: 6 additions & 0 deletions
6
docs/site/versioned_docs/version-devnet/_snippets/automated-address-management.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
:::tip Automated Address Management | ||
|
||
IOTA supports [Automated Address Management](../developer/iota-101/move-overview/package-upgrades/automated-address-management.mdx), | ||
with which addresses will automatically be updated in the `Move.lock` file. | ||
|
||
::: |
11 changes: 11 additions & 0 deletions
11
docs/site/versioned_docs/version-devnet/_snippets/cli-check-install.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
## Check IOTA CLI installation | ||
|
||
Before you can use the IOTA CLI, you must install it. To check if the CLI exists on your system, open a terminal or console and type the following command: | ||
|
||
```shell | ||
iota --version | ||
``` | ||
|
||
If the terminal or console responds with a version number, you already have the IOTA CLI installed. | ||
|
||
If the command is not found, follow the instructions in [Install IOTA](/developer/getting-started/install-iota.mdx) to get the IOTA CLI on your system. |
8 changes: 8 additions & 0 deletions
8
docs/site/versioned_docs/version-devnet/_snippets/data-wipe.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
|
||
:::danger Data persistence is not guaranteed on the Testnet and Devnet | ||
|
||
Devnet data is wiped regularly as part of scheduled software updates. | ||
|
||
The data on Testnet persists through the regular update process, but might be wiped when necessary. Testnet data wipes are announced ahead of time. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
:::info | ||
|
||
Faucets on Devnet and Testnet are rate limited. If you run the script too many times, you | ||
surpass the limit and must wait to successfully run it again. | ||
|
||
::: |
7 changes: 7 additions & 0 deletions
7
docs/site/versioned_docs/version-devnet/_snippets/info-high-traffic.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
:::info | ||
|
||
It is suggested to use dedicated nodes/shared services rather than public endpoints for production apps with high traffic volume. | ||
|
||
You can either run your own Full nodes, or outsource this to a professional infrastructure provider (preferred for apps that have high traffic). | ||
|
||
::: |
5 changes: 5 additions & 0 deletions
5
docs/site/versioned_docs/version-devnet/_snippets/info-pnpm-required.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
:::info | ||
|
||
You must use the pnpm or yarn package managers to create IOTA project scaffolds. Follow the [pnpm install](https://pnpm.io/installation) or [yarn install](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) instructions, if needed. | ||
|
||
::: |
26 changes: 26 additions & 0 deletions
26
docs/site/versioned_docs/version-devnet/_snippets/initialize-iota-client-cli.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
:::info | ||
|
||
See [Publish a Package](../developer/getting-started/publish.mdx) for a more detailed guide on publishing packages or [IOTA Client CLI](/references/cli/client.mdx) for a complete reference of `client` commands in the IOTA CLI. | ||
|
||
::: | ||
|
||
Before publishing your code, you must first initialize the IOTA Client CLI, if you haven't already. To do so, in a terminal or console at the root directory of the project enter `iota client`. If you receive the following response, complete the remaining instructions: | ||
|
||
``` | ||
Config file ["<FILE-PATH>/.iota/iota_config/client.yaml"] doesn't exist, do you want to connect to a IOTA Full node server [y/N]? | ||
``` | ||
|
||
Enter `y` to proceed. You receive the following response: | ||
|
||
``` | ||
IOTA Full node server URL (Defaults to IOTA Devnet if not specified) : | ||
``` | ||
|
||
Leave this blank (press Enter). You receive the following response: | ||
|
||
``` | ||
Select key scheme to generate keypair (0 for ed25519, 1 for secp256k1, 2: for secp256r1): | ||
``` | ||
|
||
Select `0`. Now you should have a IOTA address set up. | ||
|
14 changes: 14 additions & 0 deletions
14
...ersioned_docs/version-devnet/_snippets/iota-evm/EVM-required-prior-knowledge.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
:::note Required Prior Knowledge | ||
|
||
This guide assumes you are familiar with the concept | ||
of [tokens](https://en.wikipedia.org/wiki/Cryptocurrency#Crypto_token) | ||
in [blockchain](https://en.wikipedia.org/wiki/Blockchain), | ||
[Ethereum Request for Comments (ERCs)](https://eips.ethereum.org/erc)(also known as Ethereum Improvement Proposals ( | ||
EIP)) | ||
, NFTs, Smart Contracts | ||
and have already tinkered with [Solidity](https://docs.soliditylang.org/en/v0.8.16/). | ||
|
||
You should also have basic knowledge on how to [create](../../developer/iota-evm/how-tos/create-a-basic-contract.mdx) and [deploy](../../developer/iota-evm/how-tos/deploy-a-smart-contract.mdx) | ||
a smart contract. | ||
|
||
::: |
7 changes: 7 additions & 0 deletions
7
docs/site/versioned_docs/version-devnet/_snippets/iota-evm/EVM_compatibility.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
:::info EVM Compatibility | ||
|
||
The ISC EVM layer is also designed to be as compatible as possible with existing Ethereum | ||
[tools](../../developer/iota-evm/getting-started/tools.mdx) and functionalities. However, please make sure you have checked out the current | ||
[properties and limitations](../../developer/iota-evm/getting-started/compatibility.md). | ||
|
||
::: |
5 changes: 5 additions & 0 deletions
5
docs/site/versioned_docs/version-devnet/_snippets/iota-evm/about-accounts.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
:::info Accounts in ISC | ||
|
||
Learn more about the [different types of accounts](../../developer/iota-evm/explanations/how-accounts-work.md). | ||
|
||
::: |
5 changes: 5 additions & 0 deletions
5
...ite/versioned_docs/version-devnet/_snippets/iota-evm/deploy_a_smart_contract.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
:::tip Deploy a Smart Contract | ||
|
||
Deploy a Solidity Smart Contract following our [how to Deploy a Smart Contract guide](../../developer/iota-evm/how-tos/deploy-a-smart-contract.mdx). | ||
|
||
::: |
Oops, something went wrong.