xrp library
Subpath library: package:era_connect/xrp.dart — the xrp chain module
plus the shared request/scan plumbing, without the rest of the SDK.
Classes
- AnimatedUr
- Frame source for rendering a UR as an animated QR.
- AnimatedUrOptions
- Options for AnimatedUr.
- ChainContext
- Resolved SDK configuration handed to every chain module.
- EraConnectConfig
- SDK configuration. Everything is optional; the SDK performs NO network I/O ever.
- ExpectedReply
- Optional expectations when parsing a reply standalone (outside SignRequest.scanner).
- ScanComplete
- The scan is complete; ur is the assembled UR.
- ScanDuplicate
- A frame already seen this session (camera framerate re-reads).
- ScanFeedResult
- One outcome of feeding a frame to UrScanner.receivePart.
- ScanProgress
- The frame was consumed; the scan is not complete yet.
- ScanRejected
- The frame was turned away; see rejection.
- ScanRejection
- Why a scanned frame was turned away.
-
SignRequest<
TResult> - A built sign request: the UR to display plus everything needed to consume the reply. The request id is minted at CONSTRUCTION so the same object that renders the QR also validates the echo — a reply carrying a different id (from an earlier, cancelled flow re-presented to the camera) is refused instead of accepted.
-
TypedUrScanner<
TResult> - A scanner whose completed UR parses into a typed result (a chain signature).
- Ur
- An immutable Uniform Resource: a registry type string plus its CBOR payload.
- UrScanner
- Accumulates camera frames into a UR. Synchronous and non-throwing on the feed path (safe to call from camera callbacks); malformed frames come back as typed rejections, never exceptions.
- UrScannerOptions
- Options for UrScanner.
- XrpChain
- XRP signing over the ERA UR protocol.
- XrpSignatureResult
-
A parsed
ur:bytesreply. - XrpSignRequestProps
-
XRP rides the XRP Toolkit convention: an untyped
ur:byteswhose CBOR payload is the transaction JSON (request) or the canonical signed XRPL binary (reply). There is NO request id and NO chain-specific UR type — the content itself is the only binding, which is whyverifyXrpSignature(from the verify library) is not optional on this chain.
Constants
- defaultFragmentLength → const int
- Default payload bytes per animated-QR fragment.
Functions
-
resolveContext(
[EraConnectConfig? config]) → ChainContext - Resolve a (possibly absent) config into the context chain modules consume.
Exceptions / Errors
- EraSdkError
- Every error thrown by this SDK.