New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

鈿★笍 v0.29.0 RELEASE 馃殌 #1320

Closed
daviddias opened this Issue Apr 23, 2018 · 3 comments

Comments

Projects
None yet
2 participants
@daviddias
Copy link
Member

daviddias commented Apr 23, 2018

short tl;dr; of the release

馃椇 What's left for release

馃敠 Highlights

馃弾 Bitswap is 30% faster

Bitswap is now 30% thanks to fixing a bug on js-ipfs-bitswap that was causing every message to be sent individually.

馃憮 js-ipfs now works with uglify-es just fine

The duck typing throughout js-ipfs has been improved and that means that now you can use uglify-es again to minify your js-ipfs code. The result is that the js-ipfs bundled version is now back to its minified size as well.

鈽庯笍 Circuit Relay was merged in

Circuit Relay enables connectivity between any two nodes through a third relay node. This ensures connectivity in almost every scenario, that is, as long as peers can connect to some public IP node. Learn how to use it here. This was one of the two features that js-ipfs was missing to get full connectivity.

馃棏 S3 backend for IPFS

Ever wished you could use an external storage backend to store all your IPFS blocks? Now you do and we got a tutorial for you! See how to configure a repo at https://github.com/ipfs/js-ipfs/tree/master/examples/custom-ipfs-repo and if you want to learn how to use S3 as your external backend, then consult https://github.com/ipfs/js-datastore-s3/tree/master/examples/full-s3-repo.

馃摐 README Overhaul

The js-ipfs README keeps improving, now with 40% more information about the multiple arguments you can pass to IPFS. Read all the options at https://github.com/ipfs/js-ipfs#api

馃幏 Project Tracking

If you haven't already, I welcome you to check how the js-ipfs team tracks their work at https://github.com/ipfs/js-ipfs/blob/master/MGMT.md. It is fun to see the issues fly through the waffle board.

Config validation and config reuse fix

In addition to better documentation on how to configure your node, you now get some config validation in case you mistype something. Also as a bonus, you can now spin multiple nodes in the same process without them getting confused and using the same config.

馃摉 interface-ipfs-core keeps getting more API calls documented and tested

Make yourself familiar with the IPFS Core API at https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC. New additions include files.add --wrapWithDirectory, --onlyHash and others.

馃搳 Bandwidth stats now available

Bandwidth statistics for your IPFS node from the libp2p layer are now exposed and available to query for the whole node, per peer or per protocol. You can also use Node streams or pull streams to get a continuous feed of that tasty statistical juice.

馃摗 Fully Async PubSub API

Writing in Progress

馃泿 Ping API implemented

JS IPFS now has API calls for pinging other peers. Fun fact, this was actually the first thing a js-ipfs node did, but it got lost in a massive refactor and now it is back and not only in js-ipfs core, it is also available through the CLI and HTTP API

鈿涳笍 Electron Main Process support with Electron 2.0

Writing in Progress

ref: #1351

馃彈 API Changes

  1. Argument order for pubsub.subscribe has changed:
    • Old: pubsub.subscribe(topic, [options], handler, [callback]): Promise
    • New: pubsub.subscribe(topic, handler, [options], [callback]): Promise
  2. The pubsub.unsubscribe method has become async meaning that it now takes a callback or returns a promise:
    • Old: pubsub.unsubscribe(topic, handler): undefined
    • New: pubsub.unsubscribe(topic, handler, [callback]): Promise
  3. Property names on response objects for ping are now lowered:
    • Old: { Success, Time, Text }
    • New: { success, time, text }
  4. In the CLI, jsipfs object data no longer returns a newline after the end of the returned data

Release Checklist

  • Robustness and quality
  • Documentation
    • Ensure that README.md is up to date
    • Ensure that all the examples run
  • Communication

馃檶馃徑 Want to contribute?

Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started:

鈦夛笍 Do you have questions?

The best place to ask your questions about IPFS, how it works and what you can do with it is at discuss.ipfs.io. We are also available at the #ipfs channel on Freenode.

@dryajov

This comment has been minimized.

Copy link
Member

dryajov commented May 28, 2018

@diasdavid

Can we add the link to the circuit relay example to the its respective section?

Something like this:

Circuit Relay enables connectivity between any two nodes through a third relay node. This ensures connectivity in almost every scenario, that is, as long as peers can connect to some public IP node. Learn how to use it here. This was one of the two features that js-ipfs was missing to get full connectivity.

@daviddias

This comment has been minimized.

Copy link
Member

daviddias commented May 29, 2018

@dryajov of course! Added in :)

@daviddias

This comment has been minimized.

Copy link
Member

daviddias commented May 29, 2018

Release published!

https://twitter.com/daviddias/status/1001432008302694400

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment