Skip to content

Commit 7e9dafa

Browse files
macalinaomacalinao
committed
mroe cleanup
1 parent 8527998 commit 7e9dafa

File tree

9 files changed

+350
-16
lines changed

9 files changed

+350
-16
lines changed

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
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.

‎crates/address-book/Cargo.toml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ version = "0.1.0"
44
edition = "2024"
55
description = "A library for managing and tracking Solana addresses used in transactions"
66
license = "Apache-2.0"
7+
authors = ["Ian Macalinao <[email protected]>"]
8+
documentation = "https://docs.rs/address-book"
9+
homepage = "https://github.com/macalinao/testsvm"
710
repository = "https://github.com/macalinao/testsvm"
11+
readme = "README.md"
12+
keywords = ["ian-macalinao", "solana", "addresses", "tracking", "blockchain"]
13+
categories = ["development-tools", "blockchain", "data-structures"]
814

915
[dependencies]
1016
anchor-lang = "0.31.1"

‎crates/anchor-utils/Cargo.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ name = "anchor-utils"
33
version = "0.1.0"
44
edition = "2024"
55
license = "Apache-2.0"
6+
authors = ["Ian Macalinao <[email protected]>"]
7+
description = "Utility functions and helpers for Anchor framework development"
8+
documentation = "https://docs.rs/anchor-utils"
9+
homepage = "https://github.com/macalinao/testsvm"
10+
repository = "https://github.com/macalinao/testsvm"
11+
readme = "README.md"
12+
keywords = ["ian-macalinao", "anchor", "solana", "utilities", "blockchain"]
13+
categories = ["development-tools", "blockchain", "cryptography::cryptocurrencies"]
614

715
[dependencies]
816
anchor-lang = "0.31.1"

‎crates/testsvm-quarry/Cargo.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ name = "testsvm-quarry"
33
version = "0.1.0"
44
edition = "2024"
55
license = "Apache-2.0"
6+
authors = ["Ian Macalinao <[email protected]>"]
7+
description = "Quarry protocol testing utilities for Solana SVM testing framework"
8+
documentation = "https://docs.rs/testsvm-quarry"
9+
homepage = "https://github.com/macalinao/testsvm"
10+
repository = "https://github.com/macalinao/testsvm"
11+
readme = "README.md"
12+
keywords = ["ian-macalinao", "quarry", "solana", "testing", "blockchain"]
13+
categories = ["development-tools::testing", "blockchain", "cryptography::cryptocurrencies"]
614

715
[dependencies]
816
anyhow = "1.0"

