starcoin.starcoin_types package

Module contents

class starcoin.starcoin_types.AcceptTokenEvent(token_code: ‘TokenCode’)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.AcceptTokenEvent[source]
bcs_serialize() → bytes[source]
token_code: starcoin.starcoin_types.TokenCode
class starcoin.starcoin_types.AccessPath(address: ‘AccountAddress’, path: ‘DataPath’)[source]

Bases: object

address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.AccessPath[source]
bcs_serialize() → bytes[source]
path: starcoin.starcoin_types.DataPath
class starcoin.starcoin_types.AccountAddress(value: Tuple[numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.AccountAddress[source]
bcs_serialize() → bytes[source]
static from_hex(addr: str) → starcoin.starcoin_types.AccountAddress[source]

Create an account address from bytes.

value: Tuple[numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8, numpy.uint8]
class starcoin.starcoin_types.AccountResource(authentication_key: bytes, withdrawal_capability: Union[ForwardRef(‘WithdrawCapabilityResource’), NoneType], key_rotation_capability: Union[ForwardRef(‘KeyRotationCapabilityResource’), NoneType], received_events: ‘EventHandle’, sent_events: ‘EventHandle’, accept_token_events: ‘EventHandle’, sequence_number: numpy.uint64)[source]

Bases: object

accept_token_events: starcoin.starcoin_types.EventHandle
authentication_key: bytes
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.AccountResource[source]
bcs_serialize() → bytes[source]
key_rotation_capability: Optional[starcoin.starcoin_types.KeyRotationCapabilityResource]
received_events: starcoin.starcoin_types.EventHandle
sent_events: starcoin.starcoin_types.EventHandle
sequence_number: numpy.uint64
withdrawal_capability: Optional[starcoin.starcoin_types.WithdrawCapabilityResource]
class starcoin.starcoin_types.BalanceResource(token: starcoin.serde_types.uint128)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.BalanceResource[source]
bcs_serialize() → bytes[source]
token: starcoin.serde_types.uint128
class starcoin.starcoin_types.BlockMetadata(parent_hash: ‘HashValue’, timestamp: numpy.uint64, author: ‘AccountAddress’, auth_key_prefix: bytes, uncles: numpy.uint64, number: numpy.uint64)[source]

Bases: object

auth_key_prefix: bytes
author: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.BlockMetadata[source]
bcs_serialize() → bytes[source]
number: numpy.uint64
parent_hash: starcoin.starcoin_types.HashValue
timestamp: numpy.uint64
uncles: numpy.uint64
class starcoin.starcoin_types.BlockRewardEvent(block_number: numpy.uint64, block_reward: starcoin.serde_types.uint128, gas_fees: starcoin.serde_types.uint128, miner: ‘AccountAddress’)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.BlockRewardEvent[source]
bcs_serialize() → bytes[source]
block_number: numpy.uint64
block_reward: starcoin.serde_types.uint128
gas_fees: starcoin.serde_types.uint128
miner: starcoin.starcoin_types.AccountAddress
class starcoin.starcoin_types.BurnEvent(amount: starcoin.serde_types.uint128, token_code: ‘TokenCode’)[source]

Bases: object

amount: starcoin.serde_types.uint128
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.BurnEvent[source]
bcs_serialize() → bytes[source]
token_code: starcoin.starcoin_types.TokenCode
class starcoin.starcoin_types.ChainId(value: numpy.uint8)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ChainId[source]
bcs_serialize() → bytes[source]
value: numpy.uint8
class starcoin.starcoin_types.ChangeSet(write_set: ‘WriteSet’, events: Sequence[ForwardRef(‘ContractEvent’)])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ChangeSet[source]
bcs_serialize() → bytes[source]
events: Sequence[starcoin.starcoin_types.ContractEvent]
write_set: starcoin.starcoin_types.WriteSet
class starcoin.starcoin_types.ContractEvent[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.ContractEvent__V0'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ContractEvent[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.ContractEventV0(key: ‘EventKey’, sequence_number: numpy.uint64, type_tag: ‘TypeTag’, event_data: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ContractEventV0[source]
bcs_serialize() → bytes[source]
event_data: bytes
key: starcoin.starcoin_types.EventKey
sequence_number: numpy.uint64
type_tag: starcoin.starcoin_types.TypeTag
class starcoin.starcoin_types.ContractEvent__V0(value: ‘ContractEventV0’)[source]

Bases: starcoin.starcoin_types.ContractEvent

INDEX = 0
value: starcoin.starcoin_types.ContractEventV0
class starcoin.starcoin_types.DataPath[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.DataPath__Code'>, <class 'starcoin.starcoin_types.DataPath__Resource'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.DataPath[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.DataPath__Code(value: ‘Identifier’)[source]

Bases: starcoin.starcoin_types.DataPath

INDEX = 0
value: starcoin.starcoin_types.Identifier
class starcoin.starcoin_types.DataPath__Resource(value: ‘StructTag’)[source]

Bases: starcoin.starcoin_types.DataPath

INDEX = 1
value: starcoin.starcoin_types.StructTag
class starcoin.starcoin_types.DepositEvent(amount: starcoin.serde_types.uint128, token_code: ‘TokenCode’, metadata: Sequence[numpy.uint8])[source]

Bases: object

amount: starcoin.serde_types.uint128
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.DepositEvent[source]
bcs_serialize() → bytes[source]
metadata: Sequence[numpy.uint8]
token_code: starcoin.starcoin_types.TokenCode
class starcoin.starcoin_types.Ed25519PublicKey(value: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Ed25519PublicKey[source]
bcs_serialize() → bytes[source]
value: bytes
class starcoin.starcoin_types.Ed25519Signature(value: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Ed25519Signature[source]
bcs_serialize() → bytes[source]
value: bytes
class starcoin.starcoin_types.EventFilter(from_block: Union[numpy.uint64, NoneType], to_block: Union[numpy.uint64, NoneType], event_keys: Sequence[ForwardRef(‘EventKey’)], limit: Union[numpy.uint64, NoneType])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.EventFilter[source]
bcs_serialize() → bytes[source]
event_keys: Sequence[starcoin.starcoin_types.EventKey]
from_block: Optional[numpy.uint64]
limit: Optional[numpy.uint64]
to_block: Optional[numpy.uint64]
class starcoin.starcoin_types.EventHandle(count: numpy.uint64, key: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.EventHandle[source]
bcs_serialize() → bytes[source]
count: numpy.uint64
key: bytes
class starcoin.starcoin_types.EventKey(salt: numpy.uint64, address: starcoin.starcoin_types.AccountAddress)[source]

Bases: object

address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.EventKey[source]
bcs_serialize() → bytes[source]
salt: numpy.uint64
class starcoin.starcoin_types.GeneralMetadata[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.GeneralMetadata__GeneralMetadataVersion0'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.GeneralMetadata[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.GeneralMetadataV0(to_subaddress: Union[bytes, NoneType], from_subaddress: Union[bytes, NoneType], referenced_event: Union[numpy.uint64, NoneType])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.GeneralMetadataV0[source]
bcs_serialize() → bytes[source]
from_subaddress: Optional[bytes]
referenced_event: Optional[numpy.uint64]
to_subaddress: Optional[bytes]
class starcoin.starcoin_types.GeneralMetadata__GeneralMetadataVersion0(value: ‘GeneralMetadataV0’)[source]

Bases: starcoin.starcoin_types.GeneralMetadata

INDEX = 0
value: starcoin.starcoin_types.GeneralMetadataV0
class starcoin.starcoin_types.HashValue(value: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.HashValue[source]
bcs_serialize() → bytes[source]
value: bytes
class starcoin.starcoin_types.Identifier(value: str)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Identifier[source]
bcs_serialize() → bytes[source]
value: str
class starcoin.starcoin_types.KeyRotationCapabilityResource(account_address: ‘AccountAddress’)[source]

Bases: object

account_address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.KeyRotationCapabilityResource[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.Kind[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.Kind__NewHeads'>, <class 'starcoin.starcoin_types.Kind__Events'>, <class 'starcoin.starcoin_types.Kind__NewPendingTransactions'>, <class 'starcoin.starcoin_types.Kind__NewMintBlock'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Kind[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.Kind__Events[source]

Bases: starcoin.starcoin_types.Kind

INDEX = 1
class starcoin.starcoin_types.Kind__NewHeads[source]

Bases: starcoin.starcoin_types.Kind

INDEX = 0
class starcoin.starcoin_types.Kind__NewMintBlock[source]

Bases: starcoin.starcoin_types.Kind

INDEX = 3
class starcoin.starcoin_types.Kind__NewPendingTransactions[source]

Bases: starcoin.starcoin_types.Kind

INDEX = 2
class starcoin.starcoin_types.Metadata[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.Metadata__Undefined'>, <class 'starcoin.starcoin_types.Metadata__GeneralMetadata'>, <class 'starcoin.starcoin_types.Metadata__TravelRuleMetadata'>, <class 'starcoin.starcoin_types.Metadata__UnstructuredBytesMetadata'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Metadata[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.Metadata__GeneralMetadata(value: ‘GeneralMetadata’)[source]

Bases: starcoin.starcoin_types.Metadata

INDEX = 1
value: starcoin.starcoin_types.GeneralMetadata
class starcoin.starcoin_types.Metadata__TravelRuleMetadata(value: ‘TravelRuleMetadata’)[source]

Bases: starcoin.starcoin_types.Metadata

INDEX = 2
value: starcoin.starcoin_types.TravelRuleMetadata
class starcoin.starcoin_types.Metadata__Undefined[source]

Bases: starcoin.starcoin_types.Metadata

INDEX = 0
class starcoin.starcoin_types.Metadata__UnstructuredBytesMetadata(value: ‘UnstructuredBytesMetadata’)[source]

Bases: starcoin.starcoin_types.Metadata

INDEX = 3
value: starcoin.starcoin_types.UnstructuredBytesMetadata
class starcoin.starcoin_types.MintEvent(amount: starcoin.serde_types.uint128, token_code: ‘TokenCode’)[source]

Bases: object

amount: starcoin.serde_types.uint128
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.MintEvent[source]
bcs_serialize() → bytes[source]
token_code: starcoin.starcoin_types.TokenCode
class starcoin.starcoin_types.Module(code: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Module[source]
bcs_serialize() → bytes[source]
code: bytes
class starcoin.starcoin_types.ModuleId(address: ‘AccountAddress’, name: ‘Identifier’)[source]

Bases: object

address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ModuleId[source]
bcs_serialize() → bytes[source]
name: starcoin.starcoin_types.Identifier
class starcoin.starcoin_types.MultiEd25519PublicKey(value: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.MultiEd25519PublicKey[source]
bcs_serialize() → bytes[source]
value: bytes
class starcoin.starcoin_types.MultiEd25519Signature(value: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.MultiEd25519Signature[source]
bcs_serialize() → bytes[source]
value: bytes
class starcoin.starcoin_types.NewBlockEvent(number: numpy.uint64, author: ‘AccountAddress’, timestamp: numpy.uint64, uncles: numpy.uint64)[source]

Bases: object

author: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.NewBlockEvent[source]
bcs_serialize() → bytes[source]
number: numpy.uint64
timestamp: numpy.uint64
uncles: numpy.uint64
class starcoin.starcoin_types.Package(package_address: ‘AccountAddress’, modules: Sequence[ForwardRef(‘Module’)], init_script: ‘Script’)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Package[source]
bcs_serialize() → bytes[source]
init_script: starcoin.starcoin_types.Script
modules: Sequence[starcoin.starcoin_types.Module]
package_address: starcoin.starcoin_types.AccountAddress
class starcoin.starcoin_types.ProposalCreatedEvent(proposal_id: numpy.uint64, proposer: ‘AccountAddress’)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ProposalCreatedEvent[source]
bcs_serialize() → bytes[source]
proposal_id: numpy.uint64
proposer: starcoin.starcoin_types.AccountAddress
class starcoin.starcoin_types.RawTransaction(sender: ‘AccountAddress’, sequence_number: numpy.uint64, payload: ‘TransactionPayload’, max_gas_amount: numpy.uint64, gas_unit_price: numpy.uint64, gas_token_code: str, expiration_timestamp_secs: numpy.uint64, chain_id: ‘ChainId’)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.RawTransaction[source]
bcs_serialize() → bytes[source]
chain_id: starcoin.starcoin_types.ChainId
expiration_timestamp_secs: numpy.uint64
gas_token_code: str
gas_unit_price: numpy.uint64
max_gas_amount: numpy.uint64
payload: starcoin.starcoin_types.TransactionPayload
sender: starcoin.starcoin_types.AccountAddress
sequence_number: numpy.uint64
class starcoin.starcoin_types.Script(code: bytes, ty_args: Sequence[ForwardRef(‘TypeTag’)], args: Sequence[ForwardRef(‘TransactionArgument’)])[source]

Bases: object

args: Sequence[starcoin.starcoin_types.TransactionArgument]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Script[source]
bcs_serialize() → bytes[source]
code: bytes
ty_args: Sequence[starcoin.starcoin_types.TypeTag]
class starcoin.starcoin_types.ScriptFunction(module: ‘ModuleId’, function: ‘Identifier’, ty_args: Sequence[ForwardRef(‘TypeTag’)], args: Sequence[ForwardRef(‘bytes’)])[source]

Bases: object

args: Sequence[bytes]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.ScriptFunction[source]
bcs_serialize() → bytes[source]
function: starcoin.starcoin_types.Identifier
module: starcoin.starcoin_types.ModuleId
ty_args: Sequence[starcoin.starcoin_types.TypeTag]
class starcoin.starcoin_types.SignedMessage(account: starcoin.starcoin_types.AccountAddress, signing_message: starcoin.starcoin_types.SigningMessage, authenticator: starcoin.starcoin_types.TransactionAuthenticator, chain_id: starcoin.starcoin_types.ChainId)[source]

Bases: object

account: starcoin.starcoin_types.AccountAddress
authenticator: starcoin.starcoin_types.TransactionAuthenticator
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.SignedMessage[source]
bcs_serialize() → bytes[source]
chain_id: starcoin.starcoin_types.ChainId
signing_message: starcoin.starcoin_types.SigningMessage
class starcoin.starcoin_types.SignedUserTransaction(raw_txn: ‘RawTransaction’, authenticator: ‘TransactionAuthenticator’)[source]

Bases: object

authenticator: starcoin.starcoin_types.TransactionAuthenticator
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.SignedUserTransaction[source]
bcs_serialize() → bytes[source]
raw_txn: starcoin.starcoin_types.RawTransaction
class starcoin.starcoin_types.SigningMessage(value: bytes)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.SigningMessage[source]
bcs_serialize() → bytes[source]
value: bytes
class starcoin.starcoin_types.StructTag(address: ‘AccountAddress’, module: ‘Identifier’, name: ‘Identifier’, type_params: Sequence[ForwardRef(‘TypeTag’)])[source]

Bases: object

address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.StructTag[source]
bcs_serialize() → bytes[source]
module: starcoin.starcoin_types.Identifier
name: starcoin.starcoin_types.Identifier
type_params: Sequence[starcoin.starcoin_types.TypeTag]
class starcoin.starcoin_types.TokenCode(address: ‘AccountAddress’, module: str, name: str)[source]

Bases: object

address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TokenCode[source]
bcs_serialize() → bytes[source]
module: str
name: str
class starcoin.starcoin_types.Transaction[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.Transaction__UserTransaction'>, <class 'starcoin.starcoin_types.Transaction__BlockMetadata'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.Transaction[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.TransactionArgument[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.TransactionArgument__U8'>, <class 'starcoin.starcoin_types.TransactionArgument__U64'>, <class 'starcoin.starcoin_types.TransactionArgument__U128'>, <class 'starcoin.starcoin_types.TransactionArgument__Address'>, <class 'starcoin.starcoin_types.TransactionArgument__U8Vector'>, <class 'starcoin.starcoin_types.TransactionArgument__Bool'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TransactionArgument[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.TransactionArgument__Address(value: ‘AccountAddress’)[source]

Bases: starcoin.starcoin_types.TransactionArgument

INDEX = 3
value: starcoin.starcoin_types.AccountAddress
class starcoin.starcoin_types.TransactionArgument__Bool(value: bool)[source]

Bases: starcoin.starcoin_types.TransactionArgument

INDEX = 5
value: bool
class starcoin.starcoin_types.TransactionArgument__U128(value: starcoin.serde_types.uint128)[source]

Bases: starcoin.starcoin_types.TransactionArgument

INDEX = 2
value: starcoin.serde_types.uint128
class starcoin.starcoin_types.TransactionArgument__U64(value: numpy.uint64)[source]

Bases: starcoin.starcoin_types.TransactionArgument

INDEX = 1
value: numpy.uint64
class starcoin.starcoin_types.TransactionArgument__U8(value: numpy.uint8)[source]

Bases: starcoin.starcoin_types.TransactionArgument

INDEX = 0
value: numpy.uint8
class starcoin.starcoin_types.TransactionArgument__U8Vector(value: bytes)[source]

Bases: starcoin.starcoin_types.TransactionArgument

INDEX = 4
value: bytes
class starcoin.starcoin_types.TransactionAuthenticator[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.TransactionAuthenticator__Ed25519'>, <class 'starcoin.starcoin_types.TransactionAuthenticator__MultiEd25519'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TransactionAuthenticator[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.TransactionAuthenticator__Ed25519(public_key: ‘Ed25519PublicKey’, signature: ‘Ed25519Signature’)[source]

Bases: starcoin.starcoin_types.TransactionAuthenticator

INDEX = 0
public_key: starcoin.starcoin_types.Ed25519PublicKey
signature: starcoin.starcoin_types.Ed25519Signature
class starcoin.starcoin_types.TransactionAuthenticator__MultiEd25519(public_key: ‘MultiEd25519PublicKey’, signature: ‘MultiEd25519Signature’)[source]

Bases: starcoin.starcoin_types.TransactionAuthenticator

INDEX = 1
public_key: starcoin.starcoin_types.MultiEd25519PublicKey
signature: starcoin.starcoin_types.MultiEd25519Signature
class starcoin.starcoin_types.TransactionPayload[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.TransactionPayload__Script'>, <class 'starcoin.starcoin_types.TransactionPayload__Package'>, <class 'starcoin.starcoin_types.TransactionPayload__ScriptFunction'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TransactionPayload[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.TransactionPayload__Package(value: ‘Package’)[source]

Bases: starcoin.starcoin_types.TransactionPayload

INDEX = 1
value: starcoin.starcoin_types.Package
class starcoin.starcoin_types.TransactionPayload__Script(value: ‘Script’)[source]

Bases: starcoin.starcoin_types.TransactionPayload

INDEX = 0
value: starcoin.starcoin_types.Script
class starcoin.starcoin_types.TransactionPayload__ScriptFunction(value: ‘ScriptFunction’)[source]

Bases: starcoin.starcoin_types.TransactionPayload

INDEX = 2
value: starcoin.starcoin_types.ScriptFunction
class starcoin.starcoin_types.Transaction__BlockMetadata(value: ‘BlockMetadata’)[source]

Bases: starcoin.starcoin_types.Transaction

INDEX = 1
value: starcoin.starcoin_types.BlockMetadata
class starcoin.starcoin_types.Transaction__UserTransaction(value: ‘SignedUserTransaction’)[source]

Bases: starcoin.starcoin_types.Transaction

INDEX = 0
value: starcoin.starcoin_types.SignedUserTransaction
class starcoin.starcoin_types.TravelRuleMetadata[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.TravelRuleMetadata__TravelRuleMetadataVersion0'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TravelRuleMetadata[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.TravelRuleMetadataV0(off_chain_reference_id: Union[str, NoneType])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TravelRuleMetadataV0[source]
bcs_serialize() → bytes[source]
off_chain_reference_id: Optional[str]
class starcoin.starcoin_types.TravelRuleMetadata__TravelRuleMetadataVersion0(value: ‘TravelRuleMetadataV0’)[source]

Bases: starcoin.starcoin_types.TravelRuleMetadata

INDEX = 0
value: starcoin.starcoin_types.TravelRuleMetadataV0
class starcoin.starcoin_types.TypeTag[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.TypeTag__Bool'>, <class 'starcoin.starcoin_types.TypeTag__U8'>, <class 'starcoin.starcoin_types.TypeTag__U64'>, <class 'starcoin.starcoin_types.TypeTag__U128'>, <class 'starcoin.starcoin_types.TypeTag__Address'>, <class 'starcoin.starcoin_types.TypeTag__Signer'>, <class 'starcoin.starcoin_types.TypeTag__Vector'>, <class 'starcoin.starcoin_types.TypeTag__Struct'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.TypeTag[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.TypeTag__Address[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 4
class starcoin.starcoin_types.TypeTag__Bool[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 0
class starcoin.starcoin_types.TypeTag__Signer[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 5
class starcoin.starcoin_types.TypeTag__Struct(value: ‘StructTag’)[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 7
value: starcoin.starcoin_types.StructTag
class starcoin.starcoin_types.TypeTag__U128[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 3
class starcoin.starcoin_types.TypeTag__U64[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 2
class starcoin.starcoin_types.TypeTag__U8[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 1
class starcoin.starcoin_types.TypeTag__Vector(value: ‘TypeTag’)[source]

Bases: starcoin.starcoin_types.TypeTag

INDEX = 6
value: starcoin.starcoin_types.TypeTag
class starcoin.starcoin_types.UnstructuredBytesMetadata(metadata: Union[bytes, NoneType])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.UnstructuredBytesMetadata[source]
bcs_serialize() → bytes[source]
metadata: Optional[bytes]
class starcoin.starcoin_types.VoteChangedEvent(proposal_id: numpy.uint64, proposer: ‘AccountAddress’, voter: ‘AccountAddress’, agree: bool, vote: starcoin.serde_types.uint128)[source]

Bases: object

agree: bool
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.VoteChangedEvent[source]
bcs_serialize() → bytes[source]
proposal_id: numpy.uint64
proposer: starcoin.starcoin_types.AccountAddress
vote: starcoin.serde_types.uint128
voter: starcoin.starcoin_types.AccountAddress
class starcoin.starcoin_types.WithdrawCapabilityResource(account_address: ‘AccountAddress’)[source]

Bases: object

account_address: starcoin.starcoin_types.AccountAddress
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.WithdrawCapabilityResource[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.WithdrawEvent(amount: starcoin.serde_types.uint128, token_code: ‘TokenCode’, metadata: Sequence[numpy.uint8])[source]

Bases: object

amount: starcoin.serde_types.uint128
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.WithdrawEvent[source]
bcs_serialize() → bytes[source]
metadata: Sequence[numpy.uint8]
token_code: starcoin.starcoin_types.TokenCode
class starcoin.starcoin_types.WriteOp[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.WriteOp__Deletion'>, <class 'starcoin.starcoin_types.WriteOp__Value'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.WriteOp[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.WriteOp__Deletion[source]

Bases: starcoin.starcoin_types.WriteOp

INDEX = 0
class starcoin.starcoin_types.WriteOp__Value(value: bytes)[source]

Bases: starcoin.starcoin_types.WriteOp

INDEX = 1
value: bytes
class starcoin.starcoin_types.WriteSet(value: ‘WriteSetMut’)[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.WriteSet[source]
bcs_serialize() → bytes[source]
value: starcoin.starcoin_types.WriteSetMut
class starcoin.starcoin_types.WriteSetMut(write_set: Sequence[Tuple[ForwardRef(‘AccessPath’), ForwardRef(‘WriteOp’)]])[source]

Bases: object

static bcs_deserialize(input: bytes) → starcoin.starcoin_types.WriteSetMut[source]
bcs_serialize() → bytes[source]
write_set: Sequence[Tuple[starcoin.starcoin_types.AccessPath, starcoin.starcoin_types.WriteOp]]
class starcoin.starcoin_types.WriteSetPayload[source]

Bases: object

VARIANTS = [<class 'starcoin.starcoin_types.WriteSetPayload__Direct'>, <class 'starcoin.starcoin_types.WriteSetPayload__Script'>]
static bcs_deserialize(input: bytes) → starcoin.starcoin_types.WriteSetPayload[source]
bcs_serialize() → bytes[source]
class starcoin.starcoin_types.WriteSetPayload__Direct(value: ‘ChangeSet’)[source]

Bases: starcoin.starcoin_types.WriteSetPayload

INDEX = 0
value: starcoin.starcoin_types.ChangeSet
class starcoin.starcoin_types.WriteSetPayload__Script(execute_as: ‘AccountAddress’, script: ‘Script’)[source]

Bases: starcoin.starcoin_types.WriteSetPayload

INDEX = 1
execute_as: starcoin.starcoin_types.AccountAddress
script: starcoin.starcoin_types.Script