Skip to main content

Crate quai_sdk

Crate quai_sdk 

Source
Expand description

Modular Quai/Qi alpha SDK with native and browser wallet workflows and recovery.

Re-exports§

pub use quai_abi as abi;
pub use quai_browser as browser;
pub use quai_consensus as consensus;
pub use quai_crypto as crypto;
pub use quai_keystore as keystore;
pub use quai_payments as payments;
pub use quai_primitives as primitives;
pub use quai_provider as provider;
pub use quai_rpc as rpc;
pub use quai_signer as signer;
pub use quai_wallet as wallet;

Modules§

account_preflight
Portable, exact-nonce account preparation without storage or signing side effects.
account_replacement
Portable fee-only account replacement quotation. Portable fee-only account replacement quotation without custody side effects.
accounts
Native account transaction preparation with durable nonce and signed-byte custody.
candidate_observation
Portable canonical observations for signed candidate families. Portable bounded observations of persisted signed transaction candidates.
contracts
ABI-bound account contract calls with explicit simulation and authorization boundaries.
deployments
Durable deployment/code observation for exact stored account candidates.
discovery
Portable numbered account observations and bounded current Qi outpoint discovery.
payment_channels
Payment-code destination allocation and current-state receive discovery.
payment_mailbox
Pelagus-compatible payment-channel mailbox announcements. Pelagus-compatible payment-channel mailbox.
qi
Native ordinary Qi payments with exact fee estimation and durable signed custody.
qi_discovery
Current-state Qi gap scanning and wallet refresh, matching normal quais.js use. These latest-only node observations are not historical or atomic snapshots.
qi_preflight
Portable exact-denomination Qi preparation. Portable exact-denomination Qi planning over explicit current observations.
qi_replacement
Portable same-input Qi replacement quotation. Portable same-input Qi replacement funded only by explicitly selected owned change.
recovery
Bounded durable reconciliation of signed operations against a configured node.
rpc_signer
Portable verified remote account signing and submission acknowledgements. Explicit remote account signing with verified responses and no automatic retries.
settlement
Restartable bounded settlement observation for exact persisted signed candidates.
settlement_observation
Portable destination observations from exact signed payloads. Portable interpretation and destination observations for exact signed payloads.
wrappers
Explicit WQI and WQUAI contract intents. No implicit signing or submission.

Structs§

Address
An arbitrary 20-byte address with validated string parsing.
DynTransport
Any native transport behind one concrete, cheaply cloned type.
Endpoint
A validated endpoint. Debug deliberately omits paths and query credentials.
HttpConfig
Limits applied to every HTTP request.
HttpProxy
An explicit forward proxy for HttpTransport: HTTP(S) or SOCKS5.
HttpTransport
Native pooled HTTP transport with no redirects or automatic retries.
Provider
A provider with a fixed routing table and an explicitly expected chain ID.
QiAddress
An address with a published zone and the Qi ledger bit.
QuaiAddress
An address with a published zone and the Quai ledger bit.
Routing
A validated static shard-to-endpoint table. No silent shard fallback occurs.
WsConfig
Resource and deadline limits for a single explicit native WebSocket connection.
WsTransport
One explicit endpoint and one multiplexed session. Clones share its resource limits.

Enums§

BlockTag
A block selector supported by the initial account read methods.
ErrorClass
What a caller, such as a background sync loop, can do about an error.
Ledger
The ledger selected by the high bit of an address’s second byte.
ProviderError
Provider failures without raw endpoint URLs or remote response bodies.
Region
One of the three regions defined by the published protocol constants.
Shard
A validated chain at any level of the network hierarchy.
Zone
One of the nine published zones. Availability is a network-level property.

Constants§

VERSION
Rust package version; independent of the pinned quais.js reference version.

Functions§

parse_quantity
Parse an unsigned quantity, rejecting empty, padded and overflowing values.
parse_use_pathing
Parse text configuration without JavaScript’s nonempty-string truthiness.
recover_typed_data_signer
Recover the address signing an exact validated typed-data document. This does not approve its domain or authorize the recovered account; compare the result and apply the application’s expected chain/domain policy independently.

Type Aliases§

U256
Uint for 256 bits.