starcoin.sdk package

Submodules

starcoin.sdk.auth_key module

Provides AuthKey class for holding Diem authentication key and generating account address, prefix from it.

class starcoin.sdk.auth_key.AuthKey(data: bytes)

Bases: object

Diem Authentication Key

Wraps authentication key bytes, derives account address and authentication key prefix.

account_address() → starcoin.starcoin_types.AccountAddress

data: bytes

static from_public_key(public_key: cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey) → starcoin.sdk.auth_key.AuthKey

hex() → str

prefix() → bytes

starcoin.sdk.client module

class starcoin.sdk.client.Client(url)

Bases: object

Starcoin sdk client

contract_call(function_id: str, type_args: list, args: list)

execute(operation)

Execute a rpc request operation operation = {

“rpc_method”: $rpc_method, “params”: $params,

} such as: operation = {

“rpc_method”: “node.info”, “params”: None,

}

get_account_resource(addr: str) → starcoin.starcoin_types.AccountResource

get_account_sequence(addr: str) → int

get_account_token(addr: str, module: str, name: str) → int

get_block_by_number(number: int) → dict

get_block_reward(block_number: int)

get block reward by blcok_number, block_number shoule less than header.block_number return coin_reward, author, gas_fee

get_blocks_by_number(number: int, count: int) → dict

get_events_by_txn_hash(txn_hash: str)

get_resource(addr: str, resource_type: str, option=None)

get_transaction(txn_hash: str) → dict

get_transaction_info(txn_hash: str) → dict

get_txpool_pending_txn(txn_hash: str) → dict

is_account_exist(addr: str) → bool

node_info() → dict

Starcoin node information

Return the node information

node_status() → bool

Starcoin node status

state_get(access_path: str) → bytes

submit(txn: Union[starcoin.starcoin_types.SignedUserTransaction, str])

exception starcoin.sdk.client.InvalidServerResponse

Bases: Exception

exception starcoin.sdk.client.JsonResponseError

Bases: Exception

class starcoin.sdk.client.RpcRequest(url)

Bases: object

prepare(rpc_method, params=None)

exception starcoin.sdk.client.StateNotFoundError

Bases: ValueError

starcoin.sdk.local_account module

Provides LocalAccount class for holding local account private key.

LocalAccount provides operations we need for creating auth key, account address and signing raw transaction.

class starcoin.sdk.local_account.LocalAccount(private_key: cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey)

Bases: object

LocalAccount is like a wallet account

WARN: This is handy class for creating tests for your application, but may not ideal for your production code, because it uses a specific implementaion of ed25519 and requires loading your private key into memory and hand over to code from external. You should always choose more secure way to handle your private key (e.g. https://en.wikipedia.org/wiki/Hardware_security_module) in production and do not give your private key to any code from external if possible.

property account_address: starcoin.starcoin_types.AccountAddress

property auth_key: starcoin.sdk.auth_key.AuthKey

compliance_key: cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey

property compliance_public_key_bytes: bytes

static generate() → starcoin.sdk.local_account.LocalAccount

Generate a random private key and initialize local account

private_key: cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey

property public_key: cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey

property public_key_bytes: bytes

sign(txn: starcoin.starcoin_types.RawTransaction) → starcoin.starcoin_types.SignedUserTransaction

Create signed transaction for given raw transaction

starcoin.sdk.utils module

Utilities for data type converting, construction and hashing.

exception starcoin.sdk.utils.InvalidAccountAddressError

Bases: Exception

exception starcoin.sdk.utils.InvalidSignedMessage

Bases: Exception

exception starcoin.sdk.utils.InvalidSubAddressError

Bases: Exception

starcoin.sdk.utils.account_address(addr: Union[starcoin.starcoin_types.AccountAddress, bytes, str]) → starcoin.starcoin_types.AccountAddress

convert an account address from hex-encoded or bytes into starcoin_types.AccountAddress

Returns given address if it is starcoin_types.AccountAddress already

starcoin.sdk.utils.account_address_bytes(addr: Union[starcoin.starcoin_types.AccountAddress, str]) → bytes

convert starcoin_types.AccountAddress or hex-encoded account address into bytes

starcoin.sdk.utils.account_address_hex(addr: Union[starcoin.starcoin_types.AccountAddress, str]) → str

convert starcoin_types.AccountAddress into hex-encoded string

This function converts given parameter into account address bytes first, then convert bytes into hex-encoded string

starcoin.sdk.utils.create_signed_transaction(txn: starcoin.starcoin_types.RawTransaction, public_key: bytes, signature: bytes) → starcoin.starcoin_types.SignedUserTransaction

create single signed starcoin_types.SignedTransaction

starcoin.sdk.utils.currency_code(code: str) → starcoin.starcoin_types.TypeTag

converts currency code string to starcoin_types.TypeTag

starcoin.sdk.utils.currency_user_code(address: str, code: str) → starcoin.starcoin_types.TypeTag

converts currency code string to starcoin_types.TypeTag

starcoin.sdk.utils.hash(b1: bytes, b2: bytes) → bytes

starcoin.sdk.utils.hex_to_tuple(input: str) → tuple

starcoin.sdk.utils.payload_bcs_decode(payload: str) → Union[starcoin.starcoin_types.Script, starcoin.starcoin_types.Package]

starcoin.sdk.utils.public_key_bytes(public_key: cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey) → bytes

convert cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey into bytes

starcoin.sdk.utils.raw_transaction_signing_msg(txn: starcoin.starcoin_types.RawTransaction) → bytes

create signing message from given starcoin_types.RawTransaction

starcoin.sdk.utils.starcoin_hash_seed(typ: bytes) → bytes

starcoin.sdk.utils.sub_address(addr: Union[str, bytes]) → bytes

convert hex-encoded sub-address into bytes

This function validates bytes length, and raises InvalidSubAddressError if length does not match sub-address length (8 bytes)

starcoin.sdk.utils.transaction_hash(txn: starcoin.starcoin_types.SignedUserTransaction) → str

create transaction hash from given starcoin_types.SignedTransaction

starcoin.sdk.utils.type_tag_to_str(code: starcoin.starcoin_types.TypeTag) → str

converts currency code TypeTag into string

starcoin.sdk.utils.verify_signed_message(signed_message_hex: str) → starcoin.starcoin_types.SignedMessage

Module contents