doc: Add documentation

uncomputable · Oct 24, 2024 · 2c27d06 · 2c27d06
1 parent 27f6181
commit 2c27d06
Show file tree

Hide file tree

Showing 13 changed files with 131 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,131 @@
+# How to make a transaction using the web IDE
+
+The Simfony web IDE can only make a restricted form of transaction: There is 1 transaction input, 1 transaction output and 1 fee output _(Liquid has explicit fee outputs)_. Confidential transactions or assets other than Bitcoin are not supported.
+
+![Screenshot of mempool.space](https://github.com/uncomputable/simfony-webide/tree/local/doc/mempool1.png)
+
+## Write the main function
+
+Write the main function of your Simfony program.
+
+_You can leave the default main function as it is. Customize it if you want._
+
+![Screenshot of the web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/webide0.png)
+
+## Generate an address
+
+Click the "Address" button to copy the address of your program to the clipboard.
+
+![Screenshot of the web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/webide1.png)
+
+## Fund the address using the Liquid testnet faucet
+
+Paste the address into [the Liquid testnet faucet](https://liquidtestnet.com/faucet) and press the "Send assets" button.
+
+![Screenshot of the Liquid testnet faucet](https://github.com/uncomputable/simfony-webide/tree/local/doc/faucet1.png)
+
+Copy the ID of the funding transaction to your clipboard.
+
+![Screenshot of the Liquid testnet faucet](https://github.com/uncomputable/simfony-webide/tree/local/doc/faucet2.png)
+
+## Look up the funding transaction
+
+Paste the ID of the funding transaction into the [Blockstream Explorer for Liquid testnet](https://blockstream.info/liquidtestnet/).
+
+![Screenshot of the Blockstream Explorer](https://github.com/uncomputable/simfony-webide/tree/local/doc/esplora1.png)
+
+Scroll down and find the Simfony UTXO. The Liquid testnet faucet always sends 100000 tl-BTC. In our example, the Simfony UTXO is vout = 1.
+
+![Screenshot of the Blockstream Explorer](https://github.com/uncomputable/simfony-webide/tree/local/doc/esplora2.png)
+
+## Enter UTXO data into the web IDE
+
+Enter the ID of the funding transaction and the vout into the web IDE.
+
+_You can leave the remaining fields as they are. Feel free to customize._
+
+![Screenshot of the Simfony web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/webide2.png)
+
+## Sign the spending transaction
+
+Click the "Sig 0" button to generate a signature for a transaction that spends the Simfony UTXO.
+
+![Screenshot of the Simfony web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/webide3.png)
+
+Paste the signature into the `mod witness {...}` section.
+
+![Screenshot of the Simfony web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/webide4.png)
+
+## Generate the spending transaction
+
+Click the "Transaction" button to copy the spending transaction to your clipboard.
+
+![Screenshot of the Simfony web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/webide5.png)
+
+## Broadcast the spending transaction
+
+Paste the spending transaction into the [Blockstream Liquid testnet explorer](https://blockstream.info/liquidtestnet/tx/push) and click the "Broadcast transaction" button.
+
+![Screenshot of the Simfony web IDE](https://github.com/uncomputable/simfony-webide/tree/local/doc/esplora3.png)
+
+If everything worked, the explorer will open the broadcast transaction. In this case, congratulations, you made a Simfony transaction on Liquid testnet!!!
+
+If you see an error message, take a look at the following "Troubleshooting" section.
+
+## Troubleshooting
+
+### Cryptic error message
+
+Cause.
+
+Action to take.
+
+### "Transaction not found" (Blockstream Esplora)
+
+Fake error. The transaction actually worked :)
+
+Wait for 1 minute and reload the page.
+
+### `bad-txns-inputs-missingorspent`
+
+The UTXO doesn't exist.
+
+Double check the txid. You might have to wait for one minute for the UTXO to be included in the blockchain.
+
+### `bad-txns-in-ne-out, value in != value out`
+
+The input value does not equal the output value.
+
+Double-check the UTXO info (vout and value). Check that the fee is lower than the input value.
+
+### `bad-txns-fee-outofrange`
+
+The fee does not cover the transaction weight.
+
+Increase the fee.
+
+### `non-final`
+
+The lock time is higher than the current block height.
+
+Decrease the locktime or wait until the block height is high enough.
+
+### `non-BIP68-final`
+
+The sequence is higher than the current block height plus the UTXO height.
+
+Decrease the sequence or wait until the block height is high enough.
+
+### `dust`
+
+You are creating a dust transaction output.
+
+The fee consumes the entire input value. Decrease the fee.
+
+### `non-mandatory-script-verify-flag (Assertion failed inside jet)`
+
+A Simplicity jet fails.
+
+Double-check the conditions that your Simfony program enforces. Update the witness data or transaction parameters.
+
+Every time you change the transaction parameters, the signature hash of the transaction changes. In this case, you need to **regenerate signatures** using the "Key Store" tab.
diff --git a/doc/esplora1.png b/doc/esplora1.png
diff --git a/doc/esplora2.png b/doc/esplora2.png
diff --git a/doc/esplora3.png b/doc/esplora3.png
diff --git a/doc/faucet1.png b/doc/faucet1.png
diff --git a/doc/faucet2.png b/doc/faucet2.png
diff --git a/doc/mempool1.png b/doc/mempool1.png
diff --git a/doc/webide0.png b/doc/webide0.png
diff --git a/doc/webide1.png b/doc/webide1.png
diff --git a/doc/webide2.png b/doc/webide2.png
diff --git a/doc/webide3.png b/doc/webide3.png
diff --git a/doc/webide4.png b/doc/webide4.png
diff --git a/doc/webide5.png b/doc/webide5.png