Skip to content

Commit da63573

Browse files
committed
Release Preparations
- Renamed the package as 'bitcoin4j' - Added licensing, and README docs
1 parent 8611baf commit da63573

File tree

126 files changed

+706
-394
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+706
-394
lines changed

AUTHORS

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
Aaron Voisine
2+
Adam Mackler
3+
Alexander Lolis
4+
Alex Taylor
5+
Alex Voloshko
6+
Alok Menghrajani
7+
Alon Muroch
8+
Amichai Rothman
9+
Andreas Schildbach
10+
andrewtoth
11+
Bas van Schaik
12+
Bennett Hoffman
13+
BigAdam2005
14+
Bo-Ye
15+
Carlos Lopez-Camey
16+
Carsten Otto
17+
Chang Ming
18+
Chris
19+
cyberzac
20+
Daniel James
21+
Dave Collins
22+
David Kingsbury
23+
David Wilson (dcw312)
24+
dexX7
25+
Diego Basch
26+
elbandi
27+
eleetas
28+
En-Ran Zhou
29+
Eric Winer
30+
Erik Tierney
31+
Fireduck
32+
freak
33+
Gary Rowe
34+
Giannis Dzegoutanis
35+
Gitju
36+
Giuseppe Raveduto
37+
Glenn Marien
38+
GreenAddress
39+
Greg Laun
40+
gubatron
41+
Harald Hoyer
42+
Jakob Stuber
43+
Jameson Lopp
44+
Jan Vornberger
45+
Jarl Fransson
46+
Jean-Pierre Rupp
47+
Jim Burton
48+
Jiri Peinlich
49+
Johnathan
50+
John L. Jegutanis
51+
Johny George
52+
Jonathan Cross
53+
Jon Griffiths
54+
Jonny Heggheim
55+
Justas Dobiliauskas
56+
Kalpesh Parmar
57+
Ken Sedgwick
58+
Kevin Greene
59+
Kirill Vlasov
60+
Kosta Korenkov
61+
kushti
62+
langerhans
63+
Loco
64+
Manfred Karrer
65+
Marc-André Tremblay
66+
Martin Zachrison
67+
68+
Matt Bogosian
69+
Matt Corallo
70+
Matthew Leon
71+
Matthew Shaylor
72+
Michael Bell
73+
Michael Bumann
74+
Mike Hearn
75+
Mike Rosseel
76+
Miron Cuperman
77+
monk
78+
Mora Zyx
79+
mruddy
80+
Nelson Melina
81+
Nicola Atzei
82+
ollekullberg
83+
Oscar Guindzberg
84+
Pavol Rusnak
85+
peacekeeper
86+
Peter Dettman
87+
Peter Stockli
88+
Peter Todd
89+
Philip Whitehouse
90+
Piotr Włodarek
91+
Richard Green
92+
Richard Green (ragmondo)
93+
Robin Owens
94+
Ronald Hoffman (ScripterRon)
95+
Ross Nicoll
96+
Saulius Beinorius
97+
Sean Gilligan
98+
Sebastian Ortega
99+
Simon de la Rouviere
100+
Simon Vermeersch
101+
Stephan February
102+
Stephan Oeste
103+
Stephen Reed
104+
Thomas König
105+
Tomasz Ludek
106+
troggy
107+
Tyler Houlihan
108+
Willem Noort
109+
Will Shackleton
110+
Wojciech Langiewicz
111+
Xiaofeng Guo
112+
Ximo Guanter
113+
zkejid

COPYING

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

README.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Introduction
2+
3+
## Overview
4+
5+
Bitcoin4J is a Bitcoin library for the Java Language licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).
6+
7+
This library has been built in line with the ideals espoused by [BitcoinSV](https://bitcoinsv.io),
8+
i.e. massive on-chain scaling, protocol stability and original-bitcoin-protocol implementation.
9+
10+
### Learn More about BitcoinSV
11+
You can learn more about BitcoinSV by visiting :
12+
* [TwoStack Bitcoin Developer Guide](https://www.twostack.org/docs/getting-started/)
13+
* [Bitcoin Association Website](https://bitcoinsv.io)
14+
* [BitcoinSV Wiki](https://wiki.bitcoinsv.io/).
15+
16+
## Feature Support
17+
18+
This library lacks, and will not implement :
19+
* Segregated Witness \(Segwit\) Transaction support
20+
* Schnorr Transaction Signature support
21+
* Check Datasig \(OP\_CHECKDATASIG\)
22+
* Taproot
23+
24+
Current Supported features are :
25+
* Custom-Script Builder Interface to support novel locking/spending conditions within Script
26+
* Unbounded Transaction Types (creating non-standard transactions)
27+
* P2PKH Transaction Builder (Explicit helper to make TX assembly easier)
28+
* HD Key Derivation \(BIP32\)
29+
* Mnemonic Seed Support \(BIP39\)
30+
* Original Bitcoin Address format
31+
* A built-in Bitcoin Script Interpreter
32+
33+
## Acknowledgement
34+
35+
This library is a fork of the BitcoinJ and BitcoinJ-Cash projects. Contributor acknowledgements have been preserved in the AUTHORS file.
36+
37+
## Contact
38+
39+
You can reach the author at :
40+
41+
* @beardpappa on Twitter
42+
* [email protected] \(PayMail to buy me a beer\)
43+
44+

build.gradle

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
plugins {
22
id 'java-library'
33
id 'maven'
4+
id 'maven-publish'
45
}
56

6-
group 'org.example'
7-
version '0.1.0-SNAPSHOT'
7+
group 'org.twostack'
8+
version '1.0.0'
89

910
repositories {
1011
mavenCentral()

settings.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
rootProject.name = 'twostack-java'
1+
rootProject.name = 'bitcoin4j'
22

0 commit comments

Comments
 (0)