‎crates/testsvm-quarry/README.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# testsvm-quarry
2+
3+
Testing utilities for the Quarry protocol on Solana using the TestSVM framework.
4+
5+
## Overview
6+
7+
This crate provides testing utilities and helpers for interacting with the Quarry mining protocol in a test environment. It includes functions for setting up Quarry programs, managing mining operations, and testing reward distribution mechanisms.
8+
9+
## Installation
10+
11+
Add this to your `Cargo.toml`:
12+
13+
```toml
14+
[dependencies]
15+
testsvm-quarry = "0.1.0"
16+
```
17+
18+
## Setup
19+
20+
Before using this crate, you need to download the Quarry program binaries. Run the following commands to fetch the required programs:
21+
22+
```bash
23+
# Set your project root directory
24+
export ROOT_DIR=/path/to/your/project
25+
26+
# Download Quarry programs
27+
solana program dump QMMD16kjauP5knBwxNUJRZ1Z5o3deBuFrqVjBVmmqto $ROOT_DIR/fixtures/programs/quarry_merge_mine.so
28+
solana program dump QMNeHCGYnLVDn1icRAfQZpjPLBNkfGbSKRB83G5d8KB $ROOT_DIR/fixtures/programs/quarry_mine.so
29+
solana program dump QMWoBmAyJLAsA1Lh9ugMTw2gciTihncciphzdNzdZYV $ROOT_DIR/fixtures/programs/quarry_mint_wrapper.so
30+
```
31+
32+
## Usage
33+
34+
```rust
35+
use testsvm::TestSVM;
36+
use testsvm_quarry::setup::setup_quarry_programs;
37+
38+
fn main() -> anyhow::Result<()> {
39+
let mut env = TestSVM::new();
40+
41+
// Setup Quarry programs
42+
setup_quarry_programs(&mut env)?;
43+
44+
// Your test logic here
45+
46+
Ok(())
47+
}
48+
```
49+
50+
## Features
51+
52+
- **Program Setup**: Easy setup of Quarry mining programs in test environment
53+
- **Mining Operations**: Test mining rewards and distributions
54+
- **Merge Mining**: Support for testing merge mining functionality
55+
- **Mint Wrapper**: Testing utilities for the Quarry mint wrapper
56+
57+
## Program IDs
58+
59+
The crate includes the following Quarry program IDs:
60+
61+
- **Quarry Mine**: `QMNeHCGYnLVDn1icRAfQZpjPLBNkfGbSKRB83G5d8KB`
62+
- **Quarry Merge Mine**: `QMMD16kjauP5knBwxNUJRZ1Z5o3deBuFrqVjBVmmqto`
63+
- **Quarry Mint Wrapper**: `QMWoBmAyJLAsA1Lh9ugMTw2gciTihncciphzdNzdZYV`
64+
65+
## Dependencies
66+
67+
This crate depends on:
68+
- `testsvm` - Core testing framework for Solana SVM
69+
- `anchor-lang` - Anchor framework for Solana program development
70+
- `solana-sdk` - Solana SDK for blockchain interactions
71+
72+
## License
73+
74+
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
75+
76+
## Author
77+
78+
Ian Macalinao <[email protected]>
79+
80+
## Repository
81+
82+
[https://github.com/macalinao/testsvm](https://github.com/macalinao/testsvm)

‎crates/testsvm-quarry/src/setup.rs‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@ use testsvm::TestSVM;
33

44
use crate::quarry_mine;
55

6-
/// Setup the quarry programs in the environment
6+
/// Setup the quarry programs in the environment.
7+
///
8+
/// Note: you will need to download the Quarry programs to your `fixtures/programs/` directory.
9+
///
10+
/// You can use the following commands:
11+
/// ```bash
12+
/// solana program dump QMMD16kjauP5knBwxNUJRZ1Z5o3deBuFrqVjBVmmqto $ROOT_DIR/fixtures/programs/quarry_merge_mine.so
13+
/// solana program dump QMNeHCGYnLVDn1icRAfQZpjPLBNkfGbSKRB83G5d8KB $ROOT_DIR/fixtures/programs/quarry_mine.so
14+
/// solana program dump QMWoBmAyJLAsA1Lh9ugMTw2gciTihncciphzdNzdZYV $ROOT_DIR/fixtures/programs/quarry_mint_wrapper.so
15+
/// ```
716
pub fn setup_quarry_programs(env: &mut TestSVM) -> Result<()> {
817
env.add_program_fixture("quarry_mine", quarry_mine::ID)?;
918
env.add_program_fixture("quarry_merge_mine", crate::quarry_merge_mine::ID)?;

‎crates/testsvm/Cargo.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ name = "testsvm"
33
version = "0.1.0"
44
edition = "2024"
55
license = "Apache-2.0"
6+
authors = ["Ian Macalinao <[email protected]>"]
7+
description = "A comprehensive testing framework for Solana SVM (Solana Virtual Machine) programs"
8+
documentation = "https://docs.rs/testsvm"
9+
homepage = "https://github.com/macalinao/testsvm"
10+
repository = "https://github.com/macalinao/testsvm"
11+
readme = "README.md"
12+
keywords = ["ian-macalinao", "solana", "svm", "testing", "blockchain"]
13+
categories = ["development-tools::testing", "blockchain", "simulation"]
614

715
[dependencies]
816
address-book = { path = "../address-book" }

0 commit comments

Comments
 (0)