Skip to content

Commit

Permalink
Remove and fix absolute links
Browse files Browse the repository at this point in the history
  • Loading branch information
jlvandenhout authored Sep 2, 2023
1 parent 84940b9 commit eff881d
Show file tree
Hide file tree
Showing 180 changed files with 613 additions and 462 deletions.
2 changes: 1 addition & 1 deletion docs/build/getting-started/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:
Welcome to the "Build" section of the IOTA Wiki. This section is for developers interested in using the IOTA and Shimmer
networks for decentralized applications, integrating their exchange, minting NFTs, and much more. Here, you can find all
the available [Networks and Endpoints](networks-endpoints.md), links for all the available
[Tools](/build/tools), [APIS](/apis/welcome/), and all the documentation to communicate with the Layer 1 networks,
[Tools](/build/tools), [APIS](/apis/welcome), and all the documentation to communicate with the Layer 1 networks,
build
decentralized applications and interact with Layer 2 [smart contracts](#smart-contracts).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

# Alias Output

The IOTA method uses the IOTA ledger which uses the [unspent transaction output (UTXO) model](https://wiki.iota.org/goshimmer/protocol_specification/components/ledgerstate). Also, the features of the [Stardust](https://wiki.iota.org/introduction/develop/explanations/what_is_stardust) upgrade are fundamental to the IOTA DID method.
The IOTA method uses the IOTA ledger which uses the [unspent transaction output (UTXO) model](/goshimmer/protocol_specification/components/ledgerstate). Also, the features of the [Stardust](/introduction/stardust/explanations/what_is_stardust) upgrade are fundamental to the IOTA DID method.

The Alias Output is used for storing the DID Document on the ledger. It is a specific implementation of the UTXO state machine that can hold arbitrary data in its `State Metadata`. The Alias Output has two kinds of controllers, a state controller and a governor. A state controller can execute a state transition which allows updating the data in the `State Metadata`. The governor, on the contrary, can't update the `State Metadata` but can change both controllers and destroy the Alias Output.
A controller can be either Ed25519 Address, Alias Address or an NFT Address and at most one of each can be set for an Alias Output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Once the transaction is confirmed, the `Alias ID` would be assigned and the DID

## Running a private network

In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](https://wiki.iota.org/hornet/develop/how_tos/private_tangle) for instructions on how to run a private network.
In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](/hornet/2.0.0-rc.6/how_tos/private_tangle) for instructions on how to run a private network.

If your local private network uses different ports than Hornet, modify the API and faucet endpoints in the examples to match your local setup.
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ Iota Identity helps with abstracting the details of the DID standard by providin

### Storage solution

IOTA Identity provides a [Stronghold](https://wiki.iota.org/stronghold.rs/welcome/ 'Stronghold is an open-source software library that was originally built to protect IOTA Seeds, but can be used to protect any digital secret.') solution for managing secrets securely, without requiring developers to reinvent the security wheel.
IOTA Identity provides a [Stronghold](/stronghold.rs/welcome/ 'Stronghold is an open-source software library that was originally built to protect IOTA Seeds, but can be used to protect any digital secret.') solution for managing secrets securely, without requiring developers to reinvent the security wheel.
2 changes: 1 addition & 1 deletion docs/build/identity.rs/0.7-alpha/docs/contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ All of the code is open source and hosted on [GitHub](https://github.com/iotaled

- [Report a bug](https://github.com/iotaledger/identity.rs/issues/new/choose).
- [Suggest a new feature](https://github.com/iotaledger/documentation/blob/develop/.github/CONTRIBUTING.md).
- [Contribute to the documentation](https://wiki.iota.org/identity.rs/contribute#contribute-to-the-documentation).
- [Contribute to the documentation](/identity.rs/contribute#contribute-to-the-documentation).

## Contribute to the Documentation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,15 @@ IOTA is a neutral and free-to-use public infrastructure acting as a trustworthy

:::

IOTA is a scalable and feeless Distributed Ledger Technology (DLT). Similar to Blockchain technology, IOTA provides an immutable and decentralized ledger that can transact value through the IOTA token. Unlike Blockchain, IOTA uses a non-linear data structure called the [Tangle](https://wiki.iota.org/learn/about-iota/an-introduction-to-iota#the-tangle-data-structure) which makes it feeless and vastly more scalable. The Tangle also facilitates feeless transactions of data, such as DID registrations and credential revocations. As a single source of truth and trust in data, the Tangle can provide the trust infrastructure in a highly networked world.
IOTA is a scalable and feeless Distributed Ledger Technology (DLT). Similar to Blockchain technology, IOTA provides an immutable and decentralized ledger that can transact value through the IOTA token. Unlike Blockchain, IOTA uses a non-linear data structure called the [Tangle](/learn/about-iota/an-introduction-to-iota#the-tangle-data-structure) which makes it feeless and vastly more scalable. The Tangle also facilitates feeless transactions of data, such as DID registrations and credential revocations. As a single source of truth and trust in data, the Tangle can provide the trust infrastructure in a highly networked world.

IOTA is uniquely suited for a single unifying identity implementation. The network is designed for both humans and devices, providing a platform for trusted communication between individuals, organizations, and things. The IOTA Foundation’s principles of full transparency, openness, and permissionless innovation provide an open and neutral environment:

1. **Permissionless & Decentralized**: Unlike a permissioned network such as Hyperledger or Corda, everyone can participate in consensus without being granted access. No party incentivized by profit-making has collective control over the network (unlike all blockchains). This makes IOTA neutral and censorship-resistant.
2. **Public**: Everyone can observe (unless using optional encryption) the transactions in the network. The network is inherently transparent.
3. **Feeless**: All data and value transactions on the network are free. Unlike other DLTs such as Bitcoin or Ethereum, registration and communication of identities can be written to the network without a requirement to purchase a cryptocurrency token.
4. **Open Source**: Everyone can view and contribute to the code.
5. **Easy to use**: IOTA Identity is inherently easier to use due to the lack of fees or requirements to set up an entire private network. In addition, the framework is designed to have an easy to use high-level API, with accessibility to the low-level, more complex and more flexible API. Through integration with the [Stronghold](https://wiki.iota.org/stronghold.rs/welcome 'Stronghold is an open-source software library that was originally built to protect IOTA Seeds, but can be used to protect any digital secret.') project, we also provide out-of-the-box security for secrets.
5. **Easy to use**: IOTA Identity is inherently easier to use due to the lack of fees or requirements to set up an entire private network. In addition, the framework is designed to have an easy to use high-level API, with accessibility to the low-level, more complex and more flexible API. Through integration with the [Stronghold](/stronghold.rs/welcome 'Stronghold is an open-source software library that was originally built to protect IOTA Seeds, but can be used to protect any digital secret.') project, we also provide out-of-the-box security for secrets.

Data must be immutably stored on a distributed ledger to ensure the decentralized nature of the digital identity protocol. With the network’s continual uptime, credentials are always verifiable without a dependency on the servers of credential issuers. This system also increases individual privacy, because contact with the Issuer is removed from the interaction between Holder and Verifier. Issuers will not be able to track when and how often the Holder uses their credentials. The flexibility afforded from the Tangle means that the digital identity framework remains extendable in the future.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:

> This is the beta version of the official WASM bindings for [IOTA Identity](https://github.com/iotaledger/identity.rs).
## [API Reference](https://wiki.iota.org/identity.rs/libraries/wasm/api_reference)
## [API Reference](/identity.rs/libraries/wasm/api_reference)

## [Examples](https://github.com/iotaledger/identity.rs/blob/main/bindings/wasm/examples/README.md)

Expand Down Expand Up @@ -64,7 +64,7 @@ The minimum supported version for node is: `v16`
## NodeJS Usage

The following code creates a new IOTA DID Document suitable for publishing to a locally running private network.
See the [instructions](https://wiki.iota.org/hornet/develop/how_tos/private_tangle) on running your own private network.
See the [instructions](/hornet/2.0.0-rc.6/how_tos/private_tangle) on running your own private network.

<!--
Test this example using https://github.com/anko/txm: `txm README.md`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords:

## Abstract

The IOTA DID Method Specification describes a method of implementing the [Decentralized Identifiers](https://www.w3.org/TR/did-core/) (DID) standard on [IOTA](https://iota.org), a Distributed Ledger Technology (DLT). It conforms to the [DID specification v1.0](https://www.w3.org/TR/did-core/) and describes how to perform Create, Read, Update and Delete (CRUD) operations for IOTA DID Documents using unspent transaction outputs ([UTXO](https://wiki.iota.org/IOTA-2.0-Research-Specifications/5.1UTXO)) on the IOTA and [Shimmer](https://shimmer.network/) networks, introduced with the [Stardust upgrade](https://blog.shimmer.network/stardust-upgrade-in-a-nutshell/).
The IOTA DID Method Specification describes a method of implementing the [Decentralized Identifiers](https://www.w3.org/TR/did-core/) (DID) standard on [IOTA](https://iota.org), a Distributed Ledger Technology (DLT). It conforms to the [DID specification v1.0](https://www.w3.org/TR/did-core/) and describes how to perform Create, Read, Update and Delete (CRUD) operations for IOTA DID Documents using unspent transaction outputs ([UTXO](/introduction/reference/details#unspent-transaction-output-utxo)) on the IOTA and [Shimmer](https://shimmer.network/) networks, introduced with the [Stardust upgrade](https://blog.shimmer.network/stardust-upgrade-in-a-nutshell/).

## Data Types & Subschema Notation

Expand All @@ -28,7 +28,7 @@ Data types and subschemas used throughout this TIP are defined in [TIP-21](https

### UTXO Ledger

The unspent transaction output ([UTXO](https://wiki.iota.org/IOTA-2.0-Research-Specifications/5.1UTXO)) model defines a ledger state which is comprised of unspent outputs. Outputs are created by a transaction consuming outputs of previous transactions as inputs. The Stardust version of the protocol defines several output types, the relevant ones for the IOTA DID Method are: Basic Outputs for value transactions, and Alias Outputs for storage of DID Documents.
The unspent transaction output ([UTXO](/introduction/reference/details#unspent-transaction-output-utxo)) model defines a ledger state which is comprised of unspent outputs. Outputs are created by a transaction consuming outputs of previous transactions as inputs. The Stardust version of the protocol defines several output types, the relevant ones for the IOTA DID Method are: Basic Outputs for value transactions, and Alias Outputs for storage of DID Documents.

All outputs must hold a minimum amount of tokens to be stored on the ledger. For output types that can hold arbitrary data, for instance the Alias Output, the amount of tokens held by the output must cover the byte cost of the data stored. This prevents the ledger size from growing uncontrollably while guaranteeing that the data is not pruned from the nodes, which is important for resolving DID Documents. This deposit is fully refundable and can be reclaimed when the output is destroyed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ npm run start create-did alice alice-password
This will create a minimal DID document for alice, and publish it to the Tangle. A Stronghold file `alice.hodl` will be created under `/stronghold-files` which contains the Account's state and the private key of the main verification method of the DID.
`alice-password` will be used as a password for the stronghold storage. Obviously this password must be more secure in production applications.

See [Creating a Decentralized Identity](https://wiki.iota.org/identity.rs/concepts/decentralized_identifiers/create) for more information about generating DIDs.
See [Creating a Decentralized Identity](/identity.rs/concepts/decentralized_identifiers/create) for more information about generating DIDs.

### 2. **Issuer**: Create a DID

Expand All @@ -97,7 +97,7 @@ with that `uni-of-oslo.hodl` will be created under `/stronhold-files`.
### 3. **Issuer**: Add a Verification Method

Since the university will need to issue a signed verifiable credential for Alice, a verification method should be added to the university's DID document.
Read more about adding verification methods in [update DID Documents](https://wiki.iota.org/identity.rs/concepts/decentralized_identifiers/update).
Read more about adding verification methods in [update DID Documents](/identity.rs/concepts/decentralized_identifiers/update).

To add a Verification Method the following command can be used:

Expand Down Expand Up @@ -126,7 +126,7 @@ npm run start create-vm alice alice-password key-1

### 5: **Issuer**: Create Revocation list

In order for the issuer to be able to revoke credentials in the future, a revocation list is needed. See [Verifiable Credential Revocation](https://wiki.iota.org/identity.rs/concepts/verifiable_credentials/revocation) for further details.
In order for the issuer to be able to revoke credentials in the future, a revocation list is needed. See [Verifiable Credential Revocation](/identity.rs/concepts/verifiable_credentials/revocation) for further details.
The following command can be used to create a revocation list:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

# Alias Output

The IOTA method uses the IOTA ledger which uses the [unspent transaction output (UTXO) model](https://wiki.iota.org/goshimmer/protocol_specification/components/ledgerstate). Also, the features of the [Stardust](https://wiki.iota.org/introduction/develop/explanations/what_is_stardust) upgrade are fundamental to the IOTA DID method.
The IOTA method uses the IOTA ledger which uses the [unspent transaction output (UTXO) model](/goshimmer/protocol_specification/components/ledgerstate). Also, the features of the [Stardust](/introduction/stardust/explanations/what_is_stardust) upgrade are fundamental to the IOTA DID method.

The Alias Output is used for storing the DID Document on the ledger. It is a specific implementation of the UTXO state machine that can hold arbitrary data in its `State Metadata`. The Alias Output has two kinds of controllers, a state controller and a governor. A state controller can execute a state transition which allows updating the data in the `State Metadata`. The governor, on the contrary, can't update the `State Metadata` but can change both controllers and destroy the Alias Output.
A controller can be either Ed25519 Address, Alias Address or an NFT Address and at most one of each can be set for an Alias Output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Once the transaction is confirmed, the `Alias ID` would be assigned and the DID

## Running a private network

In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](https://wiki.iota.org/hornet/develop/how_tos/private_tangle) for instructions on how to run a private network.
In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](/hornet/2.0.0-rc.6/how_tos/private_tangle) for instructions on how to run a private network.

If your local private network uses different ports than Hornet, modify the API and faucet endpoints in the examples to match your local setup.
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ Iota Identity helps with abstracting the details of the DID standard by providin

### Storage solution

IOTA Identity provides a [Stronghold](https://wiki.iota.org/stronghold.rs/welcome/ 'Stronghold is an open-source software library that was originally built to protect IOTA Seeds, but can be used to protect any digital secret.') solution for managing secrets securely, without requiring developers to reinvent the security wheel.
IOTA Identity provides a [Stronghold](/stronghold.rs/welcome/ 'Stronghold is an open-source software library that was originally built to protect IOTA Seeds, but can be used to protect any digital secret.') solution for managing secrets securely, without requiring developers to reinvent the security wheel.
2 changes: 1 addition & 1 deletion docs/build/identity.rs/next/docs/contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ All of the code is open source and hosted on [GitHub](https://github.com/iotaled

- [Report a bug](https://github.com/iotaledger/identity.rs/issues/new/choose).
- [Suggest a new feature](https://github.com/iotaledger/documentation/blob/develop/.github/CONTRIBUTING.md).
- [Contribute to the documentation](https://wiki.iota.org/identity.rs/contribute#contribute-to-the-documentation).
- [Contribute to the documentation](/identity.rs/contribute#contribute-to-the-documentation).

## Contribute to the Documentation

Expand Down
Loading

0 comments on commit eff881d

Please sign in to comment.