aljaz/ark
1
0
Fork 0
mirror of https://github.com/aljazceru/ark.git synced 2026-02-01 01:24:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixes links to nomenclature in Get Started

Browse Source
This commit is contained in:
bordalix
2023-11-29 09:50:59 +00:00
parent 70d6fb196b
commit 7efa7bded6
4 changed files with 23 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
website/docs/intro/boarding.md
View File

@@ -12,16 +12,17 @@ Alice wants to board the Ark of a well-known Ark service provider (ASP). It requ
### The timeline of events
1. Alice creates a [Funding transaction](#funding-transaction)
1. Alice creates a [Funding transaction](./nomenclature#funding-transaction)
2. Alice adds any inputs she wants to cover the values the [VTXO](#vtxo) she will receive, plus on-chain fees.
2. Alice adds any inputs she wants to cover the values the [VTXO](./nomenclature#vtxo-1) she will receive, plus on-chain fees.
3. Alice adds an output with **two spending conditions**:
- `(ASP in 1 month)`
- A covenant output that forces coins to be spent by a [Redeem transaction](#redeem-transaction-) with an output with **two** spending conditions:
- `(Alice + ASP)`
- `(Alice in 24 hours)`
- A covenant output that forces coins to be spent by a [Redeem transaction](./nomenclature#redeem-transaction) with an output with **two** spending conditions:
- `(Alice + ASP)`
- `(Alice in 24 hours)`
4. Alice notifies ASP about the [Funding transaction](#funding-transaction)
4. Alice notifies ASP about the [Funding transaction](./nomenclature#funding-transaction)
5. Alice has now a [VTXO](#vtxo).
5. Alice has now a [VTXO](./nomenclature#vtxo-1).

12
website/docs/intro/leaving.md
View File

@@ -9,13 +9,13 @@ Alice wants to leave the Ark and get her funds back on-chain. It requires an on-
### Timeline of events
1. Alice tells ASP she wants to trade [VTXO](#vtxo) for UTXO
2. ASP (with Alice) prepares next [Pool transaction](#pool-transaction-aka-ark-transaction):
- an additional output is added, locked by `Alice`
3. Alice creates a [Forfeit transaction](#forfeit-transaction-):
1. Alice tells ASP she wants to trade [VTXO](./nomenclature#vtxo-1) for UTXO
2. ASP (with Alice) prepares next [Pool transaction](./nomenclature#pool-transaction-aka-ark-transaction):
- an additional output is added, locked to `Alice`
3. Alice creates a [Forfeit transaction](./nomenclature#forfeit-transaction-):
- spends from VTXO (1) with `Alice + ASP`
- adds connector output from Pool transaction (2) as input
- signs it and send it to the ASP
4. ASP broadcasts [Pool transaction](#pool-transaction-aka-ark-transaction)
4. ASP broadcasts [Pool transaction](./nomenclature#pool-transaction-aka-ark-transaction)
5. Alice has now a new UTXO
6. For at most 4 weeks, Alice will be able to double spend her’s [VTXO](#vtxo), but if she does it, the ASP will have time (24 hours) to grab the funds from the [VTXO](#vtxo) to itself using the [Forfeit transaction](#forfeit-transaction-)
6. For at most 4 weeks, Alice will be able to double spend her’s [VTXO](./nomenclature#vtxo-1), but if she does it, the ASP will have time (24 hours) to grab the funds from the [VTXO](./nomenclature#vtxo-1) to itself using the [Forfeit transaction](./nomenclature#forfeit-transaction-)

6
website/docs/intro/nomenclature.md
View File

@@ -43,7 +43,7 @@ Periodic transaction crafted by the ASP that hits mainchain and creates new VTXO
| ------------------- | ----------------------------------- |
| Alice’s segwit UTXO | `(Alice + ASP) or (ASP in 1 month)` |
### Redeem transaction \*
### Redeem transaction\*
- Insurance for Alice, in case the ASP denies boarding on the Ark
- Allows Alice to receive funds back from the Ark after a grace period ie. 24 hours
@@ -52,7 +52,7 @@ Periodic transaction crafted by the ASP that hits mainchain and creates new VTXO
| ------------------------------------------ | -------------------------------------- |
| Funding transaction spending `Alice + ASP` | `(Alice + ASP) or (Alice in 24 hours)` |
### Forfeit transaction \*
### Forfeit transaction\*
- Insurance for the ASP, in case Alice tries to double spend her VTXO after spending it inside Ark
- Before the ASP funds Bob’s VTXO in the next Pool transaction, he must receive this transaction signed by Alice
@@ -81,7 +81,7 @@ Periodic transaction crafted by the ASP that hits mainchain and creates new VTXO
![Docusaurus Plushie](../img/shared_output.png)
### VTXO \*
### VTXO\*
- Similar to Redeem transaction
- Can be broadcasted anytime, on the condition that previous transactions on the transaction tree (up to the Pool transaction) are confirmed or broadcasted at the same time

12
website/docs/intro/payments.md
View File

@@ -14,12 +14,12 @@ Alice wants to send funds to Bob inside the Ark.
### Timeline of events
1. Alice tells ASP to send [VTXO](#vtxo) to Bob
2. ASP (with Alice) prepares next [Pool transaction](#pool-transaction-aka-ark-transaction)
3. Alice creates a [Forfeit transaction](#forfeit-transaction-):
1. Alice tells ASP to send [VTXO](./nomenclature#vtxo-1) to Bob
2. ASP (with Alice) prepares next [Pool transaction](./nomenclature#pool-transaction-aka-ark-transaction)
3. Alice creates a [Forfeit transaction](./nomenclature#forfeit-transaction):
- spends from VTXO (1) via `Alice + ASP`
- adds connector output from Pool transaction (2) as input
- signs (SIGHASH_ALL) and sends it to the ASP
4. ASP broadcasts [Pool transaction](#pool-transaction-aka-ark-transaction)
5. Bob has now a new [VTXO](#vtxo)
6. For at most 4 weeks, Alice will be able to double spend her’s [VTXO](#vtxo), but if she does it, the ASP will have time to grab the funds from the [VTXO](#vtxo) to itself using the [Forfeit transaction](#forfeit-transaction-)
4. ASP broadcasts [Pool transaction](./nomenclature#pool-transaction-aka-ark-transaction)
5. Bob has now a new [VTXO](./nomenclature#vtxo-1)
6. For at most 4 weeks, Alice will be able to double spend her’s [VTXO](./nomenclature#vtxo-1), but if she does it, the ASP will have time to grab the funds from the [VTXO](./nomenclature#vtxo-1) to itself using the [Forfeit transaction](./nomenclature#forfeit-transaction)