This ES Module library provides the core functionality for implementing and interacting with the **Smash Protocol**—a modular, **1:N social messaging** and **curated content-sharing** protocol. It powers the free and open digital neighborhoods of tomorrow
npm install @smashchats/libraryThis ES Module library provides the core functionality for implementing and interacting with the Smash Protocol—a modular, 1:N social messaging and curated content-sharing protocol.
It powers the free and open digital neighborhoods of tomorrow, promoting decentralization, interoperability, and user ownership.
> WARNING.
> This is a work in progress.
> We are currently working on the alpha version of the Smash Protocol
> under a (non-exhaustive) list of assumptions.
> BREAKING CHANGES WITHOUT NOTICE ARE TO BE EXPECTED.
> And, in general, documentation is deemed not yet available.
!Coverage
!Security Rating
!Maintainability Rating
!Lines of Code
By using this repository, you agree to the terms of the Smash License.
---
1. Introduction
2. Features
3. Getting Started
4. Usage
5. Development Guide
6. References
7. Contributing
8. License
---
The Smash Protocol enables secure, decentralized communication and content sharing without intermediaries. Smash-Node-Lib is an open-source library for building JavaScript-based clients, plugins, or microservices that interact with the protocol.
Key Principles:
- Open Standards: Fully modular and built on open APIs for interoperability.
- Decentralization: Peer-to-peer communication with no central authority.
- User Ownership: Your data, your rules.
For more details, see the full documentation.
> Smash-Node-Lib is currently in the alpha stage of development.
> The Smash Protocol is not yet fully functional.
- 1:N Messaging: Support for both one-on-one and group communications.
- Neighborhood-Based Organization: Join or create digital communities with unique rules and curation.
- Modular Design: Built as microservices for flexibility and extensibility.
- Secure Communication: Signal Protocol implementation ensures privacy.
- Open APIs: Integrate seamlessly with other applications or build your own clients.
- AT Protocol: Integrate with the AT Protocol for decentralized identity and social networking.
Follow these steps to start using the Smash-Node-Lib:
1. Clone the Repository:
Using Radicle:
> Read more in our CONTRIBUTING.md.
``bash`
rad clone rad:zZ6oTFp8JrVyhEQmrcfkQkQgmoQJ # RID for the Smash-Node-Lib repo
> You can find an updated list of all Smash's repository IDs (RIDs) on our developer notes.
Using our GitHub mirror repository:
`bash`
git clone https://github.com/smashchats/smash-node-lib.git
2. Install Dependencies:
`bash`
npm install
3. Set Up Your Development Environment:
- Create a Radicle Identity.
- Connect to the Smash seeding node:
`bash`
rad node connect z6MkiXzPZSV6yx6wHSdSPNpVVytxauiLzhU1jG8sVmxdZkcn@rad-node.smashchats.com:8778
> You can find a list of all Smash's seeding nodes on our developer notes.
4. Run All Test Suites:
Looking at tests is a great way to understand how to use the library.
Tests have been written using Vitest and designed to provide a comprehensive set of examples on interacting with the Smash-Node-Lib library.
`bash`
npm test
You'll also find a 'Tutorial' test suite that is designed to cover the general use of this library.
`
npm run tutorial
> WARNING: The Smash-Node-Lib has not yet been published to a stable repository.
> As a consequence, the following examples are not yet fully functional.
ATTENTION: Have a look at our 'Smash Simple Neighborhood' repository for a working example of how to use the Smash-Node-Lib library in its current state.
Handle errors gracefully in your application:
`typescript`
const logger: Logger = ...;
process.on('unhandledRejection', (reason, promise) => {
SmashMessaging.handleError(reason, promise, logger);
});
1. The Smash messaging protocol might deliver messages out of order.
2. The Smash messaging protocol might deliver duplicate messages.
#### Deduplication
All messages bear a message.sha256 hash.
This property is used to detect duplicates.
Already processed messages can safely be discarded if a duplicate is detected.
#### Re-ordering
> Hint: you can use the exported
> sortSmashMessages(messages: EncapsulatedIMProtoMessage[]): EncapsulatedIMProtoMessage[])
> function to sort a set of potentially unordered messages.
Two properties of the message protocol ensure that messages can get re-ordered:
1. message.timestamp: sender's claimed timestamp of when the message was first queued.message.after
2. : the sha256 hash of the message that this message depends on.
> If present, the message.after property is deemed trustable.sha256
> Indeed, as it requires the sender to know the hash of the previous message,sha256
> this property can't be set to fake messages sent after a message that wasn't previously received by the sender.
> The sender could however always set this property to the hash of a previously received message.
> This is impossible to enforce, but should not be harmful as long as clearly indicated.
Developers should always set message.after to the sha256 hash of the previous message.0
This ensures that messages can get re-ordered correctly.
When this value is unknown or ignored, the convention is to set it to the value or to an empty string.
When the message.after property is unavailable, re-ordering is limited to the message.timestamp property.
#### Out of order messages
Messages received with inconsistent timestamp and message.after ordering should be flagged as suspicious.timestamp` that is too far in the past, or, in the future (out of sync clocks).
Same for messages with a
- Signal Protocol: Secure communication library used in Smash-Node-Lib (Peculiar Ventures implementation of the Signal Protocol).
- Socket.io Client API: WebSocket communication.
- Radicle Documentation: Decentralized code collaboration.
We welcome contributions from the community! Check out our Contributing Guide to get started. Ensure adherence to our Code of Conduct.
Contributions are managed through Radicle, a decentralized Git collaboration network. Learn more in our CONTRIBUTING.md.
Browse open issues on Radicle!.
All contributions to Smash-Simple-Neighborhood are made under our extended AGPL-3.0 License.
By contributing, you agree to license your work under these terms.
By using this repository, you agree to the terms of the Smash License.
Any changes or derived projects MUST be open-sourced under a compatible license.
- Developer Chat: Smash Developers Telegram Group (request access to maintainers)
- Security Issues: security@smashchats.com
- Email: contribute@smashchats.com