From e4720e247164555c3667a8c63b347aaa92c671be Mon Sep 17 00:00:00 2001 From: Ivan Vandot Date: Wed, 18 Nov 2020 21:17:06 +0100 Subject: [PATCH] change ports (#98) --- docs/advanced/persistence.md | 4 +- docs/advanced/pss.md | 48 +++++++-------- docs/advanced/starting-a-test-network.md | 36 +++++------ docs/advanced/swap.md | 14 ++--- docs/advanced/tags.md | 6 +- docs/api-reference/api-reference.md | 6 +- docs/bee-developers/useful-dev-info.md | 6 +- .../host-your-website-using-ENS.md | 2 +- docs/getting-started/store-with-encryption.md | 4 +- docs/getting-started/upload-a-directory.md | 6 +- docs/getting-started/upload-and-download.md | 8 +-- .../getting-started/working-with-your-node.md | 6 +- docs/installation/configuration.md | 14 ++--- docs/installation/connectivity.md | 60 +++++++++---------- docs/installation/docker.md | 18 +++--- static/api/index.html | 38 ++++++------ static/debug-api/index.html | 50 ++++++++-------- 17 files changed, 163 insertions(+), 163 deletions(-) diff --git a/docs/advanced/persistence.md b/docs/advanced/persistence.md index b4ef3ac83..b8390793c 100644 --- a/docs/advanced/persistence.md +++ b/docs/advanced/persistence.md @@ -17,7 +17,7 @@ It is possible to instruct your node never to delete certain chunks, by locally Locally pinning a chunk is best done upon upload by passing the `swarm-pin` header to the upload you are doing. As an example, you can upload a file and pin it at the same time by using ```sh -curl -H "Content-Type: image/x-jpeg" -H "swarm-pin: true" --data-binary @kitten.jpg localhost:8080/files?name=cat.jpg +curl -H "Content-Type: image/x-jpeg" -H "swarm-pin: true" --data-binary @kitten.jpg localhost:1633/files?name=cat.jpg ``` ## Persistence in the network by global pinning @@ -57,7 +57,7 @@ To make use of the global pinning feature (and request a repair if a chunk not f An example of a request to download a file with the targets query parameter passed in: ```sh -curl http://localhost:8080/files/3b2791985f102fe645d1ebd7f51e522d277098fcd86526674755f762084b94ee?targets= +curl http://localhost:1633/files/3b2791985f102fe645d1ebd7f51e522d277098fcd86526674755f762084b94ee?targets= ``` If your chunk is not found in the network, but you sent a request to the passed-in target for repair then you get a `202` response back, indicating that the request has been accepted for processing. diff --git a/docs/advanced/pss.md b/docs/advanced/pss.md index e5b3706b1..da9f11476 100644 --- a/docs/advanced/pss.md +++ b/docs/advanced/pss.md @@ -14,7 +14,7 @@ Once your Bee node is up and running, you will be able to subscribe to feeds usi Here we subscribe to the topic `test-topic` ```sh -websocat ws://localhost:8080/pss/subscribe/test-topic +websocat ws://localhost:1633/pss/subscribe/test-topic ``` Our node is now watching for new messages received in it's nearest neighbourhood. @@ -37,7 +37,7 @@ For example, if we want to send a PSS message with **topic** `test-topic` to a n ```sh curl -XPOST \ -localhost:8082/pss/send/test/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd \ +localhost:1833/pss/send/test/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd \ --data "Hello Swarm" ``` @@ -51,28 +51,28 @@ Run the following command to start the first node. Note that we are passing `""` ```sh bee start \ - --api-addr=:8082 \ + --api-addr=:1833 \ --debug-api-enable \ - --debug-api-addr=:6062 \ + --debug-api-addr=:1835 \ --data-dir=/tmp/bee2 \ --bootnode="" \ - --p2p-addr=:7072 \ + --p2p-addr=:1834 \ --swap-enable=false ``` We must make a note of the Swarm overlay address, underlay address and public key which are created once each node has started. We find this information from the addresses endpoint of the Debug API. ```sh -curl -s localhost:6062/addresses | jq +curl -s localhost:1835/addresses | jq ``` ```json { "overlay": "7bc50a5d79cb69fa5a0df519c6cc7b420034faaa61c175b88fc4c683f7c79d96", "underlay": [ - "/ip4/127.0.0.1/tcp/7072/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr", - "/ip4/192.168.0.10/tcp/7072/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr", - "/ip6/::1/tcp/7072/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr" + "/ip4/127.0.0.1/tcp/1834/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr", + "/ip4/192.168.0.10/tcp/1834/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr", + "/ip6/::1/tcp/1834/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr" ], "ethereum": "0x0000000000000000000000000000000000000000", "public_key": "0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd" @@ -83,26 +83,26 @@ Now the same for the second node. ```sh bee start \ - --api-addr=:8083 \ + --api-addr=:1933 \ --debug-api-enable \ - --debug-api-addr=:6063 \ + --debug-api-addr=:1935 \ --data-dir=/tmp/bee3 \ --bootnode="" \ - --p2p-addr=:7073 \ + --p2p-addr=:1934 \ --swap-enable=false ``` ```sh -curl -s localhost:6063/addresses | jq +curl -s localhost:1935/addresses | jq ``` ```json { "overlay": "a231764383d7c46c60a6571905e72021a90d506ef8db06750f8a708d93fe706e", "underlay": [ - "/ip4/127.0.0.1/tcp/7073/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq", - "/ip4/192.168.0.10/tcp/7073/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq", - "/ip6/::1/tcp/7073/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq", + "/ip4/127.0.0.1/tcp/1934/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq", + "/ip4/192.168.0.10/tcp/1934/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq", + "/ip6/::1/tcp/1934/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq", "/ip4/81.98.94.4/tcp/25178/p2p/16Uiu2HAmAqJkKJqZjNhuDtepc8eBANM9TvagaWUThfTN5NkfmKTq" ], "ethereum": "0x0000000000000000000000000000000000000000", @@ -113,11 +113,11 @@ curl -s localhost:6063/addresses | jq Because we configured the nodes to start with no bootnodes, neither node should have peers yet. ```sh -curl -s localhost:6062/peers | jq +curl -s localhost:1835/peers | jq ``` ```sh -curl -s localhost:6063/peers | jq +curl -s localhost:1935/peers | jq ``` ```json @@ -130,13 +130,13 @@ Let's connect node 2 to node 1 using the localhost (127.0.0.1) underlay address ```sh curl -XPOST \ - localhost:6063/connect/ip4/127.0.0.1/tcp/7072/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr + localhost:1935/connect/ip4/127.0.0.1/tcp/1834/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr ``` Now, if we check our peers endpoint for node 1, we can see our nodes are now peered together. ```sh -curl -s localhost:6062/peers | jq +curl -s localhost:1835/peers | jq ``` ```json @@ -152,7 +152,7 @@ curl -s localhost:6062/peers | jq Of course, since we are p2p, node 2 will show node 1 as a peer too. ```sh -curl -s localhost:6063/peers | jq +curl -s localhost:1935/peers | jq ``` ```json @@ -168,7 +168,7 @@ curl -s localhost:6063/peers | jq We will use `websocat` to listen for PSS messages topic ID `test-topic` on our first node. ```sh -websocat ws://localhost:8082/pss/subscribe/test-topic +websocat ws://localhost:1833/pss/subscribe/test-topic ``` Now we can use PSS to send a message from our second node to our first node. @@ -177,14 +177,14 @@ Since our first node has a 2 byte address prefix of `a231`, we will specify this ```sh curl \ - -XPOST "localhost:8083/pss/send/test-topic/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd"\ + -XPOST "localhost:1933/pss/send/test-topic/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd"\ --data "Hello Swarm" ``` The PSS API endpoint will now create a PSS message for it's recipient in the form of a 'Trojan Chunk' and send this into the network so that it may be pushed to the correct neighbourhood. Once it is received by it's destination target it will be decrypted and determined to be a message with the topic we are listening for. Our second node will decrypt the data and we'll see a message pop up in our `websocat` console! ```sh -sig :: ~ ยป websocat ws://localhost:8082/pss/subscribe/test-topic +sig :: ~ ยป websocat ws://localhost:1833/pss/subscribe/test-topic Hello Swarm ``` diff --git a/docs/advanced/starting-a-test-network.md b/docs/advanced/starting-a-test-network.md index dfbfa0c29..b3025aaf2 100644 --- a/docs/advanced/starting-a-test-network.md +++ b/docs/advanced/starting-a-test-network.md @@ -12,9 +12,9 @@ Starting a network is easiest achieved by making use of configuration files. We **config_1.yaml** ```yaml network-id: 7357 -api-addr: :8080 -p2p-addr: :7070 -debug-api-addr: 127.0.0.1:6060 +api-addr: :1633 +p2p-addr: :1634 +debug-api-addr: 127.0.0.1:1635 debug-api-enable: true bootnode: "" data-dir: /tmp/bee/node1 @@ -25,9 +25,9 @@ swap-enable: false **config_2.yaml** ```yaml network-id: 7357 -api-addr: :8081 -p2p-addr: :7071 -debug-api-addr: 127.0.0.1:6061 +api-addr: :1733 +p2p-addr: :1734 +debug-api-addr: 127.0.0.1:1735 debug-api-enable: true data-dir: /tmp/bee/node2 bootnode: "" @@ -49,12 +49,12 @@ We can now inspect the state of our network by sending HTTP requests to the [Deb ```sh -curl -s http://localhost:6060/topology | jq .connected +curl -s http://localhost:1635/topology | jq .connected > 0 ``` ```sh -curl -s http://localhost:6061/topology | jq .connected +curl -s http://localhost:1735/topology | jq .connected > 0 ``` @@ -70,16 +70,16 @@ In order to create a network from our two isolated nodes, we must first instruct First, we will need to find out the network address of the first node. To do this, we send a HTTP request to the `addresses` endpoint of the Debug API. ```sh -curl localhost:6060/addresses | jq +curl localhost:1635/addresses | jq ``` ```json { "overlay": "f57a65207f5766084d3ebb6bea5e2e4a712504e54d86a00961136b514f07cdac", "underlay": [ - "/ip4/127.0.0.1/tcp/7070/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs", - "/ip4/192.168.0.10/tcp/7070/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs", - "/ip6/::1/tcp/7070/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs", + "/ip4/127.0.0.1/tcp/1634/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs", + "/ip4/192.168.0.10/tcp/1634/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs", + "/ip6/::1/tcp/1634/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs", "/ip4/xx.xx.xx.xx/tcp/40317/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs" ] } @@ -92,12 +92,12 @@ Note the addresses starting with an `/ip4`, followed by `127.0.0.1`, which is th **config_2.yaml** ```yaml network-id: 7357 -api-addr: :8081 -p2p-addr: :7071 -debug-api-addr: 127.0.0.1:6061 +api-addr: :1733 +p2p-addr: :1734 +debug-api-addr: 127.0.0.1:1735 debug-api-enable: true data-dir: /tmp/bee/node2 -bootnode: "/ip4/127.0.0.1/tcp/7070/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs" +bootnode: "/ip4/127.0.0.1/tcp/1634/p2p/16Uiu2HAmUdCRWmyQCEahHthy7G4VsbBQ6dY9Hnk79337NfadKJEs" password: some pass phze welcome-message: "Bzz Bzz Bzz" swap-enable: false @@ -110,11 +110,11 @@ Look at the the output for your first node, you should see our connection messag Let's also verify that we can see both nodes in using each other's Debug API's. ```sh -curl -s http://localhost:6060/peers | jq +curl -s http://localhost:1635/peers | jq ``` ```sh -curl -s http://localhost:6060/peers | jq +curl -s http://localhost:1635/peers | jq ``` Congratulations! You have made your own tiny two bee Swarm! ๐Ÿ ๐Ÿ \ No newline at end of file diff --git a/docs/advanced/swap.md b/docs/advanced/swap.md index 8c28aa553..040594f52 100644 --- a/docs/advanced/swap.md +++ b/docs/advanced/swap.md @@ -24,7 +24,7 @@ bee start \ ```sh dd if=/dev/urandom of=/tmp/test.txt bs=1m count=20 -curl -F file=@/tmp/test.txt http://localhost:8080/files +curl -F file=@/tmp/test.txt http://localhost:1633/files ``` If we set `--verbosity 5` in our Bee configuration, we will be able to see these individual transactions being recorded on our node's internal per peer ledgers. @@ -47,7 +47,7 @@ TRAC[2020-09-28T15:18:08+01:00] crediting peer f1e2872581de18bdc68060dc8edd3aa96 We also have a rich set of features to be able to query the current accounting state of your node. For example, you may query your node's current balance by send a POST request to the balances endpoint. ```sh -curl localhost:6060/chequebook/balance | jq +curl localhost:1635/chequebook/balance | jq ``` ```json @@ -60,7 +60,7 @@ curl localhost:6060/chequebook/balance | jq It is also possible to examine per-peer balances. ```sh -curl localhost:6060/balances | jq +curl localhost:1635/balances | jq ``` ```json @@ -83,7 +83,7 @@ curl localhost:6060/balances | jq In Swarm, these per-peer balances simply represent trustful agreements between nodes. Tokens only actually change hands when a node settles a cheque. This can either be triggered manually or when a certain threshold is reached with a peer. In this case, a settlement takes place. You may view these using the settlements endpoint. ```sh -curl localhost:6060/settlements | jq +curl localhost:1635/settlements | jq ``` ```json @@ -110,7 +110,7 @@ curl localhost:6060/settlements | jq More info can be found by using the chequebook api. ```sh -curl localhost:6060/chequebook/cheque | jq +curl localhost:1635/chequebook/cheque | jq ``` ```json @@ -134,7 +134,7 @@ As our node's participation in the network increases, we will begin to see more To do this, we simply POST the relevant peer's address to the `cashout` endpoint. ```sh -curl -XPOST http://localhost:6060/chequebook/cashout/d7881307e793e389642ea733451db368c4c9b9e23f188cca659c8674d183a56b +curl -XPOST http://localhost:1635/chequebook/cashout/d7881307e793e389642ea733451db368c4c9b9e23f188cca659c8674d183a56b ``` ```json @@ -146,7 +146,7 @@ You may check the status of your transaction using [Goerli Etherscan](https://go Finally, we can now see the status of the cashout transaction by sending a GET request to the same URL. ```sh -curl http://localhost:6060/chequebook/cashout/d7881307e793e389642ea733451db368c4c9b9e23f188cca659c8674d183a56b | jq +curl http://localhost:1635/chequebook/cashout/d7881307e793e389642ea733451db368c4c9b9e23f188cca659c8674d183a56b | jq ``` ```json diff --git a/docs/advanced/tags.md b/docs/advanced/tags.md index e4cc6182a..ce2dffc4e 100644 --- a/docs/advanced/tags.md +++ b/docs/advanced/tags.md @@ -32,14 +32,14 @@ To follow the status of your upload while it is splitting you must generate the Create a tag by sending a POST request to the `tag` API endpoint: ```console -curl -s -XPOST http://localhost:8080/tags | jq .uid +curl -s -XPOST http://localhost:1633/tags | jq .uid > 4074122506 ``` Use the returned UID to instruct your POST upload request to track this upload using the `Swarm-Tag-UID` header: ```console -curl -F file=@bee.jpg -H "Swarm-Tag-UID: 4074122506" http://localhost:8080/files +curl -F file=@bee.jpg -H "Swarm-Tag-UID: 4074122506" http://localhost:1633/files ``` :::info @@ -53,7 +53,7 @@ You can use `curl --verbose` to view the HTTP response headers such as the `Swar To get the current status of an upload, send a GET request to the `tag/` API endpoint. ```console -curl http://localhost:8080/tags/4074122506 | jq +curl http://localhost:1633/tags/4074122506 | jq ``` The response contains all the information that you need to follow the status of your file as it is synced with the network. diff --git a/docs/api-reference/api-reference.md b/docs/api-reference/api-reference.md index 42ccd45e1..7cdccdaf7 100644 --- a/docs/api-reference/api-reference.md +++ b/docs/api-reference/api-reference.md @@ -6,7 +6,7 @@ id: api-reference The Bee node exposes two HTTP API endpoints, the `API` and the `DebugAPI`. These endpoints are the your primary interfaces to a *running* Bee node. API-endpoints can be queried using familiar HTTP requests, and will respond with a semantically accurate [HTTP status and error codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) as well as data payloads in [JSON](https://www.json.org/json-en.html) format where appropriate. ## API -The API-endpoint exposes all functionality to upload and download content to and from the Swarm network. By default, it runs on port `:8080`. +The API-endpoint exposes all functionality to upload and download content to and from the Swarm network. By default, it runs on port `:1633`. Detailed information about Bee API endpoint can be found here: @@ -14,10 +14,10 @@ Detailed information about Bee API endpoint can be found here: ## Debug API -The debug-API is disabled by default but be enabled by setting the `enable-debug-api` configuration option to `true`. The debug-API exposes functionality to inspect the state of your Bee node while it is running, as well as some other features that should not be exposed to the public internet. The Debug API runs on port `:6060` by default. +The debug-API is disabled by default but be enabled by setting the `enable-debug-api` configuration option to `true`. The debug-API exposes functionality to inspect the state of your Bee node while it is running, as well as some other features that should not be exposed to the public internet. The Debug API runs on port `:1635` by default. - Debug API reference., :::danger -Your Debug API should not be exposed to the public internet, make sure that your network has a firewall which blocks port `6060`, or bind the Debug API to `localhost` +Your Debug API should not be exposed to the public internet, make sure that your network has a firewall which blocks port `1635`, or bind the Debug API to `localhost` ::: diff --git a/docs/bee-developers/useful-dev-info.md b/docs/bee-developers/useful-dev-info.md index 45997a174..b20c68709 100644 --- a/docs/bee-developers/useful-dev-info.md +++ b/docs/bee-developers/useful-dev-info.md @@ -18,7 +18,7 @@ Installation from source is described in the [Installation](/docs/installation/b To check if two nodes are connected and to see the round trip time for message exchange between them, get the overlay address from one node, for example local node 2: ```sh -curl localhost:6062/addresses +curl localhost:1835/addresses ``` Make sure that Debug API is enabled and address configured as in examples above. @@ -26,7 +26,7 @@ Make sure that Debug API is enabled and address configured as in examples above. And use that address in the Debug API call on another node, for example, local node 1: ```sh -curl -XPOST localhost:6061/pingpong/d4440baf2d79e481c3c6fd93a2014d2e6fe0386418829439f26d13a8253d04f1 +curl -XPOST localhost:1735/pingpong/d4440baf2d79e481c3c6fd93a2014d2e6fe0386418829439f26d13a8253d04f1 ``` # Generating protobuf @@ -51,6 +51,6 @@ Developers can gain an additional level of insight into the node by enabling `tr - start locally two bee nodes (different data dirs and ports) and connect them (see "Start a test network" in the [advanced section](/docs/advanced/starting-a-test-network)) with `--tracing` flag provided for both nodes -- Make a call to the PingPong API on one of the two nodes (`curl -XPOST localhost:6061/pingpong/`). +- Make a call to the PingPong API on one of the two nodes (`curl -XPOST localhost:1735/pingpong/`). Validate tracing in the web interface (`http://localhost:16686/`). diff --git a/docs/getting-started/host-your-website-using-ENS.md b/docs/getting-started/host-your-website-using-ENS.md index 593d0a6de..d4b92574b 100644 --- a/docs/getting-started/host-your-website-using-ENS.md +++ b/docs/getting-started/host-your-website-using-ENS.md @@ -31,7 +31,7 @@ curl \ -H "Content-Type: application/x-tar" \ -H "Swarm-Index-Document: index.html" \ -H "Swarm-Error-Document: index.html" \ - --data-binary @my_website.tar http://localhost:8080/dirs + --data-binary @my_website.tar http://localhost:1633/dirs ``` ```json diff --git a/docs/getting-started/store-with-encryption.md b/docs/getting-started/store-with-encryption.md index 4952b3f20..68d28d82c 100644 --- a/docs/getting-started/store-with-encryption.md +++ b/docs/getting-started/store-with-encryption.md @@ -12,7 +12,7 @@ The Bee client provides a facility to encrypt files and directories while upload To encrypt a file simply include the `Swarm-Encrypt: true` header with your HTTP request. ```sh -$ curl -F file=@bee.jpg -H "Swarm-Encrypt: true" http://localhost:8080/files +$ curl -F file=@bee.jpg -H "Swarm-Encrypt: true" http://localhost:1633/files ``` When successful, the Bee client will return a 64 byte reference, instead of the usual 32 bytes. @@ -36,7 +36,7 @@ Encryption is disabled by default on all Swarm Gateways to keep your data safe. To retrieve your file, simply supply the full 64 byte string to the files endpoint, and the Bee client will download and decrypt all the relevant chunks and restore them to their original format. ```sh -$ curl -OJ http://localhost:8080/files/f7b1a45b70ee91d3dbfd98a2a692387f24db7279a9c96c447409e9205cf265baef29bf6aa294264762e33f6a18318562c86383dd8bfea2cec14fae08a8039bf3 +$ curl -OJ http://localhost:1633/files/f7b1a45b70ee91d3dbfd98a2a692387f24db7279a9c96c447409e9205cf265baef29bf6aa294264762e33f6a18318562c86383dd8bfea2cec14fae08a8039bf3 ``` :::danger diff --git a/docs/getting-started/upload-a-directory.md b/docs/getting-started/upload-a-directory.md index ccf6b1ea6..c0fcecccd 100644 --- a/docs/getting-started/upload-a-directory.md +++ b/docs/getting-started/upload-a-directory.md @@ -37,7 +37,7 @@ Next, simply POST the `tar` file as binary data to Bee's `dir` endpoint, taking curl \ -X POST \ -H "Content-Type: application/x-tar" \ - --data-binary @my_website.tar http://localhost:8080/dirs + --data-binary @my_website.tar http://localhost:1633/dirs ``` When the upload is successful, Bee will return a json document containing the Swarm Reference. @@ -48,11 +48,11 @@ When the upload is successful, Bee will return a json document containing the Sw Now, simply navigate your browser to view the reference using the `bzz` endpoint and your website will be served! -[http://localhost:8080/bzz/b25c89a...214917b/index.html](http://localhost:8080/bzz/b25c89a401d9f26811680476619a1eb4a4e189e614bc6161cbfd8b343214917b/index.html) +[http://localhost:1633/bzz/b25c89a...214917b/index.html](http://localhost:1633/bzz/b25c89a401d9f26811680476619a1eb4a4e189e614bc6161cbfd8b343214917b/index.html) Other files are served at their relative paths, e.g. -[http://localhost:8080/bzz/b25c89a...214917b/assets/style.css](http://localhost:8080/bzz/b25c89a401d9f26811680476619a1eb4a4e189e614bc6161cbfd8b343214917b/assets/style.css) +[http://localhost:1633/bzz/b25c89a...214917b/assets/style.css](http://localhost:1633/bzz/b25c89a401d9f26811680476619a1eb4a4e189e614bc6161cbfd8b343214917b/assets/style.css) Once your data has been [fully processed into the network](/docs/advanced/tags), you will then be able to retrieve it from any Bee node. diff --git a/docs/getting-started/upload-and-download.md b/docs/getting-started/upload-and-download.md index 5acedd619..432ce6dbe 100644 --- a/docs/getting-started/upload-and-download.md +++ b/docs/getting-started/upload-and-download.md @@ -12,14 +12,14 @@ Once your Bee node is running, a HTTP API is enabled for you to interact with. T First, let's check to see if the API is running as expected... ```sh -curl http://localhost:8080 +curl http://localhost:1633 > Ethereum Swarm Bee ``` Once running, a file can be uploaded by making an HTTP POST request to the `files` endpoint of the Bee API. ```sh -curl -F file=@bee.jpg http://localhost:8080/files +curl -F file=@bee.jpg http://localhost:1633/files ``` where `bee.jpg` is the path to the file that you would like to upload. @@ -49,12 +49,12 @@ Once your file is uploaded into Swarm, it can be retrieved with a simple HTTP GE Substitute the *hash* in the last part of the url to be the reference to your own data. ```sh -curl -OJ http://localhost:8080/files/042d4fe94b946e2cb51196a8c136b8cc335156525bf1ad7e86356c2402291dd4 +curl -OJ http://localhost:1633/files/042d4fe94b946e2cb51196a8c136b8cc335156525bf1ad7e86356c2402291dd4 ``` You may even simply navigate to the URL in your browser: -[http://localhost:8080/files/042d4fe...2291dd4](http://localhost:8080/files/042d4fe94b946e2cb51196a8c136b8cc335156525bf1ad7e86356c2402291dd4) +[http://localhost:1633/files/042d4fe...2291dd4](http://localhost:1633/files/042d4fe94b946e2cb51196a8c136b8cc335156525bf1ad7e86356c2402291dd4) ## Public Gateways diff --git a/docs/getting-started/working-with-your-node.md b/docs/getting-started/working-with-your-node.md index feed60281..43414ecd2 100644 --- a/docs/getting-started/working-with-your-node.md +++ b/docs/getting-started/working-with-your-node.md @@ -16,7 +16,7 @@ Never expose your Debug API to the public internet, make sure to use a firewall To use the Debug API we must first configure Bee to enable it, as it is disabled by default. ```sh -$ bee start --debug-api-enable --debug-api-addr=localhost:6060 +$ bee start --debug-api-enable --debug-api-addr=localhost:1635 ``` #### Checking Connectivity @@ -24,7 +24,7 @@ $ bee start --debug-api-enable --debug-api-addr=localhost:6060 First, let's check how many nodes we are currently connected to. ```sh -curl -s http://localhost:6060/peers | jq '.peers | length' +curl -s http://localhost:1635/peers | jq '.peers | length' 23 ``` @@ -39,7 +39,7 @@ Here we are using the `jq` command line utility to count the amount of objects i We can gain even more insight into how your Bee client is becoming a part of the global network your using the `topology` endpoint. ```sh -curl -X GET http://localhost:6060/topology | jq +curl -X GET http://localhost:1635/topology | jq ``` In this example, our node is beginning to form a healthy network. We hope to see our node adding and connecting to nodes in as many bins as possible. Learn more about promiximity order bins and how your Bee node becomes part of the ordered p2p network in [The Book of Swarm](/docs/find-out-more/the-book-of-swarm). diff --git a/docs/installation/configuration.md b/docs/installation/configuration.md index 3995c9c94..6e567042e 100644 --- a/docs/installation/configuration.md +++ b/docs/installation/configuration.md @@ -47,7 +47,7 @@ bee printconfig \ This produces the following file contents, showing the default configuration of Bee, with some added log verbosity: ```yaml -api-addr: :8080 +api-addr: :1633 bootnode: - /dnsaddr/bootnode.ethswarm.org clef-signer-enable: false @@ -56,14 +56,14 @@ config: /Users/sig/.bee.yaml cors-allowed-origins: [] data-dir: /Users/sig/.bee db-capacity: "5000000" -debug-api-addr: :6060 +debug-api-addr: :1635 debug-api-enable: false gateway-mode: false global-pinning-enable: false help: false nat-addr: "" network-id: "1" -p2p-addr: :7070 +p2p-addr: :1634 p2p-quic-enable: false p2p-ws-enable: false password: "" @@ -100,9 +100,9 @@ The location of a yaml configuration file containing configuration instructions. #### --api-addr -*default* :8080 +*default* :1633 -The ip and port the API will serve http requests from. Ommiting the IP part of the address will cause the server to listen to all requests. Argument values are of the form '132.132.132.132:8080'. +The ip and port the API will serve http requests from. Ommiting the IP part of the address will cause the server to listen to all requests. Argument values are of the form '132.132.132.132:1633'. #### --bootnode @@ -169,7 +169,7 @@ Chunk database capacity in chunks. A chunk is 4096 kb in size, so the total data #### --debug-api-addr -*default* `:6060` +*default* `:1635` The IP and port the [Debug API](/docs/api-reference/api-reference) will serve http requests from. @@ -210,7 +210,7 @@ The network ID for which to accept new connections. Set to 1 for mainnet. #### --p2p-addr -*default* `:7070` +*default* `:1634` The ip and port to listen for p2p protocol messages. diff --git a/docs/installation/connectivity.md b/docs/installation/connectivity.md index 5bf9a2f58..5994b75a5 100644 --- a/docs/installation/connectivity.md +++ b/docs/installation/connectivity.md @@ -14,10 +14,10 @@ In a network, each computer is assigned an IP. Each IP is then subdivided into t In a completely trusted network of computers, connections to or from any of these ports are allowed. However, to protect ourselves from nefarious actors when we join the wider internet, it is sometimes important to filter this traffic so that some of these ports are off limits to the public. -In order to allow other Bee nodes we have previously not met to be able to send messages to our p2p port, usually `7070`, we must ensure that our network is set up to receive incoming connections. +In order to allow other Bee nodes we have previously not met to be able to send messages to our p2p port, usually `1634`, we must ensure that our network is set up to receive incoming connections. :::info -There are also some ports which you should never expose to the outside internet. Make sure that your `api-addr`, usually port `8080` is only exposed in `Gateway Mode` and your `--debug-api-addr`, usually `6060` is never exposed to the internet. It is good practice to employ one or more firewalls which block traffic on every port except for those for whom you are expecting it. +There are also some ports which you should never expose to the outside internet. Make sure that your `api-addr`, usually port `1633` is only exposed in `Gateway Mode` and your `--debug-api-addr`, usually `1635` is never exposed to the internet. It is good practice to employ one or more firewalls which block traffic on every port except for those for whom you are expecting it. ::: ## Your IP @@ -101,20 +101,20 @@ UPNP can be considered a security risk as it exposes your (real) public IP to an Bee will use UPNP to determine your public IP, which is required for various internal processes. -In addition to this, a request will be sent to your router to ask it to forward a random one of it's ports, which are exposed directly to the internet, to the Bee p2p port (usually `7070`) which your computer is exposing only to the private network. Doing this creates a tunnel through which other Bee's may connect to your computer safely. +In addition to this, a request will be sent to your router to ask it to forward a random one of it's ports, which are exposed directly to the internet, to the Bee p2p port (usually `1634`) which your computer is exposing only to the private network. Doing this creates a tunnel through which other Bee's may connect to your computer safely. If you start your Bee node in a private network with UPNP available, the output of the addresses endpoint of your debug API will look something like this: ```json [ - "/ip4/127.0.0.1/tcp/7070/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP", - "/ip4/192.168.0.10/tcp/7070/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP", - "/ip6/::1/tcp/7070/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP", + "/ip4/127.0.0.1/tcp/1634/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP", + "/ip4/192.168.0.10/tcp/1634/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP", + "/ip6/::1/tcp/1634/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP", "/ip4/86.98.94.9/tcp/20529/p2p/16Uiu2HAm5zcoBFWmqjDTwGy9RXepBFF8idy6Pr312obMwwxdJSUP" ] ``` -Note that the port in the external [multiaddress](https://docs.libp2p.io/concepts/addressing/) is the router's randomly selected `20529` which is forwarded by the router to `192.168.0.10:7070`. +Note that the port in the external [multiaddress](https://docs.libp2p.io/concepts/addressing/) is the router's randomly selected `20529` which is forwarded by the router to `192.168.0.10:1634`. ##### Manual: Configure Your Router and Bee @@ -122,9 +122,9 @@ Inspecting the underlay addresses in the output of the addresses endpoint our de ```sh [ - "/ip4/127.0.0.1/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", - "/ip4/192.168.0.10/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", - "/ip6/::1/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", + "/ip4/127.0.0.1/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", + "/ip4/192.168.0.10/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", + "/ip6/::1/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", ] ``` @@ -146,24 +146,24 @@ Each router is different, but the concept is usually the same. Log in to your ro Once logged in, find the interface to set up port forwarding. The [Port Forward](https://portforward.com/router.htm) website provides some good information, or you may refer to your router manual or provider. -Here, we will then set up a rule that forwards port `7070` of our internal IP `192.168.0.10` to the same port `7070` of our external IP. +Here, we will then set up a rule that forwards port `1634` of our internal IP `192.168.0.10` to the same port `1634` of our external IP. -Now, when requests arrive at our external address `86.98.94.9:7070` they are modified by our router and forwarded to our internal IP and port `192.168.0.10:7070`. +Now, when requests arrive at our external address `86.98.94.9:1634` they are modified by our router and forwarded to our internal IP and port `192.168.0.10:1634`. Sometimes this can be a little tricky, so let's verify we are able to make a TCP connection using [netcat](https://nmap.org/ncat/). First, with Bee **not** running, let's set up a simple TCP listener using Netcat on the same machine we would like to run Bee on. ```sh -nc -l 0.0.0.0 7070 +nc -l 0.0.0.0 1634 ``` ```sh -nc -zv 86.98.94.9 7070 +nc -zv 86.98.94.9 1634 ``` ``` -Connection to 86.98.94.9 port 7072 [tcp/*] succeeded! +Connection to 86.98.94.9 port 1834 [tcp/*] succeeded! ``` Success! โœจ @@ -172,17 +172,17 @@ If this didn't work for you, check out our [Debugging Connectivity]() guide belo If it did, let's start our Bee node with the `--nat-addr` configured. ```sh -bee start --nat-addr 86.98.94.9:7070 +bee start --nat-addr 86.98.94.9:1634 ``` Checking our addresses endpoint again, we can now see that Bee has been able to successfully assign a public address! Congratulations, your Bee is now connected to the outside world! ```sh [ - "/ip4/127.0.0.1/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", - "/ip4/192.168.0.10/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", - "/ip6/::1/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", - "/ip4/86.98.94.9/tcp/7070/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB" + "/ip4/127.0.0.1/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", + "/ip4/192.168.0.10/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", + "/ip6/::1/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB", + "/ip4/86.98.94.9/tcp/1634/p2p/16Uiu2HAm8Hs91MzWuXfUyKrYaj3h8K8gzvRqzSK5gP9TNCwypkJB" ] ``` @@ -197,23 +197,23 @@ The above guide navigates your NAT, but there are still a few hurdles to overcom Let's set up a Netcat listener on all interfaces on the computer we'd like to run Bee on as we have above. ```sh -nc -l 0.0.0.0 7070 +nc -l 0.0.0.0 1634 ``` Now, let's verify we're above to test this by checking the connection on our local machine. ```sh -nc -zv 127.0.0.1 7070 +nc -zv 127.0.0.1 1634 ``` ``` -nc -zv 127.0.0.1 7070 -Connection to 127.0.0.1 port 7070 [tcp/*] succeeded! +nc -zv 127.0.0.1 1634 +Connection to 127.0.0.1 port 1634 [tcp/*] succeeded! ``` This should be a no brainer, the connection between localhost in not normally mediated. -If there is a problem here, the problem is with some other software running on your operating system or your operating system itself. Try a different port, such as `7071` and turning off any unneccesary software. If this doesn't work, you may need to try a different operating system environment. Please get in touch and we'll try to help! +If there is a problem here, the problem is with some other software running on your operating system or your operating system itself. Try a different port, such as `1734` and turning off any unneccesary software. If this doesn't work, you may need to try a different operating system environment. Please get in touch and we'll try to help! If we were successful, let's move on to the next stage. @@ -235,7 +235,7 @@ curl icanhazip.com Now try to connect to your port using the global IP. ```sh -nc -zv 86.98.94.9 7070 +nc -zv 86.98.94.9 1634 ``` If this is successful, our Bee node's path is clear! @@ -244,11 +244,11 @@ If not, we can try a few things to make sure there are no barriers stopping us f 1. Check your computers firewall. -Sometimes your computer is configured to prevent connections. If you are on a private network mediated by NAT, you can check if this is the problem by trying to connect from another device on your network using the local IP `nc -zv 192.168.0.10 7070`. +Sometimes your computer is configured to prevent connections. If you are on a private network mediated by NAT, you can check if this is the problem by trying to connect from another device on your network using the local IP `nc -zv 192.168.0.10 1634`. Ubuntu uses [UFW](https://help.ubuntu.com/community/UFW), MacOS can be configured using the *Firewall* tab in the *Security & Privacy* section of *System Preferences*. Windows uses [Defender Firewall](https://support.microsoft.com/en-us/help/4028544/windows-10-turn-microsoft-defender-firewall-on-or-off). -For each of these firewalls, set a special rule to allow UDP and TCP traffic to pass through on port `7070`. You may want to limit this traffic to the Bee application only. +For each of these firewalls, set a special rule to allow UDP and TCP traffic to pass through on port `1634`. You may want to limit this traffic to the Bee application only. 2. Check your ingress firewall. @@ -256,13 +256,13 @@ For a datacenter hired server, this configuration will often take place in somew Similarly, if you are connecting from within a private network, you may find that the port is blocked by the router. Each router is different, so consult your router's firware documentation to make sure there are no firewalls in place blocking traffic on your Bee's designated p2p port. -You may check this using Netcat by trying to connect using your computer's public IP, as above `nc -zv 86.98.94.9 7070`. +You may check this using Netcat by trying to connect using your computer's public IP, as above `nc -zv 86.98.94.9 1634`. 3. Docker Docker adds another level of complexity. -To debug docker connectivity issues, we may use netcat as above to check port connections are working as expected. Double check that you are exposing the right ports to your local network, either by using the command line flags or in your docker-compose.yaml. You should be able to successfully check the connection locally using eg. `nc -zv localhost 7070` then follow instructions above to make sure your local network has the correct ports exposed to the internet. +To debug docker connectivity issues, we may use netcat as above to check port connections are working as expected. Double check that you are exposing the right ports to your local network, either by using the command line flags or in your docker-compose.yaml. You should be able to successfully check the connection locally using eg. `nc -zv localhost 1634` then follow instructions above to make sure your local network has the correct ports exposed to the internet. 3. Something else entirely? diff --git a/docs/installation/docker.md b/docs/installation/docker.md index c32b4a378..8997d9323 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -12,9 +12,9 @@ Try Bee out by simply running the following command in your Terminal. ```sh docker run\ -v /path/to/.bee-docker:/home/bee/.bee\ - -p 6060:6060 \ - -p 7070:7070 \ - -p 8080:8080\ + -p 1635:1635 \ + -p 1634:1634 \ + -p 1633:1633\ --rm -it bee:v1\ start \ --welcome-message="Bzzzz bzzz bzz bzz. ๐Ÿ" \ @@ -31,9 +31,9 @@ To persist files, mount a local directory as follows and enter the password used ```sh docker run\ -v /path/to/.bee-docker:/home/bee/.bee\ - -p 6060:6060 \ - -p 7070:7070 \ - -p 8080:8080\ + -p 1635:1635 \ + -p 1634:1634 \ + -p 1633:1633\ --rm -it bee:v1\ start \ --welcome-message="Bzzzz bzzz bzz bzz. ๐Ÿ" \ @@ -47,9 +47,9 @@ Once you have generated your keys, leave Bee to run in the background... docker run\ -d -v /path/to/.bee-docker:/home/bee/.bee\ - -p 6060:6060 \ - -p 7070:7070 \ - -p 8080:8080\ + -p 1635:1635 \ + -p 1634:1634 \ + -p 1633:1633\ --rm -it bee:v1\ start \ --welcome-message="Bzzzz bzzz bzz bzz. ๐Ÿ" \ diff --git a/static/api/index.html b/static/api/index.html index 15ec7e7b0..dbe9233d6 100644 --- a/static/api/index.html +++ b/static/api/index.html @@ -574,19 +574,19 @@

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced data

Authorizations:
path Parameters
required
string or string or string

Swarm address reference to content

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced data

Authorizations:
path Parameters
required
string or string or string

Swarm address reference to content

Responses

Response samples

Content type
application/problem+json
"string"

Chunk

Get Chunk

Authorizations:
path Parameters
required
string or string or string

Swarm address of chunk

+

Response samples

Content type
application/problem+json
"string"

Chunk

Get Chunk

Authorizations:
path Parameters
required
string or string or string

Swarm address of chunk

Responses

Response samples

Content type
application/problem+json
"string"

Upload Chunk

Authorizations:
path Parameters
required
string or string or string

Swarm address of chunk

+

Response samples

Content type
application/problem+json
"string"

Upload Chunk

Authorizations:
path Parameters
required
string or string or string

Swarm address of chunk

header Parameters
swarm-tag-uid
integer

Associate upload with an existing Tag UID

swarm-pin
boolean

Represents the pinning state of the chunk

Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

File

Upload file

Authorizations:
query Parameters
name
string

Filename

+

Response samples

Content type
application/json
{
  • "status": "string"
}

File

Upload file

Authorizations:
query Parameters
name
string

Filename

header Parameters
swarm-tag-uid
integer

Associate upload with an existing Tag UID

swarm-pin
boolean

Represents the pinning state of the file

swarm-encrypt
boolean

Represents the encrypting state of the file

@@ -603,13 +603,13 @@

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced file

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced file

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

Responses

Response samples

Content type
application/problem+json
"string"

Collection

Upload a collection

Authorizations:
header Parameters
swarm-tag-uid
integer

Associate upload with an existing Tag UID

+

Response samples

Content type
application/problem+json
"string"

Collection

Upload a collection

Authorizations:
header Parameters
swarm-tag-uid
integer

Associate upload with an existing Tag UID

swarm-pin
boolean

Represents the pinning state of the collection

swarm-encrypt
boolean

Represents the encrypting state of the collection

swarm-index
string
Example: index.html

Default file to be referenced on path, if exists under that path

@@ -618,7 +618,7 @@

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced file from a collection of files

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

+

Response samples

Content type
application/json
{
  • "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get referenced file from a collection of files

Authorizations:
path Parameters
required
string or string or string

Swarm address of content

path
required
string

Path to the file in the collection.

query Parameters
targets
string

Global pinning targets prefix

Responses

Response samples

Content type
application/problem+json
"string"

Tag

Create Tag

Authorizations:
query Parameters
name
required
string

Tagname

+

Response samples

Content type
application/problem+json
"string"

Tag

Create Tag

Authorizations:
query Parameters
name
required
string

Tagname

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "split": 0,
  • "seen": 0,
  • "stored": 0,
  • "sent": 0,
  • "synced": 0,
  • "uid": 0,
  • "anonymous": true,
  • "name": "string",
  • "address": "string",
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00"
}

Get Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

+

Response samples

Content type
application/json
{
  • "total": 0,
  • "split": 0,
  • "seen": 0,
  • "stored": 0,
  • "sent": 0,
  • "synced": 0,
  • "uid": 0,
  • "anonymous": true,
  • "name": "string",
  • "address": "string",
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00"
}

Get Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "split": 0,
  • "seen": 0,
  • "stored": 0,
  • "sent": 0,
  • "synced": 0,
  • "uid": 0,
  • "anonymous": true,
  • "name": "string",
  • "address": "string",
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00"
}

