Formalising the API #64

daviddias · 2017-03-24T17:14:09Z

No description provided.

…ng API calls

daviddias · 2017-03-24T18:20:30Z

Finished polishing and documenting the libp2p API. Feel welcome to post comments and review.

Now:

Update the codebase
add isPeerId to peer-id isPeerId js-peer-id#57
add isPeerInfo to peer-info isPeerInfo js-peer-info#48
Update libp2p-ipfs-nodejs Feat/new api ipfs-inactive/js-libp2p-ipfs-nodejs#80
Update libp2p-ipfs-browser
Update libp2p-floodsub
Update js-ipfs-bitswap
Update js-ipfs

dignifiedquire · 2017-03-27T12:29:10Z

README.md

+
+`callback` is a function with the following `function (err) {}` signature, where `err` is an Error in case stopping the node fails.
+
+#### `libp2p.dial(peer [, protocol, callback])`


I would like to split this into dial and connect.

dial(peer, protocol, callback) all args required does what this does currently

connect(peer, callback) only ensures a connection is made to the peer, does not return a conn in the callback

Interesting, I'm thinking about it, not 100% convinced yet, but I can definitely see the potential of having a 'more clean way' for people to migrate from that swarm.connect that go-ipfs kind of standardised.

On a second though, I like to keep it simple in libp2p land.

Why does this make it simpler? It's just overloading a single method with even more functionality

Simpler as in "start fresh" and not have to take in a legacy 'connect'. I kind of like your idea, just not convinced about the dial and connect keyword: is it intuitive for users?

Maybe, on the other hand as long as dial creates a connection if it's missing I am not sure this is actually needed currently. Lets leave it as is for now, need to work through more code until am sure

dignifiedquire · 2017-03-27T12:30:42Z

README.md

+
+#### `libp2p.findProviders`
+
+#### `libp2p.record.put`


I think these should be called dht.put and dht.get as they allow you to put arbitrary values not only records

go-ipfs only allows (at least per js-ipfs-api tests) to put/get records, provider or IPNS.

It might make sense to just expose it as dht, so that we have a clean upgrade path for when we have the routing and record interfaces well established.

Not sure why that is, the underlying method do not have this restriction: https://github.com/libp2p/go-libp2p-kad-dht/blob/master/routing.go#L35

@dignifiedquire because there is no current value for IPFS in having people using the DHT as a generic key-value store.

That being said, don't feel the need to shoehorn this API methods as you develop the DHT, they aren't solidified yet.

dignifiedquire · 2017-03-27T14:38:01Z

src/index.js

