Package detailsv1.1.3

canonical_json

Encoder and decoder for a canonical JSON format, useful when cryptographically hashing or signing JSON objects.

AndroidiOSWebmacOSWindowsLinux

pub.dev API documentation Source code

30-day downloads: 38.8K
Likes: 11
Pub points: 160

Install package

flutter pub add canonical_json

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Flutter/Dart package that provides a canonical JSON encoder and decoder, ensuring consistent serialization of JSON objects. This is particularly useful for cryptographic operations like hashing or signing, where identical input must always produce the same output regardless of formatting variations. The package enforces strict ordering of keys and precise formatting to achieve determinism. It supports all major platforms including Android, iOS, Web, macOS, Windows, and Linux, making it ideal for cross-platform applications requiring secure and predictable JSON handling.

Use cases

Cryptographic hashing of JSON data
Secure signing of JSON payloads
Deterministic JSON serialization
Cross-platform data consistency
API request/response integrity verification
JSON-based digital signatures

Key features

Strict key ordering
No whitespace or formatting variation
Deterministic output
Supports all major platforms
Lightweight and efficient
Complies with canonical JSON standards

Suitable for

Applications requiring secure JSON processing
Systems needing reproducible hash values
Blockchain or cryptographic protocols
Interoperable APIs with strict serialization rules
Developers building secure data exchange systems

Considerations

Not suitable for human-readable JSON output
May impact performance with very large JSON structures
Requires careful handling in debugging due to strict formatting
Limited to use cases where determinism is critical
Does not support custom serialization logic

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Dart Neats

A collection of a small neat packages for dart.

Disclaimer: This is not an officially supported Google product.

This repository is meant as a playground where small neat packages are cultivated. If package grows too large and complex and needs a dedicated issue tracker it should be moved to a dedicated repository.

Each folder in this repository contains a neat pub package. This project aims to use a separate package whenever it makes sense to have an independent major version. This often means splitting functionality into separate packages, which can be reused independently.

Package	Description	Version	Test
acyclic_steps	An explicit acyclic step dependency framework with concurrent evaluation and dependency injection.
canonical_json	Encoder and decoder for a canonical JSON format, useful when cryptographically hashing or signing JSON objects.
chunked_stream	Utilities for working with chunked streams, such as byte streams which is often given as a stream of byte chunks with type `Stream<List<int>>`.
dartdoc_test	Utilities for testing code snippets embedded in documentation comments.
http_methods	List of all HTTP methods registered with IANA as list of strings, and metadata such as whether a method idempotent.
neat_cache	A neat cache abstraction for wrapping in-memory or redis caches.
neat_periodic_task	Auxiliary classes for reliably running a periodic task in a long-running process such as web-server.
pem	PEM encoding/decoding of textual keys following RFC 7468, supporting both lax/strict-mode, and certificates chains of concatenated PEM blocks.
retry	Utility for wrapping an asynchronous function in automatic retry logic with exponential back-off, useful when making requests over network.
safe_url_check	Check if an untrusted URL is broken, without allowing connections to a private IP address.
sanitize_html	Function for sanitizing HTML to prevent XSS by restrict elements and attributes to a safe subset of allowed values.
slugid	A URL-safe base64 encoding for UUIDv4 stripped of padding. Useful when embedding short random UUIDs in URLs.
typed_sql	Package for doing SQL with some type safety.
vendor	Utility for vendoring packages into a project and rewriting import/export statements.

Repository Management

Packages in this repository uses pub workspaces a single dart pub get will resolve dependencies for all of them. Configuration of Github Actions, issue templates, issue labels, etc is automated with scripts in tool/.

Contributing

We love patches and contributions, please refer to CONTRIBUTING.md for technicalities on CLA and community guidelines. As this project aims to build neat packages using other neat packages we might also accept proposals for new neat packages, though it's often easier to publish independently.