Delete Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

+

Response samples

Content type
application/json
{
  • "total": 0,
  • "split": 0,
  • "seen": 0,
  • "stored": 0,
  • "sent": 0,
  • "synced": 0,
  • "uid": 0,
  • "anonymous": true,
  • "name": "string",
  • "address": "string",
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00"
}

Delete Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Responses

Response samples

Content type
application/problem+json
"string"

Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

+

Response samples

Content type
application/problem+json
"string"

Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Request Body schema: application/json

Can contain swarm hash to use for the tag

Address
string ^[A-Fa-f0-9]{64}$

Responses

Request samples

Content type
application/json
{
  • "Address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Chunk pinning

Pin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Request samples

Content type
application/json
{
  • "Address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Chunk pinning

Pin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Unpin chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get pinning status of chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get pinning status of chunk with given address

Authorizations:
path Parameters
address
required
string ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Swarm address of chunk

Responses

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "pinCounter": 0
}

Get list of pinned chunks

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "pinCounter": 0
}

Get list of pinned chunks

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "chunks":
    [
    ]
}

Postal Service for Swarm

Send to recipient or target with Postal Service for Swarm

Authorizations:
path Parameters
topic
required
string

Topic name

+

Response samples

Content type
application/json
{
  • "chunks":
    [
    ]
}

Postal Service for Swarm

Send to recipient or target with Postal Service for Swarm

Authorizations:
path Parameters
topic
required
string

Topic name

targets
required
string

Target message address prefix. If multiple targets are specified, only one would be matched.

query Parameters
recipient
string

Recipient publickey

Responses

Response samples

Content type
application/problem+json
"string"

Pss subscribe

Subscribe for messages on the given topic.

Authorizations:
path Parameters
topic
required
string

Topic name

+

Response samples

Content type
application/problem+json
"string"

Pss subscribe

Subscribe for messages on the given topic.

Authorizations:
path Parameters
topic
required
string

Topic name

Responses

Response samples

Content type
application/problem+json
"string"
+

Response samples

Content type
application/problem+json
"string"