Core SDK

A Python SDK to interact with the JPYCv2's core contracts. Ideal for those who want to interact with JPYC protocol in any Python-backend environments.

🪄 Usage

1. Install jpyc-core-sdk Package

# uv
$ uv add jpyc-core-sdk
# poetry
$ poetry add jpyc-core-sdk
# pip
$ pip install jpyc-core-sdk

2. Configure SDK Clients

from jpyc_core_sdk import JPYC, SdkClient

# Configure SDK client using default RPC endpoint
client = SdkClient(
    chain_name="ethereum",
    network_name="mainnet",
    private_key={PRIVATE_KEY},
)

# Or configure SDK client using custom RPC endpoint
client = SdkClient(
    chain_name="ethereum",
    network_name="mainnet",
    private_key={PRIVATE_KEY},
    rpc_endpoint={CUSTOM_RPC_ENDPOINT},
)

# Configure JPYC client
jpyc = JPYC(client=client)

3. Call JPYC Contracts

Use the configured JPYC client to call JPYC's contract functions wherever you would like.

from {CONFIG_FILE} import jpyc

...
# Call a contract function (e.g., transfer)
tx_hash = jpyc.transfer(
    to={TO_ADDRESS},
    value=2025,
)
...

⛓️ Supported Networks

Please use one of the combinations of chain-network names when configuring the SDK clients.

💬 Supported Providers

We're currently supporting HTTPProvider (the most simple & widely-used one) only. More providers (notably WebSocketProvider) are to be supported in the near future, so stay tuned!

🛠 Development

📦 Package Management

Add packages

# add packages for production
$ uv add {package_name}
# add packages for development
$ uv add --dev {package_name}

Remove packages

# remove production packages
$ uv remove {package_name}
# remove development packages
$ uv remove --dev {package_name}

🔎 Testing

Please see README at tests directory.

✅ Static Code Analysis

Linting

# run linter without fixing
$ uv run ruff check {dir_name}
# run linter & auto-fix (if available)
$ uv run ruff check {dir_name} --fix

Formatting

# run formatter without fixing
$ uv run ruff format {dir_name} --check
# run formatter & auto-fix
$ uv run ruff format {dir_name}

Type Checking

# run mypy
$ uv run mypy {dir_name}

Pre-Commit Hooks

Pre-commit script is configured at .pre-commit-config.yaml. This automatically runs the configured hooks before executing any git commit commands. You could also simulate the hooks by running the following.

# simulate pre-commit hooks without creating an actual commit
$ uv run pre-commit run --all-files

📝 Comments & Docstrings

Docstrings should be written in the Google-style.