https://github.com/mrinalxdev/vaultify

A content addressed storage application
https://github.com/mrinalxdev/vaultify

Last synced: about 6 hours ago
JSON representation

A content addressed storage application

• Host: GitHub
• URL: https://github.com/mrinalxdev/vaultify
• Owner: mrinalxdev
• Created: 2023-01-21T17:14:05.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-27T12:13:29.000Z (12 months ago)
• Last Synced: 2023-11-27T20:28:30.112Z (12 months ago)
• Language: Go
• Homepage:
• Size: 2.09 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vaultify

- ### p2p Folder documentation

> transport.go

Topics in this Files are documentated here. 

- Peer is and interface that represents the remote node

- Transport is anything that handles the communication btw the nodes in the network . This can be of form (TCP, UDP or websockets ... )

>tcp_tansport.go

- TCPPeer represents the remote node over a TCP established connection

*TCPPeer struct*

- conn is the underlying connection of the peer

- If we dial and retrive a conn => outbound == true

- Close Implements the Peer interface

- Consume func implements the Transport interface which will return readonly channel for reading the  incoming messages received from the another peer in the network

> handshake.go

HandshakeFunc is ...

Basically what handshake func is doing . Before establishing a connection there will be a handshake btw the peers . If the handshake is good then they will establish the connection. 

> message.go 

Message represents any arbitary data that is being sent over the each transport btw two nodes in the network

> store.go 

Content Addressable storage which can save anything in deep nested folder based on the transformation of the key .