Skip to content

Commit

Permalink
doc: Including docs references for addpsbtoutput where it seems to be…
Browse files Browse the repository at this point in the history
… missing
  • Loading branch information
s373nZ committed Feb 27, 2024
1 parent 7b4a4d3 commit f101af3
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ MANPAGES := doc/lightning-cli.1 \
doc/lightningd-config.5 \
doc/lightningd-rpc.7 \
doc/lightning-addgossip.7 \
doc/lightning-addpsbtoutput.7 \
doc/lightning-autoclean-once.7 \
doc/lightning-autoclean-status.7 \
doc/lightning-batching.7 \
Expand Down Expand Up @@ -52,7 +53,6 @@ MANPAGES := doc/lightning-cli.1 \
doc/lightning-fundchannel_complete.7 \
doc/lightning-fundchannel_cancel.7 \
doc/lightning-funderupdate.7 \
doc/lightning-addpsbtoutput.7 \
doc/lightning-fundpsbt.7 \
doc/lightning-getroute.7 \
doc/lightning-hsmtool.8 \
Expand Down
8 changes: 4 additions & 4 deletions doc/lightning-addpsbtoutput.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:

- **psbt** (string): Unsigned PSBT which fulfills the parameters given
- **estimated\_added\_weight** (u32): The estimated weight of the added output
- **outnum** (u32): The 0-based number where the output was placed
- **psbt** (string): The unsigned PSBT which fulfills the parameters given.
- **estimated\_added\_weight** (u32): The estimated weight of the added output.
- **outnum** (u32): The 0-based number where the output was placed.

[comment]: # (GENERATE-FROM-SCHEMA-END)

Expand All @@ -65,4 +65,4 @@ RESOURCES

Main web site: <https://github.com/ElementsProject/lightning>

[comment]: # ( SHA256STAMP:6a31cc1575f9112d0582b5b9db560a5217d6e1a7bd33d399958e3aff7b022ac3)
[comment]: # ( SHA256STAMP:0f2b1c781862eb37a4b7a1b30bfc58cbb82987ff8e03e6f54f82f8d5e1b233cf)
11 changes: 7 additions & 4 deletions doc/schemas/addpsbtoutput.request.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,20 @@
"added": "v23.11",
"properties": {
"satoshi": {
"type": "msat"
"type": "msat",
"description": "The satoshi value of the output. It can be a whole number, a whole number ending in sat, a whole number ending in 000msat, or a number with 1 to 8 decimal places ending in btc."
},
"locktime": {
"type": "u32"
"type": "u32",
"description": "An optional locktime: if not set, it is set to a recent block height (if no initial psbt is specified)."
},
"initialpsbt": {
"type": "string",
"description": "the (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically"
"description": "The (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically."
},
"destination": {
"type": "string"
"type": "string",
"description": "If not set, an internal address is generated."
}
}
}
6 changes: 3 additions & 3 deletions doc/schemas/addpsbtoutput.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
"properties": {
"psbt": {
"type": "string",
"description": "Unsigned PSBT which fulfills the parameters given"
"description": "The unsigned PSBT which fulfills the parameters given."
},
"estimated_added_weight": {
"type": "u32",
"description": "The estimated weight of the added output"
"description": "The estimated weight of the added output."
},
"outnum": {
"type": "u32",
"description": "The 0-based number where the output was placed"
"description": "The 0-based number where the output was placed."
}
}
}
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ nav:
- "Man Pages":
# block_start manpages
- "lightning-addgossip": "lightning-addgossip.7.md"
- "lightning-addpsbtoutput": "lightning-addpsbtoutput.7.md"
- "lightning-autoclean-once": "lightning-autoclean-once.7.md"
- "lightning-autoclean-status": "lightning-autoclean-status.7.md"
- "lightning-batching": "lightning-batching.7.md"
Expand Down

0 comments on commit f101af3

Please sign in to comment.