hs-multiaddr 0.1.0.1 → 0.1.4
raw patch · 4 files changed
+268/−79 lines, 4 filesdep +hs-multihashdep −multihashdep ~basedep ~bytesdep ~bytestring
Dependencies added: hs-multihash
Dependencies removed: multihash
Dependency ranges changed: base, bytes, bytestring, cereal, either-unwrap, filepath, hspec, iproute, sandi
Files
- LICENSE +195/−24
- README.md +3/−2
- hs-multiaddr.cabal +69/−52
- src/Data/Multiaddr.hs +1/−1
LICENSE view
@@ -1,30 +1,201 @@-Copyright CMCDragonkai (c) 2017+ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/ -All rights reserved.+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Redistribution and use in source and binary forms, with or without-modification, are permitted provided that the following conditions are met:+ 1. Definitions. - * Redistributions of source code must retain the above copyright- notice, this list of conditions and the following disclaimer.+ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document. - * Redistributions in binary form must reproduce the above- copyright notice, this list of conditions and the following- disclaimer in the documentation and/or other materials provided- with the distribution.+ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License. - * Neither the name of CMCDragonkai nor the names of other- contributors may be used to endorse or promote products derived- from this software without specific prior written permission.+ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.+ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "{}"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright {yyyy} {name of copyright owner}++ 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.
README.md view
@@ -1,6 +1,7 @@-Haskell Multi-Address-=====================+# Multiaddress Haskell implementation of Multiaddr: https://github.com/multiformats/multiaddr Passes all tests and maintains protocol sync with the Go implementation: https://github.com/multiformats/go-multiaddr++The name of this package is `hs-multiaddr`.
hs-multiaddr.cabal view
@@ -1,56 +1,73 @@-name: hs-multiaddr-version: 0.1.0.1-synopsis: Multiaddr Library for LibP2P-description: Multiaddr is self-describing way to represent addresses that support any standard network protocol.- Multiaddr has a binary packed format, and nice string representation.- It is possible to encapsulate addresses within each other.-homepage: https://github.com/MatrixAI/haskell-multiaddr#readme-license: BSD3-license-file: LICENSE-author: CMCDragonkai-maintainer: roger.qiu@matrix.ai-copyright: Copyright: (c) 2017 Roger Qiu-category: Data-build-type: Simple-extra-source-files: README.md-cabal-version: >=1.10+-- This file has been generated from package.yaml by hpack version 0.21.2.+--+-- see: https://github.com/sol/hpack+--+-- hash: 97e59c09cade2c4a1e7309c30f9342103e5930d54a11d1a30ed5707426f7e3c7 -library- hs-source-dirs: src- exposed-modules: Data.Multiaddr,- Data.MultiaddrPart,- Data.Multiaddr.IPFS,- Data.Multiaddr.VarInt- Data.Multiaddr.IPv4,- Data.Multiaddr.IPv6- Data.Multiaddr.Onion,- Data.Multiaddr.Port,- Data.Multiaddr.UnixPath- build-depends: base >= 4.7 && < 4.9- , bytestring- , bytes- , sandi- , cereal- , iproute- , filepath- , multihash- default-language: Haskell2010+name: hs-multiaddr+version: 0.1.4+synopsis: Multiaddr library+description: Multiaddr is self-describing way to represent addresses that support any standard network protocol. Multiaddr has a binary packed format, and nice string representation. It is possible to encapsulate addresses within each other.+category: Data+homepage: https://github.com/MatrixAI/hs-multiaddr#readme+bug-reports: https://github.com/MatrixAI/hs-multiaddr/issues+author: CMCDragonkai,+ Quoc-An Ho+maintainer: roger.qiu@matrix.ai+copyright: (c) Matrix AI 2017+license: Apache-2.0+license-file: LICENSE+build-type: Simple+cabal-version: >= 1.10 -test-suite haskell-multiaddr-test- type: exitcode-stdio-1.0- hs-source-dirs: test- main-is: Spec.hs- build-depends: base- , hs-multiaddr- , hspec- , iproute- , sandi- , bytestring- , multihash- , either-unwrap- ghc-options: -threaded -rtsopts -with-rtsopts=-N- default-language: Haskell2010+extra-source-files:+ README.md source-repository head- type: git- location: https://github.com/MatrixAI/haskell-multiaddr+ type: git+ location: https://github.com/MatrixAI/hs-multiaddr++library+ exposed-modules:+ Data.Multiaddr+ Data.MultiaddrPart+ Data.Multiaddr.IPFS+ Data.Multiaddr.VarInt+ Data.Multiaddr.IPv4+ Data.Multiaddr.IPv6+ Data.Multiaddr.Onion+ Data.Multiaddr.Port+ Data.Multiaddr.UnixPath+ other-modules:+ Paths_hs_multiaddr+ hs-source-dirs:+ src+ build-depends:+ base >=4.7 && <5+ , bytes >=0.15 && <0.16+ , bytestring >=0.10 && <0.11+ , cereal >=0.5 && <0.6+ , filepath >=1.4 && <1.5+ , hs-multihash+ , iproute >=1.7 && <1.8+ , sandi >=0.4 && <0.5+ default-language: Haskell2010++test-suite hs-multiaddr-test+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ other-modules:+ Paths_hs_multiaddr+ hs-source-dirs:+ test+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ base >=4.7 && <5+ , bytestring >=0.10 && <0.11+ , either-unwrap >=1.1 && <1.2+ , hs-multiaddr+ , hs-multihash+ , hspec >=2.4 && <2.5+ , iproute >=1.7 && <1.8+ , sandi >=0.4 && <0.5+ default-language: Haskell2010
src/Data/Multiaddr.hs view
@@ -68,7 +68,7 @@ -- first address encapsulates the second address encapsulate :: Multiaddr -> Multiaddr -> Multiaddr-encapsulate m1 m2 = Multiaddr $ parts m1 ++ parts m2+encapsulate = mappend -- first address is prefix removed from the second address decapsulate :: Multiaddr -> Multiaddr -> Maybe Multiaddr