From 93a5b9ebbff8192083a460f3b287c11217aa8702 Mon Sep 17 00:00:00 2001 From: Dave Jones Date: Tue, 30 Mar 2021 15:40:36 -0500 Subject: [PATCH] 'fee' explanation --- value/value.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/value/value.md b/value/value.md index 3d2d680..537b546 100644 --- a/value/value.md +++ b/value/value.md @@ -141,6 +141,7 @@ There is no limit on how many `valueRecipient` elements can be present in a give customKey="[optional key to pass(mixed)]" customValue="[optional value to pass(mixed)]" split="[share count(int)]" + fee=[true|false] /> ``` @@ -154,6 +155,7 @@ There is no limit on how many `valueRecipient` elements can be present in a give - `type` (required) A slug that represents the type of receiving address that will receive the payment. - `address` (required) This denotes the receiving address of the payee. - `split` (required) The number of shares of the payment this recipient will receive. + - `fee` (optional) If this attribute is not specified, it is assumed to be false.
@@ -174,6 +176,10 @@ The `split` attribute denotes an amount of "shares" of the total payment that th When a single `` is present, it should be assumed that the `split` for that recipient is 100%, and the "split" should be ignored. When multiple recipients are present, a share calculation (see below) should be made to determine how much to send to each recipient's address. +The `fee` attribute tells apps whether this split should be treated as a "fee", or a normal split. If this attribute is true, then this split should be calculated +as a fee, meaning it's percentage (as calculated from the shares) should be taken off the top of the entire transaction amount. This is the preferred way for service +providers such as apps, hosting companies, API's and third-party value add providers to add their fee to a value block. +

@@ -286,7 +292,7 @@ the `customKey` and `customValue` can be utilized as follows: This is a live, working example of a Lightning keysend value block in production. It designates four recipients for payment - two podcast hosts at 49 and 46 shares respectively, a producer working on per episode chapter creation who gets a 5 share, and -a single share (effectively 1%) donation to Podcastindex.org. +a single share (effectively 1%) fee to the Podcastindex.org API. ``` @@ -313,6 +319,7 @@ a single share (effectively 1%) donation to Podcastindex.org. type="node" address="03ae9f91a0cb8ff43840e3c322c4c61f019d8c1c3cea15a25cfc425ac605e61a4a" split="1" + fee="true" /> ```