web3dart library

Classes

AbiType<T>
A type that can be encoded and decoded as specified in the solidity ABI, available at https://solidity.readthedocs.io/en/develop/abi-spec.html
AddressType
Solidity address type
BaseArrayType<T>
Base class for (non-byte) arrays in solidity.
BlockInformation
BlockNum
For operations that are reading data from the blockchain without making a transaction that would modify it, the Core client can read that data from previous states of the blockchain as well. This class specifies which state to use.
BoolType
Solidity bool type
Cip150MetadataContract
Client for the CIP-150 on-chain key-value metadata interface.
Cip150MetadataEntry
A CIP-150 metadata entry.
Cip151Lifecycle
Typed lifecycle metadata defined by CIP-151.
Cip152LabCertificate
A validated CIP-152 laboratory certificate.
Cip152LabMeasurement
One measured property from a CIP-152 lab.json document.
CompositeFunctionParameter
A function parameter that includes other named parameter instead of just wrapping single types.
ContractAbi
Defines the abi of a deployed Core contract. The abi contains information about the functions defined in that contract.
ContractEvent
An event that can be emitted by a smart contract during a transaction.
ContractFunction
A function defined in the ABI of an compiled contract.
Credentials
The sign method from ed448, so that it can be used inside Credentials. Anything that can sign payloads with a private key.
CustomUnitBalance
Exact canonical and custom-unit balances returned by a token contract.
CustomUnitDiscovery
Unit capabilities reported by a Core token contract.
CustomUnitToken
Read-only interface for Core tokens implementing calculated custom units.
DecodingResult<T>
DeployedContract
Helper class that defines a contract with a known ABI that has been deployed on a Core blockchain.
DynamicBytes
The solidity bytes type, which decodes byte arrays of arbitrary length.
DynamicLengthArray<T>
The solidity T[] type for arrays with an dynamic length.
EIP712
EncodingLengthInfo
Information about whether the length of an encoding depends on the data (dynamic) or is fixed (static). If it's static, also contains information about the length of the encoding.
EventComponent<T>
A FunctionParameter that is a component of an event. Contains additional information about whether the parameter is indexed.
FilterEvent
A log event emitted in a transaction.
FilterOptions
Options for event filters created with Web3Client.events.
FixedBytes
The bytes
FixedLengthArray<T>
The solidity T[k] type for arrays whose length is known.
FunctionParameter<T>
The parameter of a function with its name and the expected type.
FunctionType
GeneratedContract
Base classes for generated contracts.
IntType
The solidity int
IpfsGateway
Resolves IPFS references through a configurable gateway.
StringType
The solidity string type, which utf-8 encodes strings
SyncInformation
When the client is currently syncing its blockchain with the network, this representation can be used to find information about at which block the node was before the sync, at which node it currently is and at which block the node will complete its sync.
Transaction
TransactionInformation
TransactionReceipt
TupleType
UintType
The solidity uint
Wallet
Represents a wallet file. Wallets are used to securely store credentials like a private key belonging to an Core address. The private key in a wallet is encrypted with a secret password that needs to be known in order to obtain the private key.
Web3Client
Class for sending requests over an HTTP JSON-RPC API endpoint to Core clients. This library won't use the accounts feature of clients to use them to create transactions, you will instead have to obtain private keys of accounts yourself.
XCBAddress
Represents an Core Block Chain address.
XCBAmount
Utility class to easily convert amounts of Core into different units of quantities.
XCBPrivateKey
Credentials that can sign payloads with an Core Block Chain private key.

Enums

ContractFunctionType
StateMutability
The state mutability of a contract function defines how that function interacts with the blockchain.
XCBUnit

Constants

cip151TokenExpirationKey → const String
CIP-151 metadata key for token expiry.
cip151TradingStopKey → const String
CIP-151 metadata key for the recommended trading stop.
cip152LabKey → const String
CIP-152 metadata key containing the lab certificate reference.
defaultIpfsGatewayTemplate → const String
Default public IPFS gateway used by Core applications.
sizeUnitBytes → const int
The length of the encoding of a solidity type is always a multiplicative of this unit size.

Functions

calculatePadLength(int bodyLength, {bool allowEmpty = false}) → int
Calculates the amount of padding bytes needed so that the length of the padding plus the bodyLength is a multiplicative of sizeUnitBytes. If allowEmpty (defaults to false) is true, an empty length is allowed. Otherwise an empty bodyLength will be given a full sizeUnitBytes padding.
parseAbiType(String name) → AbiType
Parses an ABI type from its AbiType.name.

Typedefs

SocketConnector = StreamChannel<String> Function()
Signature for a function that opens a socket on which json-rpc operations can be performed.