getsourcecode 2.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,234 @@
1
+ Metadata-Version: 2.1
2
+ Name: getsourcecode
3
+ Version: 2.1.0
4
+ Summary: Simple way to get contract source code verified on blockchain explorer.
5
+ Home-page: https://github.com/5hawnXu/getsourcecode
6
+ Author: Shawn Xu
7
+ Author-email: support@hxzy.me
8
+ License-File: LICENSE
9
+ Requires-Dist: retrying
10
+
11
+ getSourceCode
12
+ =============
13
+
14
+ This tool is designed to quickly download the code of open source
15
+ contracts on the blockchain explorer.
16
+
17
+ The downloaded code maintains the file directory structure at the time
18
+ of verification.
19
+
20
+ Supported Chain Platforms:
21
+
22
+ ::
23
+
24
+ Ethereum Mainnet | Sepolia Testnet | Hoodi Testnet
25
+ BNB Smart Chain Mainnet | BNB Smart Chain Testnet
26
+ Polygon Mainnet | Polygon Amoy Testnet
27
+ Base Mainnet | Base Sepolia Testnet
28
+ Arbitrum One Mainnet | Arbitrum Sepolia Testnet
29
+ Linea Mainnet | Linea Sepolia Testnet
30
+ Blast Mainnet | Blast Sepolia Testnet
31
+ OP Mainnet | OP Sepolia Testnet
32
+ Avalanche C-Chain | Avalanche Fuji Testnet
33
+ BitTorrent Chain Mainnet | BitTorrent Chain Testnet
34
+ Celo Mainnet | Celo Sepolia Testnet
35
+ Fraxtal Mainnet | Fraxtal Hoodi Testnet
36
+ Gnosis...
37
+
38
+ Chain names are case-insensitive.
39
+
40
+ Some chains (e.g. BNB Smart Chain, Base, OP, Avalanche) require a paid API plan.
41
+
42
+ For the full list of supported chains, visit: https://docs.etherscan.io/supported-chains
43
+
44
+
45
+
46
+ Get code by tx only supports:
47
+
48
+ ::
49
+
50
+ arbi|arbi-nova|avax|base|boba|bsc
51
+ cronos|eth|fantom|gnosis|heco|klaytn
52
+ moonbeam|moonriver|opt|poly||ronin
53
+
54
+ arbi-testnet|avax-testnet|base-testnet
55
+ boba-testnet|bsc-testnet|ftm-testnet
56
+ goerli|opt-testnet|poly-testnet
57
+
58
+
59
+
60
+ Install
61
+ =======
62
+
63
+ ::
64
+
65
+ pip install getSourceCode
66
+
67
+ Usage
68
+ =====
69
+
70
+ ::
71
+
72
+ getCode [-h] [-i INPUTFILE] [-o OUTPUTFOLDER] [-a ADDRESS] [-n NETWORK] [-k KEY] [-p PROXY] [-t TXHASH] [-u] [-v] [--apikey APIKEY]
73
+
74
+ For example:
75
+
76
+ ::
77
+
78
+ getCode -n bsc -a 0xb51eaa437AC67A631e2FEca0a18dA7a6391c0D07
79
+
80
+ or
81
+
82
+ ::
83
+
84
+ getCode -n eth -a 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 -p 127.0.0.1:7890
85
+
86
+ The command execution result is as follows:
87
+
88
+ ::
89
+
90
+ [root@hxzy test]# getCode -n bsc -a 0xb51eaa437AC67A631e2FEca0a18dA7a6391c0D07
91
+ 0-0: SynthereumManager/deploy/@openzeppelin/contracts/access/AccessControl.sol
92
+ 0-1: SynthereumManager/deploy/@openzeppelin/contracts/access/IAccessControl.sol
93
+ 0-2: SynthereumManager/deploy/@openzeppelin/contracts/utils/Context.sol
94
+ 0-3: SynthereumManager/deploy/@openzeppelin/contracts/utils/Strings.sol
95
+ 0-4: SynthereumManager/deploy/@openzeppelin/contracts/utils/introspection/ERC165.sol
96
+ 0-5: SynthereumManager/deploy/@openzeppelin/contracts/utils/introspection/IERC165.sol
97
+ 0-6: SynthereumManager/deploy/@openzeppelin/contracts/access/AccessControlEnumerable.sol
98
+ 0-7: SynthereumManager/deploy/@openzeppelin/contracts/access/IAccessControlEnumerable.sol
99
+ 0-8: SynthereumManager/deploy/@openzeppelin/contracts/utils/structs/EnumerableSet.sol
100
+ 0-9: SynthereumManager/deploy/contracts/core/Manager.sol
101
+ 0-10: SynthereumManager/deploy/contracts/core/interfaces/IFinder.sol
102
+ 0-11: SynthereumManager/deploy/contracts/core/interfaces/IManager.sol
103
+ 0-12: SynthereumManager/deploy/contracts/common/interfaces/IEmergencyShutdown.sol
104
+ 0-13: SynthereumManager/deploy/contracts/core/Constants.sol
105
+ 0-14: SynthereumManager/deploy/contracts/core/Finder.sol
106
+
107
+ Address => ContractName:
108
+ 0xb51eaa437AC67A631e2FEca0a18dA7a6391c0D07 SynthereumManager
109
+
110
+ Success.
111
+
112
+ The directory structure looks like this:
113
+
114
+ ::
115
+
116
+ [root@hxzy test]# tree
117
+ .
118
+ └── SynthereumManager
119
+ └── deploy
120
+ ├── contracts
121
+ │   ├── common
122
+ │   │   └── interfaces
123
+ │   │   └── IEmergencyShutdown.sol
124
+ │   └── core
125
+ │   ├── Constants.sol
126
+ │   ├── Finder.sol
127
+ │   ├── interfaces
128
+ │   │   ├── IFinder.sol
129
+ │   │   └── IManager.sol
130
+ │   └── Manager.sol
131
+ └── @openzeppelin
132
+ └── contracts
133
+ ├── access
134
+ │   ├── AccessControlEnumerable.sol
135
+ │   ├── AccessControl.sol
136
+ │   ├── IAccessControlEnumerable.sol
137
+ │   └── IAccessControl.sol
138
+ └── utils
139
+ ├── Context.sol
140
+ ├── introspection
141
+ │   ├── ERC165.sol
142
+ │   └── IERC165.sol
143
+ ├── Strings.sol
144
+ └── structs
145
+ └── EnumerableSet.sol
146
+
147
+ 13 directories, 15 files
148
+
149
+ Get code by tx only:
150
+
151
+ ::
152
+
153
+ getCode -n eth -t 0x8dda3f4a1c4bbc85ed50d7a78096f805f2c9382e35800e42f066abaa7b17a71b -p 127.0.0.1:7890
154
+
155
+ The address without the corresponding contract name is an unopened contract\EOA.
156
+
157
+ Like this:
158
+
159
+ ::
160
+
161
+ [root@hxzy test]#getCode -n eth -t 0x8dda3f4a1c4bbc85ed50d7a78096f805f2c9382e35800e42f066abaa7b17a71b -p 127.0.0.1:7890
162
+ 0-0: contract/AnyswapV6ERC20.sol
163
+ 1-0: contract/FiatTokenProxy.sol
164
+ 2-0: Implementation/FiatTokenV2_1.sol
165
+ 3-0: contract/AnyswapV6Router.sol
166
+ 4-0: contract/FiatTokenV2_1.sol
167
+
168
+ Address => ContractName:
169
+ 0xea928a8d09e11c66e074fbf2f6804e19821f438d AnyswapV6ERC20
170
+ 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 FiatTokenProxy
171
+ 0xa2327a938febf5fec13bacfb16ae10ecbc4cbdcf FiatTokenV2_1
172
+ 0x7782046601e7b9b05ca55a3899780ce6ee6b8b2b AnyswapV6Router
173
+ 0xe19105463d6fe2f2bd86c69ad478f4b76ce49c53
174
+
175
+ Proxy => Implementation:
176
+ 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 0xa2327a938febf5fec13bacfb16ae10ecbc4cbdcf
177
+
178
+ Success.
179
+
180
+ If there is a proxy contract, it will be displayed like this:
181
+
182
+ ::
183
+
184
+ Proxy => Implementation:
185
+ 0xff970a61a04b1ca14834a43f5de4533ebddb5cc8 0x1efb3f88bc88f03fd1804a5c53b7141bbef5ded8
186
+ 0x82af49447d8a07e3bd95bd0d56f35241523fbab1 0x8b194beae1d3e0788a1a35173978001acdfba668
187
+
188
+
189
+ In particular, the okex related chain needs apikey to use.
190
+
191
+
192
+ ::
193
+
194
+ [root@hxzy test]#getCode -n okt -p 127.0.0.1:7890 -a 0x0eC4020F29faa430754f1dB07B66798d31006771
195
+ If you want to get the contract code of the okex link, you need to manually enter the api key.
196
+ Visit this link:
197
+ 1. okt: https://www.oklink.com/cn/oktc/address/0x38AB5022BEa07AA8966A9bEB5EF7759b715e4BEE
198
+ 2. okb: https://www.oklink.com/cn/okbc-test/address/0x6BC26C28130e7634fFa1330969f34e98DC4d0019
199
+ 3. okt-testnet: https://www.oklink.com/cn/oktc-test/address/0x7c3ebCB6c4Ae99964980006C61d7eb032eDcb06B
200
+
201
+ Follow the steps below:
202
+ 1. Open the above link
203
+ 2. Open the browser developer tool
204
+ 3. Click the contract tab page on the browser
205
+ 4. Find the request "contract?t="
206
+ 5. X-Apikey in the request header of the request is the required apikey
207
+
208
+ For example:
209
+ getCode -p 127.0.0.1:7890 -n okt -a 0x38AB5022BEa07AA8966A9bEB5EF7759b715e4BEE --apikey LWIzMWUtNDU0Ny05Mjk5LWI2ZDA3Yjc2MzFhYmEyYzkwM2NjfDI4MDQzNDU3Mjc2NjY0OTI=
210
+
211
+ Parameter description:
212
+
213
+ ::
214
+
215
+ optional arguments:
216
+ -h, --help show this help message and exit
217
+ -i INPUTFILE Input file path including contract addresses.
218
+ -o OUTPUTFOLDER Choose a folder to export.
219
+ -a ADDRESS A string including contract addresses.
220
+ -n NETWORK Which network to get source code.
221
+ -k KEY Provide paid api key to download paid-only network code.
222
+ -p PROXY Use a proxy.
223
+ -t TXHASH Get the relevant contract source code in the specified transaction.
224
+ -u Check to see if a new version is available to update.
225
+ -v Show version
226
+ --apikey APIKEY The apikey required by the okex related chain.
227
+
228
+
229
+ Contact
230
+ =======
231
+
232
+ If you have any suggestions or needs please contact: support@hxzy.me
233
+
234
+ Github: https://github.com/5hawnXu/getSourceCode
@@ -0,0 +1,14 @@
1
+ getsourcecode/__init__.py,sha256=ezBHjBLke02NbergTJq7xhsScmwY54rfvG5iyH6LOFQ,3200
2
+ getsourcecode/check.py,sha256=6FZR3EnVPs6ZKdED5ToSJhqQkZ8q3l5VGY1R_4zYKfo,899
3
+ getsourcecode/common.py,sha256=FID9NpJLEkVUBmt4tFCq_Yj3bMjK_GIiRQxziQPhQ88,2415
4
+ getsourcecode/config.py,sha256=8l4_ouu2DqDRbTnVWJMidSlRYXeFqUW4G3QgsMfoTnA,5114
5
+ getsourcecode/filter.py,sha256=LG88gqCZneMAofOrPYhSAEb21JTBQT03ogukMYebmKc,6449
6
+ getsourcecode/handle.py,sha256=w54aIlU8EsfUUpD-3rIcJtJnkuvqteCy8j8oP2y8ZwU,20474
7
+ getsourcecode/keys.py,sha256=_w0CCF9u5NPK2cUajGy796fgWonLMQGf5iVk9JaaWTg,637
8
+ getsourcecode/menu.py,sha256=CQIejGe2K1cosuw_dn2PTkEpcW714RCdm_XDGfzrTMc,3030
9
+ getsourcecode-2.1.0.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
10
+ getsourcecode-2.1.0.dist-info/METADATA,sha256=hYt4VP8KTc7xxOQJe7HZP8n6CbHwvYITREwFpThY170,8256
11
+ getsourcecode-2.1.0.dist-info/WHEEL,sha256=BNRMDyzLkkcmlv0J8ppDQkk2VED33SesJDynr9ED1gc,91
12
+ getsourcecode-2.1.0.dist-info/entry_points.txt,sha256=0HTwsP51i5J9FfjZAlR1qtElea1aHZ-3s1uQyE2vyiI,47
13
+ getsourcecode-2.1.0.dist-info/top_level.txt,sha256=F5bmLjFYY8-702LNPxM9wOF4MtJGQ5mSGWQ6jiuVZ1I,14
14
+ getsourcecode-2.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.3.4)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ getCode = getsourcecode:main
@@ -0,0 +1 @@
1
+ getsourcecode