Skip to content

Commit

Permalink
doc: update references to old BOLTs repo.
Browse files Browse the repository at this point in the history
This reveals that common/test/run-bolt12_merkle-json.c was broken!

Signed-off-by: Rusty Russell <[email protected]>
  • Loading branch information
rustyrussell committed Sep 29, 2022
1 parent 49fe1c8 commit 342e330
Show file tree
Hide file tree
Showing 20 changed files with 38 additions and 70 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/bsd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
pytest-custom-exit-code==0.3.0 \
pytest-json-report
git clone https://github.com/lightningnetwork/lightning-rfc.git ../lightning-rfc
git clone https://github.com/lightning/bolts.git ../bolts
# fatal: unsafe repository ('/Users/runner/work/lightning/lightning' is owned by someone else)
git config --global --add safe.directory `pwd`
git submodule update --init --recursive
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ lightning-cli invoice <amount> <label> <description>

This returns some internal details, and a standard invoice string called `bolt11` (named after the [BOLT #11 lightning spec][BOLT11]).

[BOLT11]: https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md
[BOLT11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md

The sender can feed this `bolt11` string to the `decodepay` command to see what it is, and pay it simply using the `pay` command:

Expand Down Expand Up @@ -225,7 +225,7 @@ Developers wishing to contribute should start with the developer guide [here](do
You should also configure with `--enable-developer` to get additional checks and options.

[blockstream-store-blog]: https://blockstream.com/2018/01/16/en-lightning-charge/
[std]: https://github.com/lightningnetwork/lightning-rfc
[std]: https://github.com/lightning/bolts
[prs]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat
[prs-link]: http://makeapullrequest.com
[IRC]: https://img.shields.io/badge/chat-on%20libera-brightgreen.svg
Expand Down
2 changes: 1 addition & 1 deletion common/blindedpath.c
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ static u8 *enctlv_from_encmsg_raw(const tal_t *ctx,
struct privkey *next_blinding,
struct pubkey *node_alias)
{
/* https://github.com/lightningnetwork/lightning-rfc/blob/route-blinding/proposals/route-blinding.md */
/* https://github.com/lightning/bolts/blob/route-blinding/proposals/route-blinding.md */
struct secret ss, rho;
u8 *ret;
int ok;
Expand Down
12 changes: 6 additions & 6 deletions common/features.c
Original file line number Diff line number Diff line change
Expand Up @@ -436,16 +436,16 @@ const char *feature_name(const tal_t *ctx, size_t f)
"option_support_large_channel",
"option_anchor_outputs", /* 20/21 */
"option_anchors_zero_fee_htlc_tx",
"option_trampoline_routing", /* https://github.com/lightningnetwork/lightning-rfc/pull/836 */
"option_trampoline_routing", /* https://github.com/lightning/bolts/pull/836 */
"option_shutdown_anysegwit",
"option_dual_fund",
"option_amp", /* 30/31 */ /* https://github.com/lightningnetwork/lightning-rfc/pull/658 */
"option_amp", /* 30/31 */ /* https://github.com/lightning/bolts/pull/658 */
NULL,
"option_quiesce", /* https://github.com/lightningnetwork/lightning-rfc/pull/869 */
"option_quiesce", /* https://github.com/lightning/bolts/pull/869 */
NULL,
"option_onion_messages", /* https://github.com/lightningnetwork/lightning-rfc/pull/759 */
"option_want_peer_backup", /* 40/41 */ /* https://github.com/lightningnetwork/lightning-rfc/pull/881 */
"option_provide_peer_backup", /* https://github.com/lightningnetwork/lightning-rfc/pull/881 */
"option_onion_messages", /* https://github.com/lightning/bolts/pull/759 */
"option_want_peer_backup", /* 40/41 */ /* https://github.com/lightning/bolts/pull/881 */
"option_provide_peer_backup", /* https://github.com/lightning/bolts/pull/881 */
"option_channel_type",
"option_scid_alias", /* https://github.com/lightning/bolts/pull/910 */
"option_payment_metadata",
Expand Down
2 changes: 1 addition & 1 deletion common/test/run-bolt12_decode.c
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ int main(int argc, char *argv[])
char *dir = getenv("BOLTDIR");
json = grab_file(tmpctx,
path_join(tmpctx,
dir ? dir : "../lightning-rfc",
dir ? dir : "../bolts",
"bolt12/format-string-test.json"));
if (!json) {
printf("test file not found, skipping\n");
Expand Down
36 changes: 2 additions & 34 deletions common/test/run-bolt12_merkle-json.c
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#include "../bigsize.c"
#include "../bolt12_merkle.c"
#include "../json_parse.c"
#include "../json_parse_simple.c"
#include "../../wire/fromwire.c"
#include "../../wire/tlvstream.c"
#if EXPERIMENTAL_FEATURES
Expand All @@ -28,39 +29,6 @@ void fromwire_node_id(const u8 **cursor UNNEEDED, size_t *max UNNEEDED, struct n
/* Generated stub for fromwire_onionmsg_path */
struct onionmsg_path *fromwire_onionmsg_path(const tal_t *ctx UNNEEDED, const u8 **cursor UNNEEDED, size_t *plen UNNEEDED)
{ fprintf(stderr, "fromwire_onionmsg_path called!\n"); abort(); }
/* Generated stub for json_get_arr */
const jsmntok_t *json_get_arr(const jsmntok_t tok[] UNNEEDED, size_t index UNNEEDED)
{ fprintf(stderr, "json_get_arr called!\n"); abort(); }
/* Generated stub for json_get_member */
const jsmntok_t *json_get_member(const char *buffer UNNEEDED, const jsmntok_t tok[] UNNEEDED,
const char *label UNNEEDED)
{ fprintf(stderr, "json_get_member called!\n"); abort(); }
/* Generated stub for json_get_membern */
const jsmntok_t *json_get_membern(const char *buffer UNNEEDED,
const jsmntok_t tok[] UNNEEDED,
const char *label UNNEEDED, size_t len UNNEEDED)
{ fprintf(stderr, "json_get_membern called!\n"); abort(); }
/* Generated stub for json_next */
const jsmntok_t *json_next(const jsmntok_t *tok UNNEEDED)
{ fprintf(stderr, "json_next called!\n"); abort(); }
/* Generated stub for json_strdup */
char *json_strdup(const tal_t *ctx UNNEEDED, const char *buffer UNNEEDED, const jsmntok_t *tok UNNEEDED)
{ fprintf(stderr, "json_strdup called!\n"); abort(); }
/* Generated stub for json_to_u32 */
bool json_to_u32(const char *buffer UNNEEDED, const jsmntok_t *tok UNNEEDED, u32 *num UNNEEDED)
{ fprintf(stderr, "json_to_u32 called!\n"); abort(); }
/* Generated stub for json_to_u64 */
bool json_to_u64(const char *buffer UNNEEDED, const jsmntok_t *tok UNNEEDED, u64 *num UNNEEDED)
{ fprintf(stderr, "json_to_u64 called!\n"); abort(); }
/* Generated stub for json_tok_full */
const char *json_tok_full(const char *buffer UNNEEDED, const jsmntok_t *t UNNEEDED)
{ fprintf(stderr, "json_tok_full called!\n"); abort(); }
/* Generated stub for json_tok_full_len */
int json_tok_full_len(const jsmntok_t *t UNNEEDED)
{ fprintf(stderr, "json_tok_full_len called!\n"); abort(); }
/* Generated stub for json_tok_streq */
bool json_tok_streq(const char *buffer UNNEEDED, const jsmntok_t *tok UNNEEDED, const char *str UNNEEDED)
{ fprintf(stderr, "json_tok_streq called!\n"); abort(); }
/* Generated stub for mvt_tag_str */
const char *mvt_tag_str(enum mvt_tag tag UNNEEDED)
{ fprintf(stderr, "mvt_tag_str called!\n"); abort(); }
Expand Down Expand Up @@ -151,7 +119,7 @@ int main(int argc, char *argv[])
char *dir = getenv("BOLTDIR");
json = grab_file(tmpctx,
path_join(tmpctx,
dir ? dir : "../lightning-rfc",
dir ? dir : "../bolts",
"bolt12/merkle-test.json"));
if (!json) {
printf("test file not found, skipping\n");
Expand Down
2 changes: 1 addition & 1 deletion common/test/run-bolt12_period.c
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ int main(int argc, char *argv[])
char *dir = getenv("BOLTDIR");
json = grab_file(tmpctx,
path_join(tmpctx,
dir ? dir : "../lightning-rfc",
dir ? dir : "../bolts",
"bolt12/offer-period-test.json"));
if (!json) {
printf("test file not found, skipping\n");
Expand Down
2 changes: 1 addition & 1 deletion common/test/run-route_blinding_override_test.c
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ int main(int argc, char *argv[])
char *dir = getenv("BOLTDIR");
json = grab_file(tmpctx,
path_join(tmpctx,
dir ? dir : "../lightning-rfc",
dir ? dir : "../bolts",
"bolt04/route-blinding-override-test.json"));
if (!json) {
printf("test file not found, skipping\n");
Expand Down
2 changes: 1 addition & 1 deletion common/test/run-route_blinding_test.c
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ int main(int argc, char *argv[])
char *dir = getenv("BOLTDIR");
json = grab_file(tmpctx,
path_join(tmpctx,
dir ? dir : "../lightning-rfc",
dir ? dir : "../bolts",
"bolt04/route-blinding-test.json"));
if (!json) {
printf("test file not found, skipping\n");
Expand Down
2 changes: 1 addition & 1 deletion contrib/docker/Dockerfile.tester
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ENV BITCOIN_VERSION 0.20.1
ENV ELEMENTS_VERSION 0.18.1.8

RUN useradd -ms /bin/bash tester
RUN mkdir /build /lightning-rfc && chown tester -R /build /lightning-rfc
RUN mkdir /build /bolts && chown tester -R /build /bolts
WORKDIR /build

RUN apt-get -qq update && \
Expand Down
4 changes: 2 additions & 2 deletions contrib/docker/scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

echo "Running in $(pwd)"
export ARCH=${ARCH:-64}
export BOLTDIR=lightning-rfc
export BOLTDIR=bolts
export CC=${COMPILER:-gcc}
export COMPAT=${COMPAT:-1}
export TEST_CHECK_DBSTMTS=${TEST_CHECK_DBSTMTS:-0}
Expand All @@ -26,7 +26,7 @@ pip3 install --user poetry
poetry export --dev --without-hashes -o requirements.txt
pip3 install -r requirements.txt

git clone https://github.com/lightningnetwork/lightning-rfc.git ../lightning-rfc
git clone https://github.com/lightning/bolts.git ../bolts
git submodule update --init --recursive

./configure CC="$CC"
Expand Down
2 changes: 1 addition & 1 deletion contrib/pyln-proto/tests/test_wire.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def test_primitives():

def test_encrypt_decrypt():
""" Test encryptWithAD and decryptWithAD primitives
Taken from https://github.com/lightningnetwork/lightning-rfc/blob/master/08-transport.md#initiator-tests
Taken from https://github.com/lightning/bolts/blob/master/08-transport.md#initiator-tests
"""
inp = [
b'e68f69b7f096d7917245f5e5cf8ae1595febe4d4644333c99f9c4a1282031c9f',
Expand Down
8 changes: 4 additions & 4 deletions doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ lightning-cli helpme
### How to get the balance of each channel ?

You can use the `listfunds` command and take a ratio of `our_amount_msat` over
`amount_msat`. Note that this doesn't account for the [channel reserve](https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md#rationale).
`amount_msat`. Note that this doesn't account for the [channel reserve](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#rationale).

A better option is to use the [`summary` plugin](https://github.com/lightningd/plugins/tree/master/summary)
which nicely displays channel balances, along with other useful channel information.
Expand All @@ -48,7 +48,7 @@ See the [listpeers command manpage](https://lightning.readthedocs.io/lightning-l
### My payment is failing / all my payments are failing, why ?

There are many reasons for a payment failure. The most common one is a
[failure](https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md#failure-messages)
[failure](https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages)
along the route from you to the payee.
The best (and most common) solution to a route failure problem is to open more channels,
which should increase the available routes to the recipient and lower the probability of a failure.
Expand Down Expand Up @@ -124,7 +124,7 @@ There is no single-seed backup for funds locked in channels.

While crucial for node operation, snapshot-style backups of the `lightningd` database is **discouraged**,
as _any_ loss of state may result in permanent loss of funds.
See the [penalty mechanism](https://github.com/lightningnetwork/lightning-rfc/blob/master/05-onchain.md#revoked-transaction-close-handling)
See the [penalty mechanism](https://github.com/lightning/bolts/blob/master/05-onchain.md#revoked-transaction-close-handling)
for more information on why any amount of state-loss results in fund loss.

Real-time database replication is the recommended approach to backing up node data.
Expand Down Expand Up @@ -280,7 +280,7 @@ successful, result will be a private key matching a unilaterally
closed channel, that you can import into any wallet, recovering the
funds into that wallet.
[spec-features]: https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md
[spec-features]: https://github.com/lightning/bolts/blob/master/09-features.md
[mandelbit-recovery]: https://github.com/mandelbit/bitcoin-tutorials/blob/master/CLightningRecoverFunds.md
[5366]: https://github.com/ElementsProject/lightning/issues/5366
Expand Down
4 changes: 2 additions & 2 deletions doc/HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ layers of separation between different clients and extra barriers to
exploits.

It is designed to implement the lightning protocol as specified in
[various BOLTs](https://github.com/lightningnetwork/lightning-rfc).
[various BOLTs](https://github.com/lightning/bolts).


Getting Started
Expand Down Expand Up @@ -315,7 +315,7 @@ Protocol Modifications
The source tree contains CSV files extracted from the v1.0 BOLT
specifications (wire/extracted_peer_wire_csv and
wire/extracted_onion_wire_csv). You can regenerate these by
first deleting the local copy(if any) at directory .tmp.lightning-rfc,
first deleting the local copy(if any) at directory .tmp.bolts,
setting `BOLTDIR` and `BOLTVERSION` appropriately, and finally running `make
extract-bolt-csv`. By default the bolts will be retrieved from the
directory `../bolts` and a recent git version.
Expand Down
14 changes: 7 additions & 7 deletions doc/PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -1770,13 +1770,13 @@ The plugin must broadcast it and respond with the following fields:

[jsonrpc-spec]: https://www.jsonrpc.org/specification
[jsonrpc-notification-spec]: https://www.jsonrpc.org/specification#notification
[bolt4]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
[bolt4-failure-messages]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md#failure-messages
[bolt4-failure-onion]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md#returning-errors
[bolt2-open-channel]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md#the-open_channel-message
[bolt4]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
[bolt4-failure-messages]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages
[bolt4-failure-onion]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md#returning-errors
[bolt2-open-channel]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message
[sendcustommsg]: lightning-sendcustommsg.7.html
[oddok]: https://github.com/lightningnetwork/lightning-rfc/blob/master/00-introduction.md#its-ok-to-be-odd
[spec]: [https://github.com/lightningnetwork/lightning-rfc]
[bolt9]: https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md
[oddok]: https://github.com/lightning/bolts/blob/master/00-introduction.md#its-ok-to-be-odd
[spec]: [https://github.com/lightning/bolts]
[bolt9]: https://github.com/lightning/bolts/blob/master/09-features.md
[lightning-plugin]: lightning-plugin.7.md
[pyln-client]: ../contrib/pyln-client
2 changes: 1 addition & 1 deletion doc/lightning-decodepay.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ SEE ALSO
lightning-pay(7), lightning-getroute(7), lightning-sendpay(7).

[BOLT
\#11](https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md).
\#11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md).

RESOURCES
---------
Expand Down
2 changes: 1 addition & 1 deletion doc/lightning-listchannels.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,6 @@ Main web site: <https://github.com/ElementsProject/lightning>
Lightning RFC site

- BOLT \#7:
<https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md>
<https://github.com/lightning/bolts/blob/master/07-routing-gossip.md>

[comment]: # ( SHA256STAMP:baf45b77bd2ba22e245e007b57d8e5f70d06cbf9cebf7ed1431da6a0cf6f367a)
2 changes: 1 addition & 1 deletion doc/lightning-listpeers.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,6 @@ RESOURCES

Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>
<https://github.com/lightning/bolts/blob/master/09-features.md>

[comment]: # ( SHA256STAMP:108f43815e3475b88fd9b6a4a8f868e9d729c5d7616e0b0cc2c14f8922f54955)
2 changes: 1 addition & 1 deletion doc/lightning-sendonion.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,5 +134,5 @@ RESOURCES

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

[bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
[comment]: # ( SHA256STAMP:84283d16d289b6f72ffac0fdca6791bb49ac9ec1ef2bbb06028c18453bb15f02)
2 changes: 1 addition & 1 deletion doc/lightning-sendonionmessage.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ RESOURCES

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

[bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md

[comment]: # ( SHA256STAMP:200de829c6635242cb2dd8ec0650c2fa8f5fcbf413f4a704884516df80492fcb)

0 comments on commit 342e330

Please sign in to comment.