Skip to content

docs: improve transaction hint docs #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: improve transaction hint docs #202

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88b123a
docs: improve transaction hint docs
iloveitaly Sep 17, 2023
e3d0724
Merge branch 'main' into better-transaction-hint-docs
eprbell Sep 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/configuration_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -612,12 +612,20 @@ Builtin sections are used as global configuration of DaLI's behavior.
The transaction_hints section is optional and is used to force a transaction to be generated as in, out or intra. This is useful because DaLI doesn't know the user's intentions and in certain cases it needs hints from the user. For example an out transaction could be represented either as a partial intra transaction (as described above) or as a normal out transaction (perhaps a gift to another person): only the user knows the correct meaning of the transaction. In such cases a transaction_hint line can be used to clear the ambiguity.

The format of this section is as follows:
<pre>

```
[transaction_hints]
<em>&lt;unique_id_1&gt;</em> = <em>&lt;direction&gt;</em>:<em>&lt;transaction_type&gt;</em>:<em>&lt;notes&gt;</em>
<unique_id_1>_ = <direction>:<transaction_type>:<notes>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't render correctly, it shows as: _ = ::

...
<em>&lt;unique_id_n&gt;</em> = <em>&lt;direction&gt;</em>:<em>&lt;transaction_type&gt;</em>:<em>&lt;notes&gt;</em>
</pre>
_<unique_id_n>_ = _<direction>_:_<transaction_type>_:_<notes>_
```

For instance:

```
[transaction_hints]
451364dc-e1a1-5eb7-bc11-ea9f485d0159 = in:airdrop:BCH fork airdrop
```

Where:
* *`unique_id`* is the unique_id of the transaction that needs to be recast;
Expand Down