diff --git a/LICENSE b/LICENSE index f49a4e16e6..6a5e26414f 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright 2020 Interlay Ltd Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index fbfb0db05e..87882c86f8 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This is a proof of concept implementation of a BTC Parachain to bring Bitcoin in It allows the creation of **PolkaBTC**, a fungible token that represents Bitcoin in the Polkadot ecosystem. PolkaBTC is backed by Bitcoin 1:1 and allows redeeming of the equivalent amount of Bitcoins by relying on a collateralized third-party. -![overview](https://gitlab.com/interlay/polkabtc-spec/-/blob/dev/polkabtc-spec/docs/source/figures/overview.png "BTC Parachain Overview") +![overview](https://interlay.gitlab.io/polkabtc-spec/_images/overview.png "BTC Parachain Overview") The project uses the concept of [Cryptocurrency-backed Assets](https://xclaim.io) to lock Bitcoin on the Bitcoin blockchain and issue BTC-backed tokens on the BTC Parachain. The implementation is based on the [BTC Parachain specification](https://interlay.gitlab.io/polkabtc-spec/). @@ -29,3 +29,9 @@ If you would like to contribute, please file an issue on GitLab or reach out to - [Riot](https://matrix.to/#/!nZablWWaicZyVTWyZk:matrix.org?via=matrix.org) We are [hiring](https://www.interlay.io/careers/)! + +## Copyright and License + +(C) Copyright 2020 [Interlay](https://www.interlay.io) Ltd + +BTC-Parachain is currently licensed under the terms of the Apache License (Version 2.0). See LICENSE diff --git a/crates/bitcoin/src/README.md b/crates/bitcoin/src/README.md new file mode 100644 index 0000000000..722a6ecf2a --- /dev/null +++ b/crates/bitcoin/src/README.md @@ -0,0 +1,47 @@ +# Bitcoin library + +Library handling BTC-Relay and Bitcoin specific data types and provides parsing and verficaition functionality. + +* types.rs: BTC-Relay / Bitcoin data model +* parser.rs: Parsing Bitcoin block headers and transactions +* merkle.rs: Verification of Merkle Proofs +* utils.rs: Bitcoin-specific util functions + +## Installation + +Run `cargo build` from the root folder of this directory. + +## Testing + +Run `cargo test` from the root folder of this directory. + + +## Integration into Runtimes + +### Runtime `Cargo.toml` + +To add this pallet to your runtime, simply include the following to your runtime's `Cargo.toml` file: + +```TOML +[dependencies.bitcoin] +default_features = false +git = '../creates/bitcoin' +``` + +and update your runtime's `std` feature to include this pallet: + +```TOML +std = [ + # --snip-- + 'bitcoin/std', +] +``` + +## Reference Docs + +You can view the reference docs for this pallet by running: + +``` +cargo doc --open +``` + diff --git a/crates/btc-core/Cargo.toml b/crates/btc-core/Cargo.toml index 73c05a4c5c..475b428ae5 100644 --- a/crates/btc-core/Cargo.toml +++ b/crates/btc-core/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "btc-core" version = "0.1.0" -authors = ["Daniel Perez "] +authors = ["Interlay Ltd"] edition = "2018" [features] diff --git a/crates/btc-relay/LICENSE b/crates/btc-relay/LICENSE deleted file mode 100644 index cf1ab25da0..0000000000 --- a/crates/btc-relay/LICENSE +++ /dev/null @@ -1,24 +0,0 @@ -This is free and unencumbered software released into the public domain. - -Anyone is free to copy, modify, publish, use, compile, sell, or -distribute this software, either in source code form or as a compiled -binary, for any purpose, commercial or non-commercial, and by any -means. - -In jurisdictions that recognize copyright laws, the author or authors -of this software dedicate any and all copyright interest in the -software to the public domain. We make this dedication for the benefit -of the public at large and to the detriment of our heirs and -successors. We intend this dedication to be an overt act of -relinquishment in perpetuity of all present and future rights to this -software under copyright law. - -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 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. - -For more information, please refer to diff --git a/crates/security/LICENSE b/crates/security/LICENSE deleted file mode 100644 index cf1ab25da0..0000000000 --- a/crates/security/LICENSE +++ /dev/null @@ -1,24 +0,0 @@ -This is free and unencumbered software released into the public domain. - -Anyone is free to copy, modify, publish, use, compile, sell, or -distribute this software, either in source code form or as a compiled -binary, for any purpose, commercial or non-commercial, and by any -means. - -In jurisdictions that recognize copyright laws, the author or authors -of this software dedicate any and all copyright interest in the -software to the public domain. We make this dedication for the benefit -of the public at large and to the detriment of our heirs and -successors. We intend this dedication to be an overt act of -relinquishment in perpetuity of all present and future rights to this -software under copyright law. - -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 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. - -For more information, please refer to