\n ![\"IPFS](\"https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse\")
\n
\n\nThe JavaScript HTTP client library for IPFS implementations.
\n\n\n ![](\"https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/pm-waffle-blue.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg?style=flat-square\"){kind=icon}
\n
\n ![](\"https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fipfs%2Fjs-ipfs-http-client.svg?type=small\"/)
\n \n
![](\"https://img.shields.io/codecov/c/github/ipfs/js-ipfs-http-client/master.svg?style=flat-square\")
\n \n
\n ![](\"https://david-dm.org/ipfs/js-ipfs-http-client.svg?style=flat-square\")
\n ![](\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square\"){kind=icon}
\n ![](\"https://img.shields.io/badge/Node.js-%3E%3D10.0.0-orange.svg?style=flat-square\"){kind=icon}
\n
\n
![](\"https://ipfs.io/images/ipfs-logo.svg\"){kind=logo}
\n \n Pubsub
\n\n
\n API Addr
\n \n \n \n
\n Connect to peer
\n \n \n \n
\n Subscribe to pubsub topic
\n \n \n \n
\n Send pubsub message
\n \n \n \n
\n \n\n\n"
},
{
"path": "examples/browser-pubsub/index.js",
"content": "'use strict'\n\nconst IpfsHttpClient = require('ipfs-http-client')\nconst { sleep, Logger, onEnterPress, catchAndLog } = require('./util')\n\nasync function main () {\n const apiUrlInput = document.getElementById('api-url')\n const nodeConnectBtn = document.getElementById('node-connect')\n\n const peerAddrInput = document.getElementById('peer-addr')\n const peerConnectBtn = document.getElementById('peer-connect')\n\n const topicInput = document.getElementById('topic')\n const subscribeBtn = document.getElementById('subscribe')\n\n const messageInput = document.getElementById('message')\n const sendBtn = document.getElementById('send')\n\n let log = Logger(document.getElementById('console'))\n let ipfs\n let topic\n let peerId\n\n async function reset () {\n if (ipfs && topic) {\n log(`Unsubscribing from topic ${topic}`)\n await ipfs.pubsub.unsubscribe(topic)\n }\n log = Logger(document.getElementById('console'))\n topicInput.value = ''\n topic = null\n peerId = null\n ipfs = null\n }\n\n async function nodeConnect (url) {\n await reset()\n log(`Connecting to ${url}`)\n ipfs = IpfsHttpClient(url)\n const { id, agentVersion } = await ipfs.id()\n peerId = id\n log(`Success!`)\n log(`Version ${agentVersion}`)\n log(`Peer ID ${id}`)\n }\n\n async function peerConnect (addr) {\n if (!addr) throw new Error('Missing peer multiaddr')\n if (!ipfs) throw new Error('Connect to a node first')\n log(`Connecting to peer ${addr}`)\n await ipfs.swarm.connect(addr)\n log(`Success!`)\n log('Listing swarm peers...')\n await sleep()\n const peers = await ipfs.swarm.peers()\n peers.forEach(peer => {\n const fullAddr = `${peer.addr}/ipfs/${peer.peer.toB58String()}`\n log(`${fullAddr}`)\n })\n log(`(${peers.length} peers total)`)\n }\n\n async function subscribe (nextTopic) {\n if (!nextTopic) throw new Error('Missing topic name')\n if (!ipfs) throw new Error('Connect to a node first')\n\n const lastTopic = topic\n\n if (topic) {\n topic = null\n log(`Unsubscribing from topic ${lastTopic}`)\n await ipfs.pubsub.unsubscribe(lastTopic)\n }\n\n log(`Subscribing to ${nextTopic}...`)\n\n await ipfs.pubsub.subscribe(nextTopic, msg => {\n const from = msg.from\n const seqno = msg.seqno.toString('hex')\n if (from === peerId) return log(`Ignoring message ${seqno} from self`)\n log(`Message ${seqno} from ${from}:`)\n try {\n log(JSON.stringify(msg.data.toString(), null, 2))\n } catch (_) {\n log(msg.data.toString('hex'))\n }\n }, {\n onError: (err, fatal) => {\n if (fatal) {\n console.error(err)\n log(`${err.message}`)\n topic = null\n log('Resubscribing in 5s...')\n setTimeout(catchAndLog(() => subscribe(nextTopic), log), 5000)\n } else {\n console.warn(err)\n }\n }\n })\n\n topic = nextTopic\n log(`Success!`)\n }\n\n async function send (msg) {\n if (!msg) throw new Error('Missing message')\n if (!topic) throw new Error('Subscribe to a topic first')\n if (!ipfs) throw new Error('Connect to a node first')\n\n log(`Sending message to ${topic}...`)\n await ipfs.pubsub.publish(topic, msg)\n log(`Success!`)\n }\n\n const onNodeConnectClick = catchAndLog(() => nodeConnect(apiUrlInput.value), log)\n apiUrlInput.addEventListener('keydown', onEnterPress(onNodeConnectClick))\n nodeConnectBtn.addEventListener('click', onNodeConnectClick)\n\n const onPeerConnectClick = catchAndLog(() => peerConnect(peerAddrInput.value), log)\n peerAddrInput.addEventListener('keydown', onEnterPress(onPeerConnectClick))\n peerConnectBtn.addEventListener('click', onPeerConnectClick)\n\n const onSubscribeClick = catchAndLog(() => subscribe(topicInput.value), log)\n topicInput.addEventListener('keydown', onEnterPress(onSubscribeClick))\n subscribeBtn.addEventListener('click', onSubscribeClick)\n\n const onSendClick = catchAndLog(async () => {\n await send(messageInput.value)\n messageInput.value = ''\n }, log)\n messageInput.addEventListener('keydown', onEnterPress(onSendClick))\n sendBtn.addEventListener('click', onSendClick)\n}\n\nmain()\n"
},
{
"path": "examples/browser-pubsub/package.json",
"content": "{\n \"name\": \"browser-pubsub-example\",\n \"version\": \"0.0.0\",\n \"description\": \"An example demonstrating pubsub in the browser\",\n \"private\": true,\n \"main\": \"index.js\",\n \"scripts\": {\n \"start\": \"parcel index.html\"\n },\n \"author\": \"Alan Shaw\",\n \"license\": \"MIT\",\n \"dependencies\": {\n \"ipfs-http-client\": \"../../\"\n },\n \"browserslist\": [\n \"last 2 versions and not dead and > 2%\"\n ],\n \"devDependencies\": {\n \"parcel-bundler\": \"^1.12.4\"\n }\n}\n"
},
{
"path": "examples/browser-pubsub/util.js",
"content": "exports.sleep = (ms = 1000) => new Promise(resolve => setTimeout(resolve, ms))\n\nexports.Logger = outEl => {\n outEl.innerHTML = ''\n return message => {\n const container = document.createElement('div')\n container.innerHTML = message\n outEl.appendChild(container)\n outEl.scrollTop = outEl.scrollHeight\n }\n}\n\nexports.onEnterPress = fn => {\n return e => {\n if (event.which == 13 || event.keyCode == 13) {\n e.preventDefault()\n fn()\n }\n }\n}\n\nexports.catchAndLog = (fn, log) => {\n return async (...args) => {\n try {\n await fn(...args)\n } catch (err) {\n console.error(err)\n log(`${err.message}`)\n }\n }\n}\n"
},
{
"path": "examples/bundle-webpack/.eslintrc",
"content": "{\n \"extends\": \"standard\",\n \"rules\": {\n \"react/jsx-uses-react\": 2,\n \"react/jsx-uses-vars\": 2,\n \"react/react-in-jsx-scope\": 2\n },\n \"plugins\": [\n \"react\"\n ]\n}\n"
},
{
"path": "examples/bundle-webpack/.gitignore",
"content": "node_modules\nnpm-debug.log\n.DS_Store\ndist\n"
},
{
"path": "examples/bundle-webpack/README.md",
"content": "# Bundle js-ipfs-http-client with Webpack!\n\n> In this example, you will find a boilerplate you can use to guide yourself into bundling js-ipfs-http-client with webpack, so that you can use it in your own web app!\n\n## Setup\n\nAs for any js-ipfs-http-client example, **you need a running IPFS daemon**, you learn how to do that here:\n\n- [Spawn a go-ipfs daemon](https://ipfs.io/docs/getting-started/)\n- [Spawn a js-ipfs daemon](https://github.com/ipfs/js-ipfs#usage)\n\n**Note:** If you load your app from a different domain than the one the daemon is running (most probably), you will need to set up CORS, see https://github.com/ipfs/js-ipfs-http-client#cors to learn how to do that.\n\nA quick (and dirty) way to get it done is:\n\n```bash\n> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin \"[\\\"*\\\"]\"\n> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials \"[\\\"true\\\"]\"\n```\n\n## Run this example\n\nOnce the daemon is on, run the following commands within this folder:\n\n```bash\n> npm install\n> npm start\n```\n\nNow open your browser at `http://localhost:3000`\n\nYou should see the following:\n\n\n\n"
},
{
"path": "examples/bundle-webpack/index.html",
"content": "\n \n Console
\n \n
\n \n
\n \n \n\n"
},
{
"path": "examples/bundle-webpack/package.json",
"content": "{\n \"name\": \"bundle-webpack\",\n \"version\": \"1.0.0\",\n \"description\": \"Bundle js-ipfs-http-client with Webpack\",\n \"scripts\": {\n \"start\": \"node server.js\"\n },\n \"author\": \"Victor Bjelkholm \n
\n }\n}\nmodule.exports = App\n"
},
{
"path": "examples/bundle-webpack/src/index.js",
"content": "'use strict'\nconst React = require('react')\nconst ReactDOM = require('react-dom')\nconst App = require('./App')\n\nReactDOM.render(Everything is working!
\nYour ID is {this.state.id}
\nYour IPFS version is {this.state.version}
\nYour IPFS protocol version is {this.state.protocol_version}
\n\n
\n \n Added a file!
\n {this.state.added_file_hash}\n
\n \n {this.state.added_file_hash}\n
\n Contents of this file:
\n {this.state.added_file_contents}\n
\n \n {this.state.added_file_contents}\n
js-ipfs-http-client
\nname.publish() and name.resolve()
\n \n initializing...\n
\n \n \n\n \n\n\n
\n\n \n Published at \n
\n\n \n
\n
\n\n \n \n\n"
},
{
"path": "examples/name-api/index.js",
"content": "/* eslint-disable no-console */\n'use strict'\nconst ipfsHttp = require('ipfs-http-client')\nconst ipfs = ipfsHttp('/ip4/127.0.0.1/tcp/5001')\n\nconst DOM = {\n status: document.getElementById('status'),\n buttons: document.getElementsByTagName('button'),\n publishNew: document.forms[0],\n publishPath: document.forms[1],\n resolveName: document.forms[2],\n publishResultsDiv: document.querySelector('.results--publish'),\n resolveResultsDiv: document.querySelector('.results--resolve'),\n publishResult: document.getElementById('publish-result'),\n resolveResult: document.getElementById('resolve-result'),\n publishGatewayLink: document.getElementById('publish-gateway-link'),\n resolveGatewayLink: document.getElementById('resolve-gateway-link')\n}\n\nconst COLORS = {\n active: 'blue',\n success: 'green',\n error: 'red'\n}\n\nconst IPFS_DOMAIN = 'https://ipfs.io'\n\nconst showStatus = (text, bg) => {\n DOM.status.innerText = text\n DOM.status.style.background = bg\n}\n\nconst enableForms = () => {\n for (const btn of DOM.buttons) {\n btn.disabled = false\n }\n}\n\nconst init = () => {\n ipfs.id()\n .then(res => {\n showStatus(`daemon active\\nid: ${res.id}`, COLORS.success)\n enableForms()\n })\n .catch(err => {\n showStatus('daemon inactive', COLORS.error)\n console.error(err)\n })\n}\n\n// Adds a new file to IPFS and publish it\nconst addAndPublish = async (e) => {\n e.preventDefault()\n\n const input = e.target.elements.text\n const buffer = Buffer.from(input.value)\n\n showStatus('adding to IPFS...', COLORS.active)\n try {\n for await (const file of ipfs.add(buffer)) {\n showStatus('success!', COLORS.success)\n\n publish(file.path)\n\n input.value = ''\n }\n } catch (err) {\n showStatus('failed to add the data', COLORS.error)\n console.error(err)\n }\n}\n\n// Publishes an IPFS file or directory under your node's identity\nconst publish = (path) => {\n showStatus('publishing...', COLORS.active)\n DOM.publishResultsDiv.classList.add('hidden')\n\n ipfs.name.publish(path)\n .then(res => {\n const name = res.name\n showStatus('success!', COLORS.success)\n DOM.publishResultsDiv.classList.remove('hidden')\n DOM.publishResult.innerText = `/ipns/${name}`\n DOM.publishGatewayLink.href = `${IPFS_DOMAIN}/ipns/${name}`\n })\n .catch(err => {\n showStatus(`error publishing ${path}`, COLORS.error)\n console.error(err)\n })\n}\n\n// Resolves an IPNS name\nconst resolve = async (name) => {\n showStatus('resolving...', COLORS.active)\n DOM.resolveResultsDiv.classList.add('hidden')\n try {\n for await (const path of ipfs.name.resolve(name)) {\n showStatus('success!', COLORS.success)\n DOM.resolveResultsDiv.classList.remove('hidden')\n DOM.resolveResult.innerText = path\n DOM.resolveGatewayLink.href = `${IPFS_DOMAIN}${path}`\n }\n } catch (err) {\n showStatus(`error resolving ${name}`, COLORS.error)\n console.error(err)\n }\n}\n\n// Event listeners\nDOM.publishNew.onsubmit = addAndPublish\n\nDOM.publishPath.onsubmit = (e) => {\n e.preventDefault()\n const input = e.target.elements.path\n publish(input.value)\n input.value = ''\n}\n\nDOM.resolveName.onsubmit = (e) => {\n e.preventDefault()\n const input = e.target.elements.name\n resolve(input.value)\n input.value = ''\n}\n\ninit()\n"
},
{
"path": "examples/name-api/package.json",
"content": "{\n \"name\": \"js-ipfs-http-client-example-name-publish-resolve\",\n \"version\": \"1.0.0\",\n \"description\": \"\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"start\": \"parcel index.html\"\n },\n \"author\": \"Tara Vancil \n Resolves to \n
\n
\n \n \n\n"
},
{
"path": "examples/upload-file-via-browser/package.json",
"content": "{\n \"name\": \"upload-file-via-browser\",\n \"version\": \"1.0.0\",\n \"description\": \"Upload file to IPFS via browser using js-ipfs-http-client with Webpack\",\n \"scripts\": {\n \"start\": \"parcel index.html\"\n },\n \"author\": \"Harlan T Wood \n \n \n
\n )\n }\n}\nmodule.exports = App\n"
},
{
"path": "examples/upload-file-via-browser/src/index.js",
"content": "/* eslint-disable no-unused-vars */\n'use strict'\nconst React = require('react')\nconst ReactDOM = require('react-dom')\nconst App = require('./App')\n\nReactDOM.render(