chore: add stardust to libp2p config and updated instructions on browser example #2831
Conversation
vasco-santos
force-pushed
the
chore/add-stardust-instructions-on-browser-example
branch
from
00489af
to
e918e0f
Compare
|
cc @mkg20001 (cannot ask you review on ipfs org) |
vasco-santos
changed the title
vasco-santos
force-pushed
the
chore/add-stardust-instructions-on-browser-example
branch
from
903a1d8
to
3e88e65
Compare
vasco-santos
force-pushed
the
chore/add-stardust-instructions-on-browser-example
branch
from
3e88e65
to
2da648c
Compare
packages/ipfs/README.md
Outdated
| @@ -942,6 +942,29 @@ const node = await IPFS.create({ | |||
|
|
|||
| The code above assumes you are running a local `signaling server` on port `9090`. Provide the correct values accordingly. | |||
|
|
|||
| **Note:** We host a signalling server at star-signal.cloud.ipfs.team that can be used for practical demos and experimentation, it should not be used for apps in production. A libp2p-webrtc-star address, using the signalling server we provide, looks like: | |||
|
|
|||
| /dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star/p2p/<your-peer-id> | |||
There was a problem hiding this comment.
This address is going to end up changing when we update the deploy, which is in progress. This server is currently not stable and is old.
There was a problem hiding this comment.
Yeah, I will add this once we have the new server deployed
packages/ipfs/README.md
Outdated
|
|
||
| Note: The address above indicates WebSockets Secure, which can be accessed from both http and https. | ||
|
|
||
| #### Is there a more stable alternative to webrtc-star that offers a similar functionality? |
There was a problem hiding this comment.
I don't think this is an accurate statement to make. It is an alternative but unless I am mistaken we have no performance measurements between the two to say stardust is more/less stable. Ideally, we should do some load testing on the rendezvous servers to make these comparisons.
packages/ipfs/README.md
Outdated
| config: { | ||
| Addresses: { | ||
| Swarm: [ | ||
| '/dns4/ws-star.discovery.libp2p.io/tcp/443/wss/p2p-websocket-star' |
There was a problem hiding this comment.
This address is wrong and is to websocket-star, it will need to change once there is a public test server to point to.
There was a problem hiding this comment.
I will put the own signaling instructions while we don't have this deployed
| config: { | ||
| Addresses: { | ||
| Swarm: [ | ||
| `/ip4/0.0.0.0/tcp/5892/ws/p2p-stardust/p2p/${stardustServerId}` |
There was a problem hiding this comment.
Just noticed that Address.Swarm notation is pretty different from one in webrtc-star and legacy ws-star where user just points at anonymous endpoint.
- Is this because the
stardustprotocol requires prior knowledge ofstardustServerId? - This is the main README, are we going to replace
/ip4/0.0.0.0/tcp/5892with a real server?
(0.0.0.0makes sense in examples where we run one on localhost, but here it may be confusing to users who try to copy&paste just to try it out)
There was a problem hiding this comment.
When the multiaddrs are added to libp2p peer for listening, js-ipfs adds a /p2p/{own_peer_id}.
In webrtc-star, it gets the valid multiaddr, however stardust multiaddr to listen must be /p2p/${stardustServerId}/p2p/{own_peer_id}. This is because stardust server is a libp2p node, while webrtc-star is not a libp2p node.
I thought about creating a fixture with the peer-id first, so that we have always the same id and not need this change. However, I think that this is not the best solution.
Anyway, the plan is to go as you asked. Once we have some servers deployed for experimenting, the server id issue will not be a problem anymore and we can replace this by the server address. The same will happen for webrtc-star.
Co-Authored-By: Marcin Rataj <lidel@lidel.org>
|
We can close this as we will not move on with startdust |
This PR adds
libp2p-stardusttransport to the ipfs browser runtime configuration.Moreover, the stardust was added to the
exchange-filesexample, in order to testing and provide an example for the community on how to use it.Needs: