chore: initial commit

ipfs · May 14, 2021 · e3e73df · e3e73df
commit e3e73df
Show file tree

Hide file tree

Showing 21 changed files with 468 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+dist
+node_modules
+package-lock.json
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+engine-strict = true
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/LICENSE-MIT b/LICENSE-MIT
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# ipfs-interfaces <!-- omit in toc -->
+
+> TypeScript interfaces used by IPFS internals
+
+## Table of Contents <!-- omit in toc -->
+
+- [Packages](#packages)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Packages
+
+See the [./packages](./packages) directory for the various interfaces.
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-bitswap/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
+
+## License
+
+[MIT](LICENSE)
diff --git a/lerna.json b/lerna.json
@@ -0,0 +1,21 @@
+{
+  "lerna": "3.22.0",
+  "packages": [
+    "packages/*"
+  ],
+  "version": "independent",
+  "command": {
+    "run": {
+      "stream": true
+    },
+    "publish": {
+      "message": "chore: publish",
+      "createRelease": "github",
+      "conventionalCommits": true,
+      "verifyAccess": false
+    },
+    "version": {
+      "private": false
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "ipfs-interfaces",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "lerna run build",
+    "lint": "lerna run lint",
+    "release": "lerna publish"
+  },
+  "homepage": "https://github.com/ipfs/js-ipfs-interfaces/tree/master#readme",
+  "bugs": "https://github.com/ipfs/js-ipfs-interfaces/issues",
+  "license": "(Apache-2.0 OR MIT)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/js-ipfs-interfaces.git"
+  },
+  "workspaces": [
+    "packages/*"
+  ],
+  "dependencies": {
+    "lerna": "^4.0.0"
+  },
+  "engines": {
+    "npm": ">=7.0.0"
+  }
+}
diff --git a/packages/interface-blockstore/LICENSE-APACHE b/packages/interface-blockstore/LICENSE-APACHE
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/packages/interface-blockstore/LICENSE-MIT b/packages/interface-blockstore/LICENSE-MIT
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/interface-blockstore/README.md b/packages/interface-blockstore/README.md
@@ -0,0 +1,20 @@
+# interface-blockstore <!-- omit in toc -->
+
+> An interface for storing and retrieving blocks
+
+## Table of Contents <!-- omit in toc -->
+
+- [Contribute](#contribute)
+- [License](#license)
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-bitswap/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
+
+## License
+
+[MIT](LICENSE)
diff --git a/packages/interface-blockstore/package.json b/packages/interface-blockstore/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "interface-blockstore",
+  "version": "0.0.1",
+  "description": "",
+  "main": "src/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "aegir ts -p check && aegir lint",
+    "build": "aegir build"
+  },
+  "license": "(Apache-2.0 OR MIT)",
+  "homepage": "https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-blockstore#readme",
+  "bugs": "https://github.com/ipfs/js-ipfs-interfaces/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/js-ipfs-interfaces.git"
+  },
+  "dependencies": {
+    "interface-store": "^0.0.1",
+    "multiformats": "^8.0.4"
+  },
+  "devDependencies": {
+    "aegir": "^33.1.2"
+  }
+}
diff --git a/packages/interface-blockstore/src/index.d.ts b/packages/interface-blockstore/src/index.d.ts
@@ -0,0 +1,10 @@
+import {
+  Pair as StorePair
+} from 'interface-store'
+import {
+  CID
+} from 'multiformats'
+
+export interface Pair extends StorePair<CID, Uint8Array> {
+
+}
diff --git a/packages/interface-blockstore/src/index.js b/packages/interface-blockstore/src/index.js
diff --git a/packages/interface-blockstore/tsconfig.json b/packages/interface-blockstore/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "extends": "aegir/src/config/tsconfig.aegir.json",
+  "compilerOptions": {
+      "outDir": "dist",
+      "skipLibCheck": false
+  },
+  "include": [
+    "test",
+    "src"
+  ]
+}
diff --git a/packages/interface-store/LICENSE-APACHE b/packages/interface-store/LICENSE-APACHE
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/packages/interface-store/LICENSE-MIT b/packages/interface-store/LICENSE-MIT
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/interface-store/README.md b/packages/interface-store/README.md
@@ -0,0 +1,20 @@
+# interface-store <!-- omit in toc -->
+
+> A generic interface for storing and retrieving data
+
+## Table of Contents <!-- omit in toc -->
+
+- [Contribute](#contribute)
+- [License](#license)
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-bitswap/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
+
+## License
+
+[MIT](LICENSE)
diff --git a/packages/interface-store/package.json b/packages/interface-store/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "interface-store",
+  "version": "0.0.1",
+  "description": "",
+  "main": "src/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "aegir ts -p check && aegir lint",
+    "build": "aegir build"
+  },
+  "homepage": "https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-store#readme",
+  "bugs": "https://github.com/ipfs/js-ipfs-interfaces/issues",
+  "license": "(Apache-2.0 OR MIT)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/js-ipfs-interfaces.git"
+  },
+  "devDependencies": {
+    "aegir": "^33.1.2"
+  }
+}