From c6aa66ada02bc1088279b84f88f860efab8f79bd Mon Sep 17 00:00:00 2001 From: Gregory Hill Date: Wed, 27 May 2020 15:58:17 +0100 Subject: [PATCH] publish at 0.1.0 Signed-off-by: Gregory Hill --- LICENSE | 2 +- README.md | 31 ++++++++++++------------------- package.json | 12 ++++++------ 3 files changed, 19 insertions(+), 26 deletions(-) diff --git a/LICENSE b/LICENSE index 72242a7..6868815 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Alexei Zamyatin +Copyright (c) 2019 Interlay Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index e321704..0a048e4 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,17 @@ External libs: * Summa Bitcoin Relay: https://github.com/summa-tx/relays/tree/master/solidity * Original [Deprecated] BTC-Relay: https://github.com/ethereum/btcrelay/tree/develop/fetchd +## Background + +### Chain Relays +Chain relays are on-chain programs or smart contracts deployed on a blockchain A capable of reading and verifying the state of another blockchain B. +The underlying technical design and functionality is comparable to that of SPV-Clients. That is, a chain relay stores and maintains block headers of chain B on chain A and allows to verify transaction inclusion proofs. Summarizing, the two main functionalities a chain relay must/should provide are: consensus verification and transaction inclusion verification. + +Read more about chain relays in the XCLAIM paper (Section V.B descibes the basic concept of chain relays, while Appendix B provides a formal model of the required functionality for PoW chain relays.). + +### BTCRelay-Sol +This project is an implementation of a chain relay for Bitcoin on Ethereum. The first implementation of a BTC relay was implemented in Serpent and can be found here. +However, as Serpent is outdated (last commit: December 2017), this project aims to implement an updated version in Solidity. ## Installation @@ -40,23 +51,5 @@ npm test ### Ropsten -0x9847E88401a27a9165543ecAE650739cE30732CD - -### TxChain Performance Tests -The `scripts` folder contains test scripts for evaluating the performance/cost improvement of the TxChain transaction aggregation. - -## Deploying Contracts +`0x9847E88401a27a9165543ecAE650739cE30732CD` -** TODO ** - -## Background - -### Chain Relays -Chain relays are on-chain programs or smart contracts deployed on a blockchain A capable of reading and verifying the state of another blockchain B. -The underlying technical design and functionality is comparable to that of SPV-Clients. That is, a chain relay stores and maintains block headers of chain B on chain A and allows to verify transaction inclusion proofs. Summarizing, the two main functionalities a chain relay must/should provide are: consensus verification and transaction inclusion verification. - -Read more about chain relays in the XCLAIM paper (Section V.B descibes the basic concept of chain relays, while Appendix B provides a formal model of the required functionality for PoW chain relays.). - -### BTCRelay-Sol -BTCRelay-Sol is an implementation of a chain relay for Bitcoin on Ethereum. The first implementation of BTCRelay was implemented in Serpent and can be found here. -However, as Serpent is outdated (last commit: December 2017), this project aims to implement an updated version in Solidity. \ No newline at end of file diff --git a/package.json b/package.json index a97b3b0..e961345 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "btcrelay-sol", - "version": "1.0.0", - "description": "BTCRelay implementation in Solidity", + "name": "@interlay/btc-relay-sol", + "version": "0.1.0", + "description": "BTC Relay in Solidity", "dependencies": { "@summa-tx/bitcoin-spv-sol": "3.0.0", "bitcoinjs-lib": "^5.1.7" @@ -37,12 +37,12 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/crossclaim/btcrelay-sol.git" + "url": "git+https://gitlab.com/interlay/btc-relay-sol.git" }, "author": "", "license": "ISC", "bugs": { - "url": "https://github.com/crossclaim/btcrelay-sol/issues" + "url": "https://gitlab.com/interlay/btc-relay-sol/issues" }, - "homepage": "https://github.com/crossclaim/btcrelay-sol#readme" + "homepage": "https://gitlab.com/interlay/btc-relay-sol#readme" }