polkadot-contract-sdk 1.0.0

SDK for deploying and interacting with smart contracts on Polkadot/Kusama networks

Polkadot Smart Contract SDK

A simple SDK for deploying and interacting with smart contracts on Polkadot/Kusama networks. Write Python code and deploy it directly to the blockchain!

Installation

pip install polkadot-contract-sdk

Quick Start

1. Deploy a Contract

Create a Python file main.py:

def multiply_numbers(a, b):
    return a * b

def main():
    print(multiply_numbers(2, 3))

if __name__ == "__main__":
    main()

Deploy it:

sdk-deploy-contract main.py

2. Interact with a Contract

# Use contract address from deployment.json
sdk-interact

# Or specify contract address directly
sdk-interact 0x1234567890123456789012345678901234567890

Setup

Set your private key as an environment variable:

export PRIVATE_KEY='your_private_key_here'

Or create a .env file:

PRIVATE_KEY=your_private_key_here

Commands

sdk-deploy-contract

Deploy a Python file as a smart contract.

sdk-deploy-contract <python-file> [options]

Options:

• -o, --output: Output file for deployment information (default: deployment.json)
• -r, --rpc: Custom RPC URL (default: Moonbase Alpha testnet)

Example:

sdk-deploy-contract main.py -o my_deployment.json

sdk-interact

Interact with a deployed smart contract.

sdk-interact [contract-address] [options]

Options:

• -p, --python-file: Path to original Python file (default: main.py)
• -d, --deployment: Path to deployment.json (default: deployment.json)
• -r, --rpc: Custom RPC URL (default: Moonbase Alpha testnet)

Examples:

# Load from deployment.json
sdk-interact

# Use specific contract address
sdk-interact 0x1234567890123456789012345678901234567890

# Custom files
sdk-interact -p my_contract.py -d my_deployment.json

How It Works

1. Deployment: The SDK reads your Python file, extracts functions, and compiles them to blockchain bytecode. Internally, it uses Solidity as an intermediate step, but you only write Python code.

2. Interaction: The SDK reads your original Python file to discover available functions and provides an interactive menu to call them on the deployed contract.

Requirements

• Python 3.8+
• web3>=6.0.0
• py-solc-x>=1.1.1
• python-dotenv>=1.0.0

Network Support

• Moonbase Alpha (Testnet) - Default
• Moonriver (Kusama Parachain)
• Any EVM-compatible network via custom RPC URL

Getting Testnet Tokens

For Moonbase Alpha testnet, get free tokens from: https://faucet.moonbeam.network/

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For issues and questions, please open an issue on GitHub.