Skip to content

Commit 64004b6

Browse files
docs: add tip command inside the docs
Signed-off-by: Vincenzo Palazzo <[email protected]>
1 parent ba911bc commit 64004b6

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

docs/docs-book/src/support-coffee.md

+22
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,25 @@ itself. With some craziness will be also possible to manage core lightning itsel
4141

4242
Please if you feel that additional meta information needs to be specified open an issue
4343
https://github.com/coffee-tools/coffee/issues
44+
45+
## Tipping
46+
47+
While there are possibility to tipping anything on lightning, there is any solution to tipping a core lightning plugin
48+
developer. So with coffee as developer you can define a BOLT 12 invoice that allow the developer of the plugin
49+
to receive tips. So, the developer of the plugin should define a coffee manifest that specify the `tipping` info.
50+
51+
An example can be:
52+
53+
```yaml
54+
---
55+
plugin:
56+
name: btcli4j
57+
version: 0.0.1
58+
lang: java
59+
install: |
60+
sh -C ./gradlew createRunnableScript
61+
main: btcli4j-gen.sh
62+
tipping:
63+
bolt12: <bolt12 invoice>
64+
```
65+

docs/docs-book/src/using-coffee.md

+9
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,15 @@ Additionally, if you wish to perform a verification of coffee without making any
159159
coffee nurse --verify
160160
```
161161
_________
162+
### Tipping a plugin in Bitcoin
163+
164+
> ✅ Implemented
165+
166+
```
167+
coffee tip <plugin_name> <millisatoshi>
168+
```
169+
170+
------
162171
## Running coffee as a server
163172

164173
To run Coffee as a server, you can use the `coffee_httpd` binary.

0 commit comments

Comments
 (0)