From b8a8cf025ed4d53de439366af9c095e5ce7997cb Mon Sep 17 00:00:00 2001 From: Kumar Anirudha Date: Mon, 4 Sep 2023 10:12:10 +0530 Subject: [PATCH 01/21] added docs for alias output. [wip] output pending. --- .../1.0.0/docs/how-tos/alias/create.mdx | 126 ++++++++++++++++++ .../1.0.0/docs/how-tos/alias/destroy.mdx | 124 +++++++++++++++++ docs/build/iota-sdk/1.0.0/sidebars.js | 10 ++ 3 files changed, 260 insertions(+) create mode 100644 docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx create mode 100644 docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx new file mode 100644 index 00000000000..0d61ad30d92 --- /dev/null +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -0,0 +1,126 @@ +--- +title: Create Alias Output +description: 'How to programmatically create an alias output' +image: /img/logo/iota_mark_light.png +keywords: + - how to + - create + - alias + - output + - nodejs + - python + - rust +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The Alias Output is a specific implementation of a UTXO state machine. Alias ID, the unique identifier of an instance of the deployed state machine, is generated deterministically by the protocol and is not allowed to change in any future state transitions. + +Alias Output represents an alias account in the ledger with two control levels and a permanentAlias Address. The account owns other outputs that are locked under Alias Address. The account keeps track of state transitions (`State Index` counter), controlled foundries (`Foundry Counter`) and anchors the layer 2 state as metadata into the UTXO ledger. + +## Example Code + + + + +The following example will: + +1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was + [created in the first guide](../accounts-and-addresses/create-account.mdx). +2. Create an alias output transaction by calling the [`Account.create_alias_output()`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.CreateAliasParams.html) function. + +
+ +```rust reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/create.rs#L40 +``` + +
+ +3. Retry transaction until included [`Transaction`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.retry_transaction_until_included) that was sent. + +
+ +```rust reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/create.rs#L43 +``` + +
+ + + + +The following example will: + +1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was + [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). +2. Create an alias output transaction by calling the [`Account.prepareCreateAliasOutput()`](../../references/nodejs/classes/Account.md#preparecreatealiasoutput) function. + +
+ +```typescript reference + https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/create.ts#L53 +``` + +
+ +3. Retry transaction until included [`Transaction`](../../references/nodejs/classes/Account/#retrytransactionuntilincluded) that was sent. + +
+ +```typescript reference +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/create.ts#L60 +``` + +
+ + + + +1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was + [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). +2. Create an alias output transaction by calling the [`Account.prepareCreateAliasOutput()`](../../references/python/iota_sdk/wallet/account.md#prepare_create_alias_output) function. + +
+ +```python reference +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how_tos/alias/create.py#L22 +``` + +
+ + + + +### Full Example Code + + + + +```rust reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias_wallet/request_funds.rs +``` + + + + +```typescript reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/create.rs +``` + + + + +```python reference +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how_tos/alias/create.py +``` + + + + +### Expected Output + +```plaintext +... +``` diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx new file mode 100644 index 00000000000..66eba6ceee5 --- /dev/null +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -0,0 +1,124 @@ +--- +title: Destroy Alias Output +description: 'How to programmatically destroy an alias output' +image: /img/logo/iota_mark_light.png +keywords: + - how to + - destroy + - alias + - output + - nodejs + - python + - rust +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +You can destroy an alias output by ID. If the alias still owns any outputs when you try to destroy it, you will get an error. + +## Example Code + + + + +The following example will: + +1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was + [created in the first guide](../accounts-and-addresses/create-account.mdx). +2. Destroy an alias output transaction by calling the [`Account.burn()`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.burn) function. + +
+ +```rust reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/destroy.rs#L44 +``` + +
+ +3. Retry transaction until included [`Transaction`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.retry_transaction_until_included) that was sent. + +
+ +```rust reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/destroy.rs#L47 +``` + +
+ + + + +The following example will: + +1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was + [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). +2. Destroy an alias output transaction by calling the [`Account.preparedestroyalias()`](../../references/nodejs/classes/Account.md#preparedestroyalias) function. + +
+ +```typescript reference + https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/destroy.ts#L56 +``` + +
+ +3. Retry transaction until included [`Transaction`](../../references/nodejs/classes/Account/#retrytransactionuntilincluded) that was sent. + +
+ +```typescript reference +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/destroy.ts#L63 +``` + +
+ + + + +1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was + [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). +2. Destroy an alias output transaction by calling the [`Account.prepare_destroy_alias()`](../../references/python/iota_sdk/wallet/account.md#prepare_destroy_alias) function. + +
+ +```python reference +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how_tos/alias/destroy.py#L25 +``` + +
+ + + + +### Full Example Code + + + + +```rust reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias_wallet/destroy.rs +``` + + + + +```typescript reference +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/destroy.rs +``` + + + + +```python reference +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how_tos/alias/destroy.py +``` + + + + +### Expected Output + +```plaintext +... +``` diff --git a/docs/build/iota-sdk/1.0.0/sidebars.js b/docs/build/iota-sdk/1.0.0/sidebars.js index a5a11822263..0972a123011 100644 --- a/docs/build/iota-sdk/1.0.0/sidebars.js +++ b/docs/build/iota-sdk/1.0.0/sidebars.js @@ -155,6 +155,16 @@ module.exports = { }, ], }, + { + type: 'category', + label: 'Alias Outputs', + items: [ + { + type: 'autogenerated', + dirName: 'how-tos/alias', + }, + ], + }, { type: 'category', label: 'Advanced Transactions', From dbaaac9b13f915a185894596d5d2cf227cf70b94 Mon Sep 17 00:00:00 2001 From: Kumar Anirudha Date: Mon, 4 Sep 2023 15:51:12 +0530 Subject: [PATCH 02/21] outputs updated --- .../iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 12 +++++++++++- .../iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 13 ++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 0d61ad30d92..6bbe520ef80 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -122,5 +122,15 @@ https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how ### Expected Output ```plaintext -... +Aliases BEFORE (141): +[ + ... +] +Sending the create-alias transaction... +Transaction sent: 0x7ce05ab09bc562c7b383067b774edd780e3a9235e9c76a5cccabdd9744b6a719 +Transaction included: https://explorer.shimmer.network/testnet/block/0x603c0e010b4e7665913c04729aad692a1c7557234185e98c821e1142fa49823d +Aliases AFTER (142): +[ + ... +] ``` diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 66eba6ceee5..262834779c2 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -120,5 +120,16 @@ https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how ### Expected Output ```plaintext -... +Aliases BEFORE destroying (142): + [ + ... +] +Sending the destroy-alias transaction... +Transaction sent: 0x829a635a7edc28bee4d4a1019b7b1f1bedec11d83c118b6f2a7904590f4bb458 +Block included: https://explorer.shimmer.network/testnet/block/0xd455b8132c0b109dd0b2d1d157c6b1d7275318f69dcf56f536a7b14d9fa17bb3 +Destroyed alias 0xf708a29e9619e847916de76c2e167e87a704c235dcbd7cda018865be7f561b5a +Aliases AFTER destroying (141): + [ + ... +] ``` From c7330a4ba43a87faeef502ca24f9c4edef20c353 Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Mon, 4 Sep 2023 22:32:01 +0200 Subject: [PATCH 03/21] Fix broken urls --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 6bbe520ef80..41be9ec63ea 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -65,7 +65,7 @@ The following example will: -3. Retry transaction until included [`Transaction`](../../references/nodejs/classes/Account/#retrytransactionuntilincluded) that was sent. +3. Retry transaction until included [`Transaction`](../../references/nodejs/classes/Account.md#retrytransactionuntilincluded) that was sent.
diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 262834779c2..dd50d9ca197 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -63,7 +63,7 @@ The following example will:
-3. Retry transaction until included [`Transaction`](../../references/nodejs/classes/Account/#retrytransactionuntilincluded) that was sent. +3. Retry transaction until included [`Transaction`](../../references/nodejs/classes/Account.md#retrytransactionuntilincluded) that was sent.
From 64e907847da8598fcab0b5bdb28971389bf75e00 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:34:53 +0530 Subject: [PATCH 04/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 41be9ec63ea..430d715fe8f 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -15,7 +15,7 @@ keywords: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -The Alias Output is a specific implementation of a UTXO state machine. Alias ID, the unique identifier of an instance of the deployed state machine, is generated deterministically by the protocol and is not allowed to change in any future state transitions. +An [Alias Output](https://wiki.iota.org/tips/tips/TIP-0018/#alias-output) is a specific implementation of a UTXO state machine. The Alias ID, the unique identifier of an instance of the deployed state machine, is generated deterministically by the protocol and is not allowed to change in future state transitions. Alias Output represents an alias account in the ledger with two control levels and a permanentAlias Address. The account owns other outputs that are locked under Alias Address. The account keeps track of state transitions (`State Index` counter), controlled foundries (`Foundry Counter`) and anchors the layer 2 state as metadata into the UTXO ledger. From d18c35384a70fec05751834ec75f2b6c9833e1a7 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:01 +0530 Subject: [PATCH 05/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 430d715fe8f..9e78318ccf5 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem'; An [Alias Output](https://wiki.iota.org/tips/tips/TIP-0018/#alias-output) is a specific implementation of a UTXO state machine. The Alias ID, the unique identifier of an instance of the deployed state machine, is generated deterministically by the protocol and is not allowed to change in future state transitions. -Alias Output represents an alias account in the ledger with two control levels and a permanentAlias Address. The account owns other outputs that are locked under Alias Address. The account keeps track of state transitions (`State Index` counter), controlled foundries (`Foundry Counter`) and anchors the layer 2 state as metadata into the UTXO ledger. +An Alias Output represents an alias account in the ledger with two control levels and a permanent Alias Address. The account owns other outputs that are locked under the Alias Address. The account keeps track of state transitions (`State Index` counter) and controlled foundries (`Foundry Counter`) and anchors the layer 2 state as metadata into the UTXO ledger. ## Example Code From b073e51c74a14882d1cbb03cbfe537c8ff74587a Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:15 +0530 Subject: [PATCH 06/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 9e78318ccf5..72b6b717c08 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -28,7 +28,7 @@ The following example will: 1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was [created in the first guide](../accounts-and-addresses/create-account.mdx). -2. Create an alias output transaction by calling the [`Account.create_alias_output()`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.CreateAliasParams.html) function. +2. Create an Alias Output transaction by calling the [`Account.create_alias_output()`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.CreateAliasParams.html) function.
From 78336e16020ff82282da29ac4eb3a18e430921b5 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:24 +0530 Subject: [PATCH 07/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 72b6b717c08..f3d0496ca39 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -38,7 +38,7 @@ https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/c
-3. Retry transaction until included [`Transaction`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.retry_transaction_until_included) that was sent. +3. Retry the [`Transaction`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.retry_transaction_until_included) until included.
From d9b56d4256bbecaf0cadd989f8fd0c706a1714ba Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:33 +0530 Subject: [PATCH 08/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index f3d0496ca39..1880986afec 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -43,7 +43,7 @@ https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/c
```rust reference -https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/create.rs#L43 +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/create.rs#L43-L45 ```
From 7dc068bd35bd44cc371bc321ab876dc26e8f124e Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:41 +0530 Subject: [PATCH 09/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index dd50d9ca197..881e2c14034 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -36,7 +36,7 @@ https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/d
-3. Retry transaction until included [`Transaction`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.retry_transaction_until_included) that was sent. +3. Retry the [`Transaction`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.retry_transaction_until_included) until included.
From cd29f8264e73879658316ea423db5293cded0baf Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:50 +0530 Subject: [PATCH 10/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 881e2c14034..1419f4ed987 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -41,7 +41,7 @@ https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/d
```rust reference -https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/destroy.rs#L47 +https://github.com/iotaledger/iota-sdk/blob/develop/sdk/examples/how_tos/alias/destroy.rs#L47-L49 ```
From 38b78d85204d3569005cdd5681d4eb962fbcbb38 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:57 +0530 Subject: [PATCH 11/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 1419f4ed987..5425157da04 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -53,7 +53,7 @@ The following example will: 1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). -2. Destroy an alias output transaction by calling the [`Account.preparedestroyalias()`](../../references/nodejs/classes/Account.md#preparedestroyalias) function. +2. Prepare the transaction to destroy an Alias Output by calling the [`Account.preparedestroyalias()`](../../references/nodejs/classes/Account.md#preparedestroyalias) function, and then [send](../../references/nodejs/classes/Account.md#send) it.
From 57d397a560b0fb8cf34461e0cc00d66bd26ea902 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:43:11 +0530 Subject: [PATCH 12/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 5425157da04..5bdef8f0417 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -78,7 +78,7 @@ https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how 1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). -2. Destroy an alias output transaction by calling the [`Account.prepare_destroy_alias()`](../../references/python/iota_sdk/wallet/account.md#prepare_destroy_alias) function. +2. Destroy the transaction that will destroy the alias output by calling the [`Account.prepare_destroy_alias()`](../../references/python/iota_sdk/wallet/account.md#prepare_destroy_alias) function, and then [send](../../references/python/iota_sdk/wallet/account.md#send) it.
From 0ef14d6fb16b2fc84eba837467cd1cf6cfdebb0f Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:43:18 +0530 Subject: [PATCH 13/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 5bdef8f0417..d3c7f0a0fbf 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -58,7 +58,7 @@ The following example will:
```typescript reference - https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/destroy.ts#L56 +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/destroy.ts#L56-L58 ```
From 2a90b02806185939241b6dd5d2d9fcd9e0ca0794 Mon Sep 17 00:00:00 2001 From: Kumar Anirudha Date: Tue, 12 Sep 2023 17:22:32 +0530 Subject: [PATCH 14/21] updated outputs to match all. except python --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 6bbe520ef80..24506eede28 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -122,14 +122,14 @@ https://github.com/iotaledger/iota-sdk/blob/develop/bindings/python/examples/how ### Expected Output ```plaintext -Aliases BEFORE (141): +Aliases BEFORE: [ ... ] Sending the create-alias transaction... Transaction sent: 0x7ce05ab09bc562c7b383067b774edd780e3a9235e9c76a5cccabdd9744b6a719 Transaction included: https://explorer.shimmer.network/testnet/block/0x603c0e010b4e7665913c04729aad692a1c7557234185e98c821e1142fa49823d -Aliases AFTER (142): +Aliases AFTER: [ ... ] From e36bd911b67067d0f269d6ba2497370ef8560b97 Mon Sep 17 00:00:00 2001 From: Kumar Anirudha Date: Wed, 13 Sep 2023 00:53:01 +0530 Subject: [PATCH 15/21] Transaction -> Block --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 2c979252b41..6bd6cb918ff 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -128,7 +128,7 @@ Aliases BEFORE: ] Sending the create-alias transaction... Transaction sent: 0x7ce05ab09bc562c7b383067b774edd780e3a9235e9c76a5cccabdd9744b6a719 -Transaction included: https://explorer.shimmer.network/testnet/block/0x603c0e010b4e7665913c04729aad692a1c7557234185e98c821e1142fa49823d +Block included: https://explorer.shimmer.network/testnet/block/0x603c0e010b4e7665913c04729aad692a1c7557234185e98c821e1142fa49823d Aliases AFTER: [ ... From 0e69e84b05ddbf0c5a63196d139009a9edbfc258 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Mon, 18 Sep 2023 20:47:33 +0530 Subject: [PATCH 16/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index d3c7f0a0fbf..161def2d5a0 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -26,7 +26,7 @@ The following example will: 1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was [created in the first guide](../accounts-and-addresses/create-account.mdx). -2. Destroy an alias output transaction by calling the [`Account.burn()`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.burn) function. +2. Destroy an Alias Output transaction by calling the [`Account.burn()`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/account/struct.Account.html#method.burn) function.
From 4af121312cc62825cb4c417e189492c4b4f1286d Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Mon, 18 Sep 2023 20:47:42 +0530 Subject: [PATCH 17/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 6bd6cb918ff..9b12ab2d00b 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -55,7 +55,7 @@ The following example will: 1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). -2. Create an alias output transaction by calling the [`Account.prepareCreateAliasOutput()`](../../references/nodejs/classes/Account.md#preparecreatealiasoutput) function. +2. Create an Alias Output transaction by calling the [`Account.prepareCreateAliasOutput()`](../../references/nodejs/classes/Account.md#preparecreatealiasoutput) function, and then [send](../../references/nodejs/classes/Account.md#send) it.
From b117cee0840db0c02e30c1e8c8c1be4486ebdcd3 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Mon, 18 Sep 2023 20:47:49 +0530 Subject: [PATCH 18/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 9b12ab2d00b..55fc834c761 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -60,7 +60,7 @@ The following example will:
```typescript reference - https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/create.ts#L53 +https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how_tos/alias/create.ts#L53-L55 ```
From 336ac38d4635414756fdf2268fb1f55a01447693 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Mon, 18 Sep 2023 20:47:58 +0530 Subject: [PATCH 19/21] Update docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx index 55fc834c761..00c96885b2b 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx @@ -80,7 +80,7 @@ https://github.com/iotaledger/iota-sdk/blob/develop/bindings/nodejs/examples/how 1. Instantiate a [`Wallet`](https://docs.rs/iota-sdk/latest/iota_sdk/wallet/core/struct.Wallet.html), get Alice's `Account` which was [created in the first guide](../accounts-and-addresses/create-account.mdx) and [sync it](../accounts-and-addresses/check-balance.mdx). -2. Create an alias output transaction by calling the [`Account.prepareCreateAliasOutput()`](../../references/python/iota_sdk/wallet/account.md#prepare_create_alias_output) function. +2. Prepare an Alias Output transaction by calling the [`Account.prepare_create_alias_output()`](../../references/python/iota_sdk/wallet/account.md#prepare_create_alias_output) function, and then [send](../../references/python/iota_sdk/wallet/account.md#send) it.
From 37a39f8647a875b1cf9cc415e28bb4a77275fee2 Mon Sep 17 00:00:00 2001 From: Ani <5357586+anistark@users.noreply.github.com> Date: Mon, 18 Sep 2023 20:48:41 +0530 Subject: [PATCH 20/21] Update destroy.mdx --- docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx index 161def2d5a0..81caad56925 100644 --- a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx +++ b/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx @@ -15,7 +15,7 @@ keywords: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -You can destroy an alias output by ID. If the alias still owns any outputs when you try to destroy it, you will get an error. +You can destroy an alias output by ID. ## Example Code From 7c8c07e2c08e560b0022c93d4d1afc8241af0265 Mon Sep 17 00:00:00 2001 From: Luca Moser Date: Tue, 26 Sep 2023 10:06:13 +0200 Subject: [PATCH 21/21] moves files into appropriate folder --- docs/build/iota-sdk/{1.0.0 => 1.0}/docs/how-tos/alias/create.mdx | 0 docs/build/iota-sdk/{1.0.0 => 1.0}/docs/how-tos/alias/destroy.mdx | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/build/iota-sdk/{1.0.0 => 1.0}/docs/how-tos/alias/create.mdx (100%) rename docs/build/iota-sdk/{1.0.0 => 1.0}/docs/how-tos/alias/destroy.mdx (100%) diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx b/docs/build/iota-sdk/1.0/docs/how-tos/alias/create.mdx similarity index 100% rename from docs/build/iota-sdk/1.0.0/docs/how-tos/alias/create.mdx rename to docs/build/iota-sdk/1.0/docs/how-tos/alias/create.mdx diff --git a/docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx b/docs/build/iota-sdk/1.0/docs/how-tos/alias/destroy.mdx similarity index 100% rename from docs/build/iota-sdk/1.0.0/docs/how-tos/alias/destroy.mdx rename to docs/build/iota-sdk/1.0/docs/how-tos/alias/destroy.mdx