Python SDK for the EpicChain blockchain
Project description
EpicChain Python SDK
Overview
The EpicChain Python SDK is a powerful development framework designed to simplify interaction with the EpicChain blockchain using Python. This SDK gives developers full access to blockchain features such as smart contract deployment and execution, wallet and key management, blockchain data querying, and transaction handling — all in a highly modular and secure fashion.
Whether you're building a DApp backend, managing digital assets, or deploying smart contracts for finance, governance, identity, or gaming, this SDK delivers a flexible and developer-centric approach to EpicChain development.
Core Features
✅ Smart Contract Deployment
Deploy XEF-compiled contracts with manifest files using a simple Python API. Supports contract metadata, parameter configuration, and permission control.
✅ Contract Invocation
Call smart contract functions and receive on-chain results using signed transactions or test invocations for non-persistent simulations.
✅ Contract Upgrade System
Replace an existing deployed contract with an upgraded logic version, preserving its state and address while enhancing behavior.
✅ Safe Destruction
Programmatically destroy a contract to remove it from the blockchain and free up network resources.
✅ Wallet & Account Integration
Generate new wallets, import existing keys, securely store credentials, and authorize transactions on behalf of multiple users or roles.
✅ Real-Time Blockchain Access
Query block details, transaction histories, state variables, and events emitted by smart contracts — in real-time.
Getting Started
Installation
Install the SDK via pip:
pip install epicchain-python-sdk
Or for local development:
git clone https://github.com/epicchainlabs/epicchain-python-sdk.git
cd epicchain-python-sdk
python setup.py install
Smart Contract Lifecycle: Full Working Samples
🔹 Contract v1: Add +1 Function
This version implements a simple contract with one function: add(x), which returns x + 1.
import asyncio
from epicchain.api.wrappers import GenericContract, ChainFacade
from epicchain.api.helpers.signing import sign_insecure_with_account
from epicchain.api.helpers import unwrap
from epicchain.contracts import xef, manifest
from epicchain.network.payloads.verification import Signer
# Load contract files
xef_v1 = xef.XEF.from_file("contracts/contract_v1.xef")
manifest_v1 = manifest.ContractManifest.from_file("contracts/contract_v1.manifest.json")
async def deploy_contract_v1(facade, signer):
print("Deploying Contract v1...")
receipt = await facade.invoke(GenericContract.deploy(xef_v1, manifest_v1))
contract_hash = receipt.result
print(f"Contract deployed at: {contract_hash}")
return GenericContract(contract_hash)
🔹 Call add(1) on Contract v1
async def call_add(contract, facade, input_value):
print(f"Calling `add({input_value})`...", end=" ")
result = await facade.test_invoke(contract.call_function("add", [input_value]))
print("Result:", unwrap.as_int(result))
🔹 Contract v2: Add +2 Function (Upgrade)
This version replaces the add function logic with x + 2.
xef_v2 = xef.XEF.from_file("contracts/contract_v2.xef")
manifest_v2 = manifest.ContractManifest.from_file("contracts/contract_v2.manifest.json")
async def update_contract(contract, facade):
print("Updating to Contract v2...", end=" ")
await facade.invoke(contract.update(xef=xef_v2, manifest=manifest_v2))
print("Done.")
🔹 Destroying the Contract
async def destroy_contract(contract, facade):
print("Destroying contract...", end=" ")
await facade.invoke(contract.destroy())
print("Contract destroyed.")
🔹 Full Lifecycle Runner
async def main():
from examples import shared
wallet = shared.user_wallet
account = wallet.account_default
facade = ChainFacade(rpc_host=shared.EpicChainExpress().rpc_host)
facade.add_signer(
sign_insecure_with_account(account, password="123"),
Signer(account.script_hash)
)
contract = await deploy_contract_v1(facade, account)
await call_add(contract, facade, 1) # Expect result: 2
await update_contract(contract, facade)
await call_add(contract, facade, 1) # Expect result: 3
await destroy_contract(contract, facade)
if __name__ == "__main__":
asyncio.run(main())
Multiple Contract Samples
Sample A: Math Contract (add, subtract)
A smart contract that performs multiple arithmetic operations:
# contract_math.xef with functions: add(a, b), subtract(a, b)
result = await facade.test_invoke(contract.call_function("add", [5, 2]))
print("5 + 2 =", unwrap.as_int(result))
result = await facade.test_invoke(contract.call_function("subtract", [10, 3]))
print("10 - 3 =", unwrap.as_int(result))
Sample B: Storage Contract
A contract that stores and retrieves values using keys.
# contract_store.xef with set_value(key, val) and get_value(key)
await facade.invoke(contract.call_function("set_value", ["username", "Xmoohad"]))
result = await facade.test_invoke(contract.call_function("get_value", ["username"]))
print("Stored username:", unwrap.as_str(result))
Sample C: Token Contract
A standard token contract implementing balance tracking.
# contract_token.xef with functions: balance_of(address), transfer(to, amount)
await facade.invoke(contract.call_function("transfer", [receiver_address, 100]))
balance = await facade.test_invoke(contract.call_function("balance_of", [receiver_address]))
print("New Balance:", unwrap.as_int(balance))
Use Cases & Integrations
- Decentralized Applications: Create robust dApps powered by EpicChain contracts.
- Fintech & Payments: Handle token transfers, microtransactions, and DeFi logic.
- Gaming & NFTs: Issue and manage digital game assets.
- Document Verification: Hash, anchor, and verify real-world files or IDs on-chain.
- Cross-Chain Interactions: Extend EpicChain to operate with other ecosystems.
Contribution
We invite developers, auditors, and engineers to contribute to the SDK:
- Improve support for async workflows.
- Add new wrappers and examples.
- Suggest enhancements or performance improvements.
Follow the guide in CONTRIBUTING.md.
Support
For assistance, questions, or suggestions:
- 📧 Email:
support@epic-chain.org - 🛠 GitHub: Submit issues
- 📚 Docs & API Reference: Coming soon at
https://epic-chain.org/docs,
License
Licensed under the MIT License. See LICENSE for full terms.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file epicchain_python_sdk-1.0.0.tar.gz.
File metadata
- Download URL: epicchain_python_sdk-1.0.0.tar.gz
- Upload date:
- Size: 208.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d3c40a44dbba318054e4664a5a153cdf240348f0399ffe3fe8073306b8365b88
|
|
| MD5 |
bc09a6d8adeb10de977cd07f98986925
|
|
| BLAKE2b-256 |
7bae5c075d855c98f8e3e6d3a20bcbbac879d6b6f115670727470fdfb8644ad8
|
File details
Details for the file epicchain_python_sdk-1.0.0-py3-none-any.whl.
File metadata
- Download URL: epicchain_python_sdk-1.0.0-py3-none-any.whl
- Upload date:
- Size: 128.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d985a8f18a6a4425d516839886899b53a0c97dd6fdd6a0271c80b784ea538fdc
|
|
| MD5 |
ce89f3ddfd1c47c6f9d840f3dbf4891e
|
|
| BLAKE2b-256 |
9e3e8694710f2991b86399e66c518325e3dfb67fbd9ef642e2e7a4f7cc60fac0
|