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)[source]

Bases: object

decrypt(nonce: bytes | bytearray, dst: bytearray, ad: bytes | bytearray | None, ciphertext: bytes | bytearray)[source]
derived_k: list[bytearray]
encrypt(nonce: bytes | bytearray, dst: bytearray, ad: bytes | bytearray | None, msg: bytes | bytearray | None)[source]
property implementation
sapphirepy.deoxysii.bc_encrypt(ciphertext: bytearray, derived_k: list[bytearray], tweak: bytearray, plaintext: bytes | bytearray)[source]
sapphirepy.deoxysii.derive_sub_tweak_keys(derived_k: list[bytearray], t: bytearray)[source]
sapphirepy.deoxysii.encode_enc_tweak(out: bytearray, tag: bytes, block_nr: int)[source]
sapphirepy.deoxysii.encode_tag_tweak(out: bytearray, prefix: int, block_nr: int)[source]
sapphirepy.deoxysii.lfsr2(t: bytearray)[source]
sapphirepy.deoxysii.lfsr3(t: bytearray)[source]
sapphirepy.deoxysii.stk_derive_k(key: bytes | bytearray)[source]
sapphirepy.deoxysii.stk_shuffle(t: bytearray)[source]
sapphirepy.deoxysii.uint8(x: int)[source]
sapphirepy.deoxysii.xor_bytes(out: bytearray, a: bytearray | bytes, b: bytearray | bytes, n: int)[source]
sapphirepy.deoxysii.xor_rc(t: bytearray, i: int)[source]

sapphirepy.envelope module

class sapphirepy.envelope.AeadEnvelope[source]

Bases: TypedDict

data: bytes
nonce: bytes
exception sapphirepy.envelope.CallError[source]

Bases: SapphireError

exception sapphirepy.envelope.DecryptError[source]

Bases: SapphireError

exception sapphirepy.envelope.EnvelopeError[source]

Bases: SapphireError

class sapphirepy.envelope.Failure[source]

Bases: TypedDict

code: int
message: str | None
module: str
class sapphirepy.envelope.RequestBody[source]

Bases: TypedDict

data: bytes
epoch: int
nonce: bytes
pk: bytes
class sapphirepy.envelope.RequestEnvelope[source]

Bases: TypedDict

body: dict
format: int
class sapphirepy.envelope.ResultInner[source]

Bases: TypedDict

fail: Failure
ok: bytes
class sapphirepy.envelope.ResultOuter[source]

Bases: TypedDict

failure: Failure | None
ok: AeadEnvelope | None
unknown: AeadEnvelope | None
class sapphirepy.envelope.TransactionCipher(peer_pubkey: PublicKey | str, peer_epoch: int)[source]

Bases: object

cipher: DeoxysII
decrypt(response: bytes)[source]
encrypt(plaintext: bytes)[source]
ephemeral_pubkey: bytes
epoch: int
make_envelope(plaintext: bytes)[source]

sapphirepy.error module

exception sapphirepy.error.SapphireError[source]

Bases: Exception

sapphirepy.sapphire module

class sapphirepy.sapphire.CalldataPublicKey[source]

Bases: TypedDict

checksum: HexStr
epoch: int
key: HexStr
signature: HexStr
class sapphirepy.sapphire.CalldataPublicKeyManager[source]

Bases: object

add(pk: CalldataPublicKey)[source]
property newest
sapphirepy.sapphire.construct_sapphire_middleware(account: LocalAccount | None = None) → Callable[[Callable[[RPCEndpoint, Any], RPCResponse], Web3], Any][source]

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

sapphirepy.sapphire.wrap(w3: Web3, account: LocalAccount | None = None)[source]

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