Skip to content

Commit 3620baf

Browse files
j0nl1j0nl1
j0nl1
authored and
j0nl1
committed
doc: v0.0.5 (#11)
* add code of conduct * add contributing * add license * add readme
1 parent 7bf3168 commit 3620baf

File tree

6 files changed

+384
-2
lines changed

6 files changed

+384
-2
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
## Code of Conduct
2+
3+
### Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
### Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
### Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
### Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
### Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at hi@arcturus.zone. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
### Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.

‎LICENSE‎

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

‎README.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# COSMWASM CLI
2+
3+
This package is a cli that allows cosmwasm to interact with different networks.
4+
5+
[![GitHub license](https://img.shields.io/github/license/j0nl1/cw-cli.svg?color=blue&style=for-the-badge)](./LICENSE)
6+
[![npm](https://img.shields.io/npm/v/cosmwasm-cli.svg?color=green&style=for-the-badge)](https://www.npmjs.com/package/cosmwasm-cli)
7+
8+
## Installation
9+
10+
```sh
11+
npm i -g cosmwasm-cli
12+
```
13+
14+
> :warning: **Is necessary to config a key in order to interact with the cli**
15+
16+
## API Usage
17+
18+
```sh
19+
Usage: cwcli [command]
20+
21+
Cosmwasm Command Line Interface
22+
23+
Options:
24+
-V, --version output the version number
25+
-h, --help display help for command
26+
27+
Commands:
28+
keys [command] manage your keys
29+
networks [command] manage networks
30+
wasm [command] wasm transaction subcommands
31+
help [command] display help for command
32+
```
33+
34+
> **Wasm Command**
35+
36+
```sh
37+
Usage: cwcli wasm [command]
38+
39+
Wasm transaction subcommands
40+
41+
Options:
42+
-h, --help display help for command
43+
44+
Commands:
45+
upload [options] <wasm file> Upload a wasm binary
46+
query [options] <contractAddress> <msg> Querying commands for contracts
47+
execute [options] <contractAddress> <msg> execute a smart contract method
48+
instantiate [options] <codeId> <msg> instantiate an uploaded contract
49+
help [command] display help for command
50+
```
51+
52+
> **Keys Command**
53+
54+
```sh
55+
Usage: cwcli keys [command]
56+
57+
Manage your keys
58+
59+
Options:
60+
-h, --help display help for command
61+
62+
Commands:
63+
add <name> Add an encrypted private key (either newly generated or recovered), encrypt it, and save to keyring
64+
delete <name> Delete keys from the cli
65+
show [options] <name> Return address depending on network selection
66+
list Return a list of all public keys stored by this cli
67+
help [command] display help for command display help for command
68+
```
69+
70+
> **Network Command**
71+
72+
```sh
73+
Usage: cwcli networks [command]
74+
75+
Manage networks
76+
77+
Options:
78+
-h, --help display help for command
79+
80+
Commands:
81+
add <filePath> Load a custom network
82+
delete <name> Remove a custom network
83+
list show a list of networks
84+
help [command] display help for command
85+
```
86+
87+

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cosmwasm-cli",
3-
"version": "0.0.5",
3+
"version": "0.1.5",
44
"author": "Javier Aceña <j0nl1>",
55
"description": "Cosmwasm Command Line Interface",
66
"scripts": {

0 commit comments

Comments
 (0)