Init ipfs-api or js-ipfs #320
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| 'use strict' | ||
|
|
||
| const Ipfs = require('ipfs') | ||
|
|
||
| let node = null | ||
|
|
||
| exports.init = function init () { | ||
| console.log('[ipfs-companion] Embedded ipfs init') | ||
|
|
||
| node = new Ipfs({ | ||
| config: { | ||
| Addresses: { | ||
| Swarm: [] | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| if (node.isOnline()) { | ||
| return Promise.resolve(node) | ||
| } | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| // TODO: replace error listener after a 'ready' event. | ||
| node.once('error', (err) => reject(err)) | ||
| node.once('ready', () => resolve(node)) | ||
| }) | ||
| } | ||
|
|
||
| exports.destroy = async function () { | ||
| if (!node) return | ||
|
|
||
| await node.stop() | ||
| node = null | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| 'use strict' | ||
| /* eslint-env browser */ | ||
|
|
||
| const IpfsApi = require('ipfs-api') | ||
|
|
||
| exports.init = async function (opts) { | ||
| console.log('[ipfs-companion] External ipfs init') | ||
|
|
||
| const url = new URL(opts.ipfsApiUrl) | ||
| const api = IpfsApi({host: url.hostname, port: url.port, procotol: url.protocol}) | ||
| return api | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| 'use strict' | ||
|
|
||
| const embedded = require('./embedded') | ||
| const external = require('./external') | ||
|
|
||
| let client = null | ||
|
|
||
| exports.initIpfsClient = async function (opts) { | ||
| if (client && client.destroy) { | ||
| await client.destroy() | ||
| } | ||
|
|
||
| if (opts.ipfsNodeType === 'embedded') { | ||
| client = await embedded.init(opts) | ||
| } else { | ||
| client = await external.init(opts) | ||
| } | ||
|
|
||
| return client | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some feedback from the last IPFS all hands was that
embeddedmight confuse devs to think that know there is awindow.ipfsin every page. Is that one of the goals too? It would be a good feature to have (optionally)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that would be simple to add. Is the idea that users would write scripts against
window.ipfsbut not bundle it with their script? It sounds a little bit like those browser extensions that add jquery to every page, so you can noodle around in the dev console.Do people have a use-case in mind? T feel like we should be directing devs to the js-ipfs examples, to show them how to bundle it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The difference between adding jquery and ipfs is that on one you would be just packing more code, the second you are opening more ports and doing more crypto which are both expensive operations.
The Metamask team has been injecting Web3 to every page to let devs use Ethereum directly if WebPages are there.
I feel this should be one of the options for the extension and until we have concrete use cases, just refer to an example on how to use it to seed it to developers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of benefits for embedding an already running IPFS node in webpages, too many to list here, but for starter, it makes startup times a lot better as nothing has to initialized, just start using it directly (node in background is already running so!). Performance of loading pages and loading content will be faster as well. Things can be shared via MFS between applications, as long as they agree on a standard structure. ID can follow between applications as well. Just a few reasons.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool! I like the idea of making ipfs available to webapps and seeing what people do with it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #330, I created it to track
window.ipfseffort :)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This! https://github.com/VictorBjelkholm/js-ipfs-in-the-browser