ShieldedContract

Sync contract wrapper with shielded and transparent namespaces

Synchronous contract wrapper providing encrypted and transparent interaction with Seismic contracts.

Overview

ShieldedContract is the primary sync interface for interacting with Seismic smart contracts. It provides five namespaces for different interaction modes: encrypted writes (.write), encrypted reads (.read), transparent writes (.twrite), transparent reads (.tread), and debug writes (.dwrite). Each namespace dynamically exposes contract methods based on the provided ABI.

Definition

class ShieldedContract:
    def __init__(
        self,
        w3: Web3,
        encryption: EncryptionState,
        private_key: PrivateKey,
        address: ChecksumAddress,
        abi: list[dict[str, Any]],
        eip712: bool = False,
    ) -> None:
        ...

Constructor Parameters

Parameter

Type

Required

Description

w3

Web3

Yes

Synchronous Web3 instance connected to Seismic RPC

encryption

EncryptionState

Yes

Encryption state for shielded operations

private_key

PrivateKey

Yes

32-byte secp256k1 private key for signing transactions

address

ChecksumAddress

Yes

Contract address (checksummed Ethereum address)

abi

list[dict[str, Any]]

Yes

Contract ABI (list of function entries)

eip712

bool

Use EIP-712 typed data signing (default: False)

Namespaces

`.write` - Encrypted Write

Sends encrypted transactions using TxSeismic (type 0x4a). Calldata is encrypted before broadcast.

Returns: HexBytes (transaction hash)

Optional Parameters:

value: int - Wei to send (default: 0)
gas: int | None - Gas limit (default: estimated)
gas_price: int | None - Gas price in wei (default: network suggested)
security: SeismicSecurityParams | None - Security parameters for expiry

`.read` - Encrypted Read

Executes encrypted signed eth_call with encrypted calldata. Result is decrypted by the SDK.

Returns: HexBytes (decrypted result bytes)

Optional Parameters:

value: int - Wei for call context (default: 0)
gas: int - Gas limit (default: 30_000_000)
security: SeismicSecurityParams | None - Security parameters for expiry

`.twrite` - Transparent Write

Sends standard eth_sendTransaction with unencrypted calldata.

Returns: HexBytes (transaction hash)

Optional Parameters:

value: int - Wei to send (default: 0)
**tx_params: Any - Additional transaction parameters (gas, gasPrice, etc.)

`.tread` - Transparent Read

Executes standard eth_call with unencrypted calldata.

Returns: HexBytes (raw result bytes)

Optional Parameters: None (pass positional arguments only)

`.dwrite` - Debug Write

Like .write but returns debug information including plaintext and encrypted views. Transaction is actually broadcast.

Returns: DebugWriteResult

Optional Parameters: Same as .write

Examples

Basic Encrypted Write

from seismic_web3 import create_wallet_client, ShieldedContract, SEISMIC_TESTNET

w3 = create_wallet_client(
    rpc_url="https://gcp-1.seismictest.net/rpc",
    chain=SEISMIC_TESTNET,
    account=private_key,
)

contract = ShieldedContract(
    w3=w3.eth,
    encryption=w3.seismic.encryption,
    private_key=private_key,
    address="0x1234567890123456789012345678901234567890",
    abi=CONTRACT_ABI,
)

# Encrypted write - calldata hidden on-chain
tx_hash = contract.write.setNumber(42)
print(f"Transaction: {tx_hash.to_0x_hex()}")

# Wait for confirmation
receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
print(f"Status: {receipt['status']}")

Encrypted Read

# Encrypted read - calldata and result hidden
result = contract.read.getNumber()

if result:
    # Decrypt result if needed
    print(f"Raw result: {result.to_0x_hex()}")

Transparent Operations

# Transparent write - calldata visible on-chain
tx_hash = contract.twrite.setPublicData("hello", value=10**18)
receipt = w3.eth.wait_for_transaction_receipt(tx_hash)

# Transparent read - standard eth_call
result = contract.tread.getPublicData()
print(f"Result: {result.to_0x_hex()}")

Debug Write

# Debug write - returns plaintext and encrypted views
debug_result = contract.dwrite.transfer("0xRecipient...", 1000)

print(f"Transaction hash: {debug_result.tx_hash.to_0x_hex()}")
print(f"Plaintext data: {debug_result.plaintext_tx.data.to_0x_hex()}")
print(f"Encrypted data: {debug_result.shielded_tx.data.to_0x_hex()}")

# Transaction is actually broadcast
receipt = w3.eth.wait_for_transaction_receipt(debug_result.tx_hash)

With Transaction Parameters

# Custom gas and value
tx_hash = contract.write.deposit(
    amount=1000,
    value=10**18,  # 1 ETH
    gas=200_000,
    gas_price=20 * 10**9,  # 20 gwei
)

# With security parameters
from seismic_web3.transaction_types import SeismicSecurityParams

security = SeismicSecurityParams(expires_in_blocks=100)
tx_hash = contract.write.sensitiveOperation(
    data="secret",
    security=security,
)

Using EIP-712 Signing

# Enable EIP-712 for typed data signing
contract = ShieldedContract(
    w3=w3.eth,
    encryption=w3.seismic.encryption,
    private_key=private_key,
    address=contract_address,
    abi=CONTRACT_ABI,
    eip712=True,  # Use EIP-712 instead of raw signing
)

tx_hash = contract.write.performAction(123)

Instantiation via Client

# Most common pattern - let the client create the contract
from seismic_web3 import create_wallet_client

w3 = create_wallet_client(
    rpc_url="https://gcp-1.seismictest.net/rpc",
    chain=SEISMIC_TESTNET,
    account=private_key,
)

# Client's contract() method creates ShieldedContract
contract = w3.seismic.contract(address=contract_address, abi=CONTRACT_ABI)

# Now use any namespace
tx_hash = contract.write.myFunction(arg1, arg2)

Notes

Dynamic method access: Contract methods are accessed via __getattr__, so contract.write.myFunction() dynamically resolves to the ABI function
ABI remapping: Shielded types (suint256, sbool, saddress) are remapped to standard types for encoding while preserving original names for selector computation
Gas estimation: .write and .twrite estimate gas if not provided explicitly
Encryption overhead: Encrypted operations add ~16 bytes (AES-GCM auth tag) to calldata
EIP-712 vs raw: EIP-712 signing provides better wallet integration; raw signing is faster for automation
Use .write in production: .dwrite is for debugging only

hashtagOverview

hashtagDefinition

hashtagConstructor Parameters

hashtagNamespaces

hashtag.write - Encrypted Write

hashtag.read - Encrypted Read

hashtag.twrite - Transparent Write

hashtag.tread - Transparent Read

hashtag.dwrite - Debug Write

hashtagExamples

hashtagBasic Encrypted Write

hashtagEncrypted Read

hashtagTransparent Operations

hashtagDebug Write

hashtagWith Transaction Parameters

hashtagUsing EIP-712 Signing

hashtagInstantiation via Client

hashtagNotes

hashtagSee Also

Overview

Definition

Constructor Parameters

Namespaces

`.write` - Encrypted Write

`.read` - Encrypted Read

`.twrite` - Transparent Write

`.tread` - Transparent Read

`.dwrite` - Debug Write

Examples

Basic Encrypted Write

Encrypted Read

Transparent Operations

Debug Write

With Transaction Parameters

Using EIP-712 Signing

Instantiation via Client

Notes

See Also