-  pingByMultiaddr (maddr, callback) {
-    assert(this.isOnline, OFFLINE_ERROR_MESSAGE)
-    callback(new Error('not implemented yet'))
+  isOn () {


Hmm why isOn and isOnline both?

dignifiedquire · 2017-03-27T14:38:25Z

src/index.js

-  pingByPeerInfo (peerInfo, callback) {
-    assert(this.isOnline, OFFLINE_ERROR_MESSAGE)
+  ping (peer, callback) {
+    assert(this.isOn, OFFLINE_ERROR_MESSAGE)


isOn is a method

dignifiedquire · 2017-03-27T14:39:16Z

src/index.js


-    this.peerBook.removeByB58String(peer.id.toB58String())
-    this.swarm.hangUp(peer, callback)
+    this.peerBook.removeByB58String(peerInfo.id.toB58String())


This is not good, just because we hang up does not mean we want to forget about the peer details

dignifiedquire · 2017-03-27T14:42:11Z

src/index.js

+      try {
+        p = this.peerBook.getByB58String(peerIdB58Str)
+      } catch (err) {
+        // TODO this is where PeerRouting comes into place


Actually it doesn't. As far as I understand additions to the peerbook are made directly from e.g. the dht while peers are discovered. If you want to dial a peerid you do not know you make a manual request on the libp2p level to the peer routing mechanism to get multiaddrs. The automatic check should happen at the ipfs level.

Here, what would happen would be something like a this.findPeers, to see if we can find the Peer we are looking for. If we then retrieve it from the PeerBook, that is ok.

But we already do a lookup in the peerbook, we can not start a dht query here, as this method gets called by the dht to dial, so it could get stuck in a loop

dignifiedquire · 2017-03-27T14:58:27Z

src/index.js

-  hangUpById (id, callback) {
-    // TODO
-    callback(new Error('not implemented yet'))
+    this.peerBook.removeByB58String(peerInfo.id.toB58String())


@diasdavid THIS IS GOING TO BREAK THINGS when we have a dht :(

Yeah, and we actually don't need it. Note that this was here before.

I was trying to remember why this was added here and I just figured out. pre-dht era, I treated the PeerBook as our source of truth for peers we are connected, and so: https://github.com/ipfs/js-ipfs/blob/master/src/core/components/swarm.js#L12-L47 relies on that.

We could do a match with swarm.muxedConns, but a better solution is to actually have a little bit more state on the PeerInfo object I believe. Same goes for the address that gets picked, so that when we do log out the peers we are connected, we only print the addr we are actually using (like go-ipfs does).

Maybe we should separate these two like go does, so that we have one storage for all details about peers we have ever seen and one storage where we just store the currently connected peers with the address they are connected with.

swarm.muxedConns is kind of that place where "just store the currently connected peers with the address they are connected with.".

I feel it is more reasonable to keep all that state in just one place.

sounds good, lets keep the discussion in #68

restructure and add spdy to browser tests

- Fixes libp2p#64

## [6.0.1](libp2p/js-libp2p-peer-store@v6.0.0...v6.0.1) (2023-02-28) ### Trivial Changes * replace err-code with CodeError ([libp2p#53](libp2p/js-libp2p-peer-store#53)) ([e6b87d7](libp2p/js-libp2p-peer-store@e6b87d7)), closes [js-libp2p#1269](libp2p#1269) * Update .github/workflows/semantic-pull-request.yml [skip ci] ([1139dc4](libp2p/js-libp2p-peer-store@1139dc4)) ### Documentation * Update API link ([libp2p#65](libp2p/js-libp2p-peer-store#65)) ([1b75110](libp2p/js-libp2p-peer-store@1b75110)), closes [libp2p#64](libp2p/js-libp2p-peer-store#64)

* deps(dev): bump aegir from 38.1.8 to 39.0.10 Bumps [aegir](https://github.com/ipfs/aegir) from 38.1.8 to 39.0.10. - [Release notes](https://github.com/ipfs/aegir/releases) - [Changelog](https://github.com/ipfs/aegir/blob/master/CHANGELOG.md) - [Commits](ipfs/aegir@v38.1.8...v39.0.10) --- updated-dependencies: - dependency-name: aegir dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * chore: fix linting --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: achingbrain <alex@achingbrain.net>

## [5.0.4](libp2p/js-libp2p-peer-record@v5.0.3...v5.0.4) (2023-06-15) ### Trivial Changes * Update .github/workflows/semantic-pull-request.yml [skip ci] ([10f3201](libp2p/js-libp2p-peer-record@10f3201)) * Update .github/workflows/stale.yml [skip ci] ([0bd8e9d](libp2p/js-libp2p-peer-record@0bd8e9d)) ### Dependencies * **dev:** bump aegir from 38.1.8 to 39.0.10 ([libp2p#64](libp2p/js-libp2p-peer-record#64)) ([ba3ac38](libp2p/js-libp2p-peer-record@ba3ac38))

daviddias added 2 commits March 24, 2017 16:02

docs: update readme, add base class extending example and start listi…

3584209

…ng API calls

docs: libp2p API

a4b97b9

daviddias added the status/in-progress In progress label Mar 24, 2017

docs: finish API documentation

5d4d94e

feat: new super simplified API

a6623c1

daviddias mentioned this pull request Mar 27, 2017

feat: implement dialById #66

Closed

dignifiedquire reviewed Mar 27, 2017

View reviewed changes

fix: last touches

2c23d9a

dignifiedquire reviewed Mar 27, 2017

View reviewed changes

cr

d27bd2b

daviddias merged commit 721da9a into master Mar 27, 2017

daviddias deleted the feat/new-api branch March 27, 2017 14:45

daviddias removed the status/in-progress In progress label Mar 27, 2017

daviddias mentioned this pull request Mar 27, 2017

Consider: Break dial without protocol into its own method #67

Closed

dignifiedquire reviewed Mar 27, 2017

View reviewed changes

jacobheun pushed a commit to jacobheun/js-libp2p that referenced this pull request Jul 29, 2019

Merge pull request libp2p#64 from diasdavid/add/webrtc-star

c53068c

restructure and add spdy to browser tests

maschad pushed a commit to maschad/js-libp2p that referenced this pull request Jun 21, 2023

update .github/workflows/js-test-and-release.yml (libp2p#64)

2c38def

maschad pushed a commit to maschad/js-libp2p that referenced this pull request Jun 21, 2023

sync: update CI config files (libp2p#64)

3f9a229

maschad pushed a commit to maschad/js-libp2p that referenced this pull request Jun 21, 2023

docs: Update API link (libp2p#65)

1b75110

- Fixes libp2p#64

achingbrain pushed a commit that referenced this pull request Jun 27, 2023

chore: update dependencies and fix libp2p test usage (#64)

a767cee

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Formalising the API #64

Formalising the API #64

daviddias commented Mar 24, 2017

daviddias commented Mar 24, 2017 •

edited

Loading

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017

daviddias Mar 27, 2017 •

edited

Loading

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017

dignifiedquire Mar 27, 2017

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017

daviddias Mar 27, 2017

dignifiedquire Mar 27, 2017

dignifiedquire Mar 27, 2017

dignifiedquire Mar 27, 2017

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017

dignifiedquire Mar 27, 2017

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017 •

edited

Loading

daviddias Mar 27, 2017

dignifiedquire Mar 27, 2017

daviddias Mar 27, 2017

dignifiedquire Mar 27, 2017


		`callback` is a function with the following `function (err) {}` signature, where `err` is an Error in case stopping the node fails.

		#### `libp2p.dial(peer [, protocol, callback])`

Formalising the API #64

Formalising the API #64

Conversation

daviddias commented Mar 24, 2017

daviddias commented Mar 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daviddias Mar 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daviddias Mar 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daviddias commented Mar 24, 2017 •

edited

Loading

daviddias Mar 27, 2017 •

edited

Loading

daviddias Mar 27, 2017 •

edited

Loading