Skip to content

tradeparadex/paradex-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Paradex CLI

PyPI version License: MIT

Paradex CLI is a command-line interface (CLI) for managing account contract setups, including printing account info, adding guardians, changing signers, and more.

Installation

You can install the package via pip:

pip install paradex_cli

Or using Poetry:

poetry add paradex_cli

Commands

Print Account Info

paradex_cli print-account-info ACCOUNT_ADDRESS --env ENVIRONMENT

Add Guardian

paradex_cli add-guardian PUB_KEY --env ENVIRONMENT

Add Guardian Backup

paradex_cli add-guardian-backup PUB_KEY --env ENVIRONMENT

Change Signer

paradex_cli change-signer PUB_KEY --env ENVIRONMENT

Sign Invoke Transaction

paradex_cli sign-invoke-tx FILE_PATH --env ENVIRONMENT

Submit Invoke Transaction

paradex_cli submit-invoke-tx TX_FILE_PATH SIG_FILES --env ENVIRONMENT

Trigger Escape Guardian

paradex_cli trigger-escape-guardian --env ENVIRONMENT

Development

To contribute to this project, follow these steps:

1. Clone the Repository

git clone https://github.com/tradeparadex/paradex_cli.git
cd paradex_cli

2. Install Dependencies

Install the dependencies using Poetry:

poetry install

3. Run Tests

Ensure everything is working by running the tests:

poetry run pytest

4. Make Your Changes

Make your changes to the codebase.

5. Add Tests

Add tests for your new features or bug fixes.

6. Run Tests Again

Run the tests again to make sure everything is still working:

poetry run pytest

7. Commit Your Changes

Commit your changes and push them to your fork:

git add .
git commit -m "Description of your changes"
git push origin your-branch

8. Create a Pull Request

Create a pull request against the main branch of this repository.

Building the Project

To build the project, run:

poetry build

Publishing the Project

To publish the project to PyPI, run:

poetry publish --build

Make sure you have configured your PyPI token:

poetry config pypi-token.pypi <your-token>

About

Paradex CLI

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages