├── .gitignore ├── LICENSE ├── NOTICE ├── README.md ├── package.json └── quick-start ├── connect-many-peers └── peer.mjs ├── connect-two-peers ├── client.mjs └── server.mjs ├── corestore ├── reader.mjs └── writer.mjs ├── hyperbee ├── bee-reader.mjs ├── core-reader.mjs ├── dict.json.gz └── writer.mjs ├── hypercore ├── reader.mjs └── writer.mjs └── hyperdrive ├── bee-reader.mjs ├── drive-reader.mjs ├── writer-dir ├── a.txt ├── b.txt └── c.txt └── writer.mjs /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | package-lock.json 107 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Copyright 2023 Holepunch Inc 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Holepunch Examples 2 | Here you'll find a few self-contained examples showing how to use the different building blocks in the Holepunch module ecosystem. 3 | 4 | For more context, check out the [Quick Start](...) 5 | 6 | 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "single-page-walkthrough", 3 | "version": "1.0.0", 4 | "description": "An introduction to the Holepunch module ecosystem", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/holepunchto/quick-start.git" 12 | }, 13 | "keywords": [ 14 | "holepunch", 15 | "hypercore" 16 | ], 17 | "author": "Holepunch", 18 | "license": "Apache-2.0", 19 | "bugs": { 20 | "url": "https://github.com/holepunchto/quick-start/issues" 21 | }, 22 | "homepage": "https://github.com/holepunchto/quick-start#readme", 23 | "dependencies": { 24 | "b4a": "^1.6.1", 25 | "corestore": "^6.4.0", 26 | "debounceify": "^1.0.0", 27 | "graceful-goodbye": "^1.1.0", 28 | "hyperbee": "^2.2.0", 29 | "hypercore": "^10.5.3", 30 | "hyperdht": "^6.5.2", 31 | "hyperdrive": "^11.0.1", 32 | "hyperswarm": "^4.3.5", 33 | "localdrive": "^1.5.0" 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /quick-start/connect-many-peers/peer.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import goodbye from 'graceful-goodbye' 3 | import crypto from 'hypercore-crypto' 4 | import b4a from 'b4a' 5 | 6 | const swarm = new Hyperswarm() 7 | goodbye(() => swarm.destroy()) 8 | 9 | // Keep track of all connections and console.log incoming data 10 | const conns = [] 11 | swarm.on('connection', conn => { 12 | const name = b4a.toString(conn.remotePublicKey, 'hex') 13 | console.log('* got a connection from:', name, '*') 14 | conns.push(conn) 15 | conn.once('close', () => conns.splice(conns.indexOf(conn), 1)) 16 | conn.on('data', data => console.log(`${name}: ${data}`)) 17 | }) 18 | 19 | // Broadcast stdin to all connections 20 | process.stdin.on('data', d => { 21 | for (const conn of conns) { 22 | conn.write(d) 23 | } 24 | }) 25 | 26 | // Join a common topic 27 | const topic = process.argv[2] ? b4a.from(process.argv[2], 'hex') : crypto.randomBytes(32) 28 | const discovery = swarm.join(topic, { client: true, server: true }) 29 | 30 | // The flushed promise will resolve when the topic has been fully announced to the DHT 31 | discovery.flushed().then(() => { 32 | console.log('joined topic:', b4a.toString(topic, 'hex')) 33 | }) 34 | -------------------------------------------------------------------------------- /quick-start/connect-two-peers/client.mjs: -------------------------------------------------------------------------------- 1 | import DHT from 'hyperdht' 2 | import b4a from 'b4a' 3 | 4 | console.log('Connecting to:', process.argv[2]) 5 | const publicKey = b4a.from(process.argv[2], 'hex') 6 | 7 | const dht = new DHT() 8 | const conn = dht.connect(publicKey) 9 | conn.once('open', () => console.log('got connection!')) 10 | 11 | process.stdin.pipe(conn).pipe(process.stdout) 12 | -------------------------------------------------------------------------------- /quick-start/connect-two-peers/server.mjs: -------------------------------------------------------------------------------- 1 | import DHT from 'hyperdht' 2 | import goodbye from 'graceful-goodbye' 3 | import b4a from 'b4a' 4 | 5 | const dht = new DHT() 6 | 7 | // This keypair is your peer identifier in the DHT 8 | const keyPair = DHT.keyPair() 9 | 10 | const server = dht.createServer(conn => { 11 | console.log('got connection!') 12 | process.stdin.pipe(conn).pipe(process.stdout) 13 | }) 14 | server.listen(keyPair).then(() => { 15 | console.log('listening on:', b4a.toString(keyPair.publicKey, 'hex')) 16 | }) 17 | 18 | // Unnannounce the public key before exiting the process 19 | // (This is not a requirement, but it helps avoid DHT pollution) 20 | goodbye(() => server.close()) 21 | -------------------------------------------------------------------------------- /quick-start/corestore/reader.mjs: -------------------------------------------------------------------------------- 1 | import Corestore from 'corestore' 2 | import Hyperswarm from 'hyperswarm' 3 | import goodbye from 'graceful-goodbye' 4 | import b4a from 'b4a' 5 | 6 | const store = new Corestore('./reader-storage') 7 | 8 | const swarm = new Hyperswarm() 9 | goodbye(() => swarm.destroy()) 10 | swarm.on('connection', conn => store.replicate(conn)) 11 | 12 | const core = store.get({ key: b4a.from(process.argv[2], 'hex'), valueEncoding: 'json' }) 13 | await core.ready() 14 | 15 | const foundPeers = store.findingPeers() 16 | swarm.join(core.discoveryKey) 17 | swarm.flush().then(() => foundPeers()) 18 | 19 | await core.update() 20 | if (core.length === 0) { 21 | console.log('Could not connect to the writer peer') 22 | process.exit(1) 23 | } 24 | 25 | const { otherKeys } = await core.get(0) 26 | for (const key of otherKeys) { 27 | const core = store.get({ key: b4a.from(key, 'hex') }) 28 | core.on('append', () => { 29 | const seq = core.length - 1 30 | core.get(seq).then(block => { 31 | console.log(`Block ${seq} in Core ${key}: ${block}`) 32 | }) 33 | }) 34 | } 35 | -------------------------------------------------------------------------------- /quick-start/corestore/writer.mjs: -------------------------------------------------------------------------------- 1 | import Corestore from 'corestore' 2 | import Hyperswarm from 'hyperswarm' 3 | import goodbye from 'graceful-goodbye' 4 | import b4a from 'b4a' 5 | 6 | const store = new Corestore('./writer-storage') 7 | const swarm = new Hyperswarm() 8 | goodbye(() => swarm.destroy()) 9 | 10 | // A name is a purely-local, and maps to a key pair. It's not visible to readers. 11 | // Since a name always corresponds to a key pair, you must own any core you load by name 12 | const core1 = store.get({ name: 'core-1', valueEncoding: 'json' }) 13 | const core2 = store.get({ name: 'core-2' }) 14 | const core3 = store.get({ name: 'core-3' }) 15 | await Promise.all([core1.ready(), core2.ready(), core3.ready()]) 16 | 17 | console.log('main core key:', b4a.toString(core1.key, 'hex')) 18 | 19 | // Here we'll only join the swarm with the core1's discovery key 20 | // We don't need to announce core2 and core3, because they'll be replicated alongside core1 21 | swarm.join(core1.discoveryKey) 22 | 23 | // Corestore replication internally manages replicating every loaded core 24 | // Corestore *does not* exchange keys (read capabilities) during replication. 25 | swarm.on('connection', conn => store.replicate(conn)) 26 | 27 | // Since Corestore does not exchange keys, they need to be exchanged elsewhere. 28 | // Here, we'll record the other keys in the first block of core1. 29 | if (core1.length === 0) { 30 | await core1.append({ 31 | otherKeys: [core2, core3].map(core => b4a.toString(core.key, 'hex')) 32 | }) 33 | } 34 | 35 | // Record all short messages in core2, and all long ones in core3 36 | process.stdin.on('data', data => { 37 | if (data.length < 5) { 38 | console.log('appending short data to core2') 39 | core2.append(data) 40 | } else { 41 | console.log('appending long data to core3') 42 | core3.append(data) 43 | } 44 | }) 45 | -------------------------------------------------------------------------------- /quick-start/hyperbee/bee-reader.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import Corestore from 'corestore' 3 | import Hyperbee from 'hyperbee' 4 | import goodbye from 'graceful-goodbye' 5 | import b4a from 'b4a' 6 | 7 | const store = new Corestore('./reader-storage') 8 | 9 | const swarm = new Hyperswarm() 10 | goodbye(() => swarm.destroy()) 11 | swarm.on('connection', conn => store.replicate(conn)) 12 | 13 | const core = store.get({ key: b4a.from(process.argv[2], 'hex') }) 14 | const bee = new Hyperbee(core, { 15 | keyEncoding: 'utf-8', 16 | valueEncoding: 'utf-8' 17 | }) 18 | 19 | await core.ready() 20 | console.log('core key here is:', core.key.toString('hex')) 21 | 22 | // Attempt to connect to peers 23 | swarm.join(core.discoveryKey) 24 | 25 | // Do a single Hyperbee.get for every line of stdin data 26 | // Each `get` will only download the blocks necessary to satisfy the query 27 | process.stdin.setEncoding('utf-8') 28 | process.stdin.on('data', data => { 29 | const word = data.trim() 30 | if (!word.length) return 31 | bee.get(word).then(node => { 32 | if (!node || !node.value) console.log(`No dictionary entry for ${data}`) 33 | else console.log(`${data} -> ${node.value}`) 34 | }, err => console.error(err)) 35 | }) 36 | -------------------------------------------------------------------------------- /quick-start/hyperbee/core-reader.mjs: -------------------------------------------------------------------------------- 1 | import Hypercore from 'hypercore' 2 | import Hyperswarm from 'hyperswarm' 3 | import Corestore from 'corestore' 4 | import goodbye from 'graceful-goodbye' 5 | import b4a from 'b4a' 6 | 7 | import { Node } from 'hyperbee/lib/messages.js' 8 | 9 | const store = new Corestore('./reader-storage') 10 | 11 | const swarm = new Hyperswarm() 12 | goodbye(() => swarm.destroy()) 13 | swarm.on('connection', conn => store.replicate(conn)) 14 | 15 | const core = store.get({ key: b4a.from(process.argv[2], 'hex') }) 16 | await core.ready() 17 | 18 | const foundPeers = store.findingPeers() 19 | swarm.join(core.discoveryKey) 20 | swarm.flush().then(() => foundPeers()) 21 | 22 | await core.update() 23 | 24 | const seq = core.length - 1 25 | const lastBlock = await core.get(core.length - 1) 26 | console.log(`Raw Block ${seq}:`, lastBlock) 27 | console.log(`Decoded Block ${seq}`, Node.decode(lastBlock)) 28 | -------------------------------------------------------------------------------- /quick-start/hyperbee/dict.json.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/holepunchto/examples/028f37d602bc51f44e2a6ca52b9a956733a89560/quick-start/hyperbee/dict.json.gz -------------------------------------------------------------------------------- /quick-start/hyperbee/writer.mjs: -------------------------------------------------------------------------------- 1 | import fs from 'fs' 2 | import zlib from 'zlib' 3 | 4 | import Hyperswarm from 'hyperswarm' 5 | import Corestore from 'corestore' 6 | import Hyperbee from 'hyperbee' 7 | import goodbye from 'graceful-goodbye' 8 | import b4a from 'b4a' 9 | 10 | const store = new Corestore('./writer-storage') 11 | 12 | const swarm = new Hyperswarm() 13 | goodbye(() => swarm.destroy()) 14 | swarm.on('connection', conn => store.replicate(conn)) 15 | 16 | const core = store.get({ name: 'my-bee-core' }) 17 | const bee = new Hyperbee(core, { 18 | keyEncoding: 'utf-8', 19 | valueEncoding: 'utf-8' 20 | }) 21 | 22 | await core.ready() 23 | const discovery = swarm.join(core.discoveryKey) 24 | 25 | // Only display the key once the Hyperbee has been announced to the DHT 26 | discovery.flushed().then(() => console.log('bee key:', b4a.toString(core.key, 'hex'))) 27 | 28 | // Only import the dictionary the first time this script is executed 29 | // The first block will always be the Hyperbee header block 30 | if (core.length <= 1) { 31 | console.log('importing dictionary...') 32 | const dict = await loadDictionary() 33 | const batch = bee.batch() 34 | for (const { key, value } of dict) { 35 | await batch.put(key, value) 36 | } 37 | await batch.flush() 38 | } else { 39 | // Otherwise just seed the previously-imported dictionary 40 | console.log('seeding dictionary...') 41 | } 42 | 43 | async function loadDictionary() { 44 | const compressed = await fs.promises.readFile('./dict.json.gz') 45 | return new Promise((resolve, reject) => { 46 | zlib.unzip(compressed, (err, dict) => { 47 | if (err) return reject(err) 48 | return resolve(JSON.parse(b4a.toString(dict))) 49 | }) 50 | }) 51 | } 52 | -------------------------------------------------------------------------------- /quick-start/hypercore/reader.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import Hypercore from 'hypercore' 3 | import goodbye from 'graceful-goodbye' 4 | 5 | const swarm = new Hyperswarm() 6 | goodbye(() => swarm.destroy()) 7 | 8 | const core = new Hypercore('./reader-storage', process.argv[2]) 9 | await core.ready() 10 | 11 | const foundPeers = core.findingPeers() 12 | swarm.join(core.discoveryKey) 13 | swarm.on('connection', conn => core.replicate(conn)) 14 | 15 | // swarm.flush() will wait until *all* discoverable peers have been connected to 16 | // It might take a while, so don't await it 17 | // Instead, use core.findingPeers() to mark when the discovery process is completed 18 | swarm.flush().then(() => foundPeers()) 19 | 20 | // This won't resolve until either a) the first peer is found, or b) no peers could be found 21 | await core.update() 22 | 23 | let position = core.length 24 | console.log(`Skipping ${core.length} earlier blocks...`) 25 | for await (const block of core.createReadStream({ start: core.length, live: true })) { 26 | console.log(`Block ${position++}: ${block}`) 27 | } 28 | 29 | -------------------------------------------------------------------------------- /quick-start/hypercore/writer.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import Hypercore from 'hypercore' 3 | import goodbye from 'graceful-goodbye' 4 | import b4a from 'b4a' 5 | 6 | const swarm = new Hyperswarm() 7 | goodbye(() => swarm.destroy()) 8 | 9 | const core = new Hypercore('./writer-storage') 10 | 11 | // core.key and core.discoveryKey will only be set after core.ready resolves 12 | await core.ready() 13 | console.log('hypercore key:', b4a.toString(core.key, 'hex')) 14 | 15 | // Append all stdin data as separate blocks to the core 16 | process.stdin.on('data', data => core.append(data)) 17 | 18 | // core.discoveryKey is *not* a read capability for the core 19 | // It's only used to discover other peers who *might* have the core 20 | swarm.join(core.discoveryKey) 21 | swarm.on('connection', conn => core.replicate(conn)) 22 | -------------------------------------------------------------------------------- /quick-start/hyperdrive/bee-reader.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import Corestore from 'corestore' 3 | import Hyperbee from 'hyperbee' 4 | import goodbye from 'graceful-goodbye' 5 | import debounce from 'debounceify' 6 | import b4a from 'b4a' 7 | 8 | const store = new Corestore('./reader-storage') 9 | 10 | const swarm = new Hyperswarm() 11 | goodbye(() => swarm.destroy()) 12 | swarm.on('connection', conn => store.replicate(conn)) 13 | 14 | const core = store.get({ key: b4a.from(process.argv[2], 'hex') }) 15 | const bee = new Hyperbee(core, { 16 | keyEncoding: 'utf-8', 17 | valueEncoding: 'json' 18 | }) 19 | 20 | await core.ready() 21 | 22 | const foundPeers = store.findingPeers() 23 | swarm.join(core.discoveryKey) 24 | swarm.flush().then(() => foundPeers()) 25 | 26 | core.on('append', listBee) 27 | listBee() 28 | 29 | async function listBee () { 30 | console.log('\n***************') 31 | console.log('hyperbee contents are now:') 32 | for await (const node of bee.createReadStream()) { 33 | console.log(' ', node.key, '->', node.value) 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /quick-start/hyperdrive/drive-reader.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import Hyperdrive from 'hyperdrive' 3 | import Localdrive from 'localdrive' 4 | import Corestore from 'corestore' 5 | import goodbye from 'graceful-goodbye' 6 | import debounce from 'debounceify' 7 | import b4a from 'b4a' 8 | 9 | const store = new Corestore('./reader-storage') 10 | 11 | const swarm = new Hyperswarm() 12 | goodbye(() => swarm.destroy()) 13 | swarm.on('connection', conn => store.replicate(conn)) 14 | 15 | // Create a local copy of the remote drive 16 | const local = new Localdrive('./reader-dir') 17 | 18 | const drive = new Hyperdrive(store, b4a.from(process.argv[2], 'hex')) 19 | await drive.ready() 20 | 21 | const mirror = debounce(mirrorDrive) 22 | drive.core.on('append', mirror) 23 | 24 | const foundPeers = store.findingPeers() 25 | swarm.join(drive.discoveryKey) 26 | swarm.flush().then(() => foundPeers()) 27 | 28 | mirror() 29 | 30 | async function mirrorDrive () { 31 | console.log('started mirroring remote drive into \'./reader-dir\'...') 32 | const mirror = drive.mirror(local) 33 | await mirror.done() 34 | console.log('finished mirroring:', mirror.count) 35 | } 36 | -------------------------------------------------------------------------------- /quick-start/hyperdrive/writer-dir/a.txt: -------------------------------------------------------------------------------- 1 | this is a test file 2 | -------------------------------------------------------------------------------- /quick-start/hyperdrive/writer-dir/b.txt: -------------------------------------------------------------------------------- 1 | this is another test file 2 | -------------------------------------------------------------------------------- /quick-start/hyperdrive/writer-dir/c.txt: -------------------------------------------------------------------------------- 1 | this is the third test file 2 | -------------------------------------------------------------------------------- /quick-start/hyperdrive/writer.mjs: -------------------------------------------------------------------------------- 1 | import Hyperswarm from 'hyperswarm' 2 | import Hyperdrive from 'hyperdrive' 3 | import Localdrive from 'localdrive' 4 | import Corestore from 'corestore' 5 | import goodbye from 'graceful-goodbye' 6 | import debounce from 'debounceify' 7 | import b4a from 'b4a' 8 | 9 | const store = new Corestore('./writer-storage') 10 | const swarm = new Hyperswarm() 11 | goodbye(() => swarm.destroy()) 12 | swarm.on('connection', conn => store.replicate(conn)) 13 | 14 | // A local drive provides a Hyperdrive interface to a local directory 15 | const local = new Localdrive('./writer-dir') 16 | 17 | // A Hyperdrive takes a Corestore because it needs to create many cores 18 | // One for a file metadata Hyperbee, and one for a content Hypercore 19 | const drive = new Hyperdrive(store) 20 | await drive.ready() 21 | 22 | // Import changes from the local drive into the Hyperdrive 23 | const mirror = debounce(mirrorDrive) 24 | 25 | const discovery = swarm.join(drive.discoveryKey) 26 | await discovery.flushed() 27 | 28 | console.log('drive key:', b4a.toString(drive.key, 'hex')) 29 | 30 | process.stdin.setEncoding('utf-8') 31 | process.stdin.on('data', (d) => { 32 | if (!d.match('\n')) return 33 | mirror() 34 | }) 35 | 36 | async function mirrorDrive () { 37 | console.log('started mirroring changes from \'./writer-dir\' into the drive...') 38 | const mirror = local.mirror(drive) 39 | await mirror.done() 40 | console.log('finished mirroring:', mirror.count) 41 | } 42 | --------------------------------------------------------------------------------