https://github.com/ryanramage/agreeable

Type friendly agreements between peers for rpc and forms
https://github.com/ryanramage/agreeable

Last synced: about 1 month ago
JSON representation

Type friendly agreements between peers for rpc and forms

• Host: GitHub
• URL: https://github.com/ryanramage/agreeable
• Owner: ryanramage
• Created: 2024-03-31T23:03:16.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-04-09T03:22:18.000Z (7 months ago)
• Last Synced: 2024-09-14T10:00:43.341Z (2 months ago)
• Language: JavaScript
• Size: 35.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-pears - agreeable - Type friendly agreements between peers for rpc and forms (**Awesome Pears 🍐** / Building Blocks)
• awesome-pears - agreeable - Type friendly agreements between peers for rpc and forms (**Awesome Pears 🍐** / Building Blocks)

README

        
Agreeable

==========

Type friendly agreements between peers for rpc and forms. A Holepunch 🕳🥊 project.

Reason

------

Agreeable helps people who are used to building web services migrate to building p2p services. Building and managing typed, versioned apis will help foster an ecosystem of great service providers of cool features that peers can use. The agreement allows for good type checking between peers, and easy input validation. Agreeable allows for coding at lower level interfaces. You can use zod or jsonschema, you can even drop down and use jsonrpc-mux directly. But we hope that at least one side of the client/server releationship uses and publishes agreements so all can benefit. Also check the roadmap for a high level view of more things that can be possible.

There is still a need in p2p environments to have services. We want to make it easy to create, use, test, and share

these services. Agreeable makes spinning up a friendly p2p service easy. 

The simplest getting started can be found at [agreeable-peer](https://github.com/ryanramage/agreeable-peer). Please follow those instructions.

For a nice UI to browse and test agreeable-peer services, us [agreeable-ui](https://github.com/ryanramage/agreeable-ui)

ROADMAP

===========

Here are some things or ideas that could happen in this space

 - Simple Form collection. One function form submission, which gets stored in a hypercore

 - Form reader - remotely read the form submissions

 - Load agreements from a hyperdrive remotely

 - Registry of agreements - to have service lookups 

 - Load balancer of implementation, for really compute heavy services 

 - signed executors 

 - 2 peer executor verification