sapphirepy package

Submodules

sapphirepy.deoxysii module

This work is derived from: https://github.com/oasisprotocol/deoxysii

Copyright (c) 2019 Oasis Labs Inc. <info@oasislabs.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

class sapphirepy.deoxysii.DeoxysII(key: bytes | bytearray)

Bases: object

decrypt(nonce: bytes | bytearray, dst: bytearray, ad: bytes | bytearray | None, ciphertext: bytes | bytearray)

derived_k: list[bytearray]

encrypt(nonce: bytes | bytearray, dst: bytearray, ad: bytes | bytearray | None, msg: bytes | bytearray | None)

property implementation

sapphirepy.deoxysii.bc_encrypt(ciphertext: bytearray, derived_k: list[bytearray], tweak: bytearray, plaintext: bytes | bytearray)

sapphirepy.deoxysii.derive_sub_tweak_keys(derived_k: list[bytearray], t: bytearray)

sapphirepy.deoxysii.encode_enc_tweak(out: bytearray, tag: bytes, block_nr: int)

sapphirepy.deoxysii.encode_tag_tweak(out: bytearray, prefix: int, block_nr: int)

sapphirepy.deoxysii.lfsr2(t: bytearray)

sapphirepy.deoxysii.lfsr3(t: bytearray)

sapphirepy.deoxysii.stk_derive_k(key: bytes | bytearray)

sapphirepy.deoxysii.stk_shuffle(t: bytearray)

sapphirepy.deoxysii.uint8(x: int)

sapphirepy.deoxysii.xor_bytes(out: bytearray, a: bytearray | bytes, b: bytearray | bytes, n: int)

sapphirepy.deoxysii.xor_rc(t: bytearray, i: int)

sapphirepy.envelope module

class sapphirepy.envelope.AeadEnvelope

Bases: TypedDict

data: bytes

nonce: bytes

exception sapphirepy.envelope.CallError

Bases: SapphireError

exception sapphirepy.envelope.DecryptError

Bases: SapphireError

exception sapphirepy.envelope.EnvelopeError

Bases: SapphireError

class sapphirepy.envelope.Failure

Bases: TypedDict

code: int

message: str | None

module: str

class sapphirepy.envelope.RequestBody

Bases: TypedDict

data: bytes

epoch: int

nonce: bytes

pk: bytes

class sapphirepy.envelope.RequestEnvelope

Bases: TypedDict

body: dict

format: int

class sapphirepy.envelope.ResultInner

Bases: TypedDict

fail: Failure

ok: bytes

class sapphirepy.envelope.ResultOuter

Bases: TypedDict

failure: Failure | None

ok: AeadEnvelope | None

unknown: AeadEnvelope | None

class sapphirepy.envelope.TransactionCipher(peer_pubkey: PublicKey | str, peer_epoch: int)

Bases: object

cipher: DeoxysII

decrypt(response: bytes)

encrypt(plaintext: bytes)

ephemeral_pubkey: bytes

epoch: int

make_envelope(plaintext: bytes)

sapphirepy.error module

exception sapphirepy.error.SapphireError

Bases: Exception

sapphirepy.sapphire module

class sapphirepy.sapphire.CalldataPublicKey

Bases: TypedDict

checksum: HexStr

epoch: int

key: HexStr

signature: HexStr

class sapphirepy.sapphire.CalldataPublicKeyManager

Bases: object

add(pk: CalldataPublicKey)

property newest

class sapphirepy.sapphire.ConstructSapphireMiddlewareBuilder(w3: AsyncWeb3 | Web3)

Bases: Web3MiddlewareBuilder

Construct a Sapphire middleware for Web3.py. :param account: Used to encrypt signed queries. :return: A Sapphire middleware function.

async async_wrap_make_request(make_request: Callable[[RPCEndpoint, Any], Coroutine[Any, Any, RPCResponse]]) → Callable[[RPCEndpoint, Any], Coroutine[Any, Any, RPCResponse]]

Async version of wrap_make_request that handles the same encryption logic for eth_estimateGas, eth_sendTransaction, and eth_call

build

sapphire_account = None

wrap_make_request(make_request: Callable[[RPCEndpoint, Any], RPCResponse]) → Callable[[RPCEndpoint, Any], RPCResponse]

Synchronous wrapper around async_wrap_make_request. Creates a new event loop to run the async middleware.

Transparently encrypt the calldata for:

• eth_estimateGas

• eth_sendTransaction

• eth_call

The calldata public key, which used to derive a shared secret with an ephemeral key, is retrieved upon the first request. This key is rotated by Sapphire every epoch, and only transactions encrypted with keys from the last 5 epochs are considered valid.

Deployment transactions will not be encrypted, unless the global ENCRYPT_DEPLOYS flag is set. Encrypting deployments will prevent contracts from being verified.

Pre-signed transactions can’t be encrypted if submitted via this instance.

sapphirepy.sapphire.wrap(w3: Web3 | AsyncWeb3, account: LocalAccount | None = None)

Adds the Sapphire transaction encryption middleware to a Web3.py provider.

Note: the provider must be wrapped after any signing middleware has been

added, otherwise pre-signed transactions will not be encrypted.

Module contents