Skip to content

Commit

Permalink
Eddy the co patch 1 (#4)
Browse files Browse the repository at this point in the history
* Update README.md
  • Loading branch information
EddyTheCo authored Feb 14, 2024
1 parent 4b08f62 commit e5b4704
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 224 deletions.
202 changes: 0 additions & 202 deletions Client/CMakeLists.txt.user

This file was deleted.

10 changes: 5 additions & 5 deletions Client/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# DLockers Client

This application can be seen as a decentralized client that allows you to book a locker by paying with crypto.
In order to use the application one needs to set the address of the node to connect.
To use the application one needs to set the address of the node to connect.
The Proof of Work has to be performed by the node.
This application is meant to be used on the testnet.
If using the mainnet **you are the ONLY responsible for the eventual loss of your funds**.
Expand All @@ -12,12 +12,12 @@ One can download the client application from the releases of this repo or use th

The client shows the different [Dlockers Server](https://github.com/EddyTheCo/DLockers/tree/main/Server) available in a map.
One can select the server and book a slot of time on the server.
In order to book, the client must have funds, one can ask for funds [here](https://faucet.testnet.shimmer.network/)
To book, the client must have funds, one can ask for funds [here](https://faucet.testnet.shimmer.network/)
by entering the Client account.

If the book and payment is accepted by the server, the server will send the client a NFT signed by the server.
If the book and payment are accepted by the server, the server will send the client an NFT signed by the server.
By presenting this NFT to the server you can open the locker.
To do this, this application send the NFT to a server address but with expiration time in the past, so you continue owning the NFT
and can reuse it as any times you want.
To do this, this application sends the NFT to a server address but with expiration time in the past, so you continue owning the NFT
and can reuse it as many times as you want.


9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# DLockers

This repo produce a [server](https://github.com/EddyTheCo/DLockers/tree/main/Server/) and a [client](https://github.com/EddyTheCo/DLockers/tree/main/Client/) applications that communicate peer-to-peer using the IOTA network.
We are not interested in the speculative side of crypto and we are not associated with the Iota Foundation.
This repo produces a [server](https://github.com/EddyTheCo/DLockers/tree/main/Server/) and a [client](https://github.com/EddyTheCo/DLockers/tree/main/Client/) applications that communicate peer-to-peer using the IOTA network.
We are not interested in crypto's speculative side and are not associated with the Iota Foundation.
We discourage investing in Shimmer and IOTA because that will be investing in the Iota Foundation and its pursuit of centralizing the development and protocol.




Use the [web client](https://eddytheco.github.io/DLockers/Client/) or set a [MockUpServer](https://eddytheco.github.io/DLockers/MockupServer/).

## The bigger picture

* Any person can start renting physical space for lockers.
* You do not depend on centralized company servers to store your business data or to process payments.
* As long as you maintain a node(blockchain), your gainings and business data are cryptographically secured.
* The code is open source and grants you certain rights and responsibilities to respect other people's rights.
* The open source code grants you certain rights and responsibilities to respect other people's rights.
* By using NFTs the client can pass the right to open a box to other clients.
20 changes: 10 additions & 10 deletions Server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,26 @@ If using the mainnet **you are the ONLY responsible for the eventual loss of you

## How to use it

In order to book a box one can use the [client](https://eddytheco.github.io/DLockers/Client).
To book a box one can use the [client](https://eddytheco.github.io/DLockers/Client).
The communication between server and client relies on creating outputs on the ledger.
Because of that, the server needs an initial amount of funds to be able to publish its state on the ledger.
These initial funds are always own by the server.
These initial funds are always owned by the server.


The server looks for new bookings sent by the clients and checks the validity of these bookings.
A booking is valid if it has an allowed start and finish time and the price payed for the booking is correct.
If everything is fine the server collect the money from the client, update its internal state and send a NFT to the client.
A booking is valid if it has an allowed start and finish time and the price paid for the booking is correct.
If everything is fine the server collects the money from the client, updates its internal state, and sends an NFT to the client.


The server allows you to open the locker if you own a NFT signed by the server.
The signed NFT has immutable metadata that reference certain time interval of the bookings the client has paid.
The server allows you to open the locker if you own an NFT signed by the server.
The signed NFT has immutable metadata that references certain time intervals of the bookings the client has paid.

## Platformsi
## Platforms

The server is configured to run on a raspberry-pi, with a 4g and GPS module by using the [evt yocto Layer](https://github.com/EddyTheCo/meta-evt)
The server will set the pin 17(this can be configured) up when a valid NFT is received.
The later will open the electrical locker.
One using the GPS, the geographical position of the server will be public.
The latter will open the electrical locker.
If using the GPS, the geographical position of the server will be public.

One can also setup a [mock-up Server](https://eddytheco.github.io/DLockers/MockupServer) for testing just using the browser.
One can also set up a [mock-up Server](https://eddytheco.github.io/DLockers/MockupServer) for testing just by using the browser.
The releases from this repo are also a mock-up Server.
4 changes: 2 additions & 2 deletions wasm/MockupServer/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# [Mockup Server](https://eddytheco.github.io/Dlockers/MockupServer/index.html)

This is a mock-up server for testing the Dlockers protocol.
It will allow you to set a Dlocker server.
It will allow you to set up a Dlocker server.
For the server to start working one has to send some coins to the server account.
The server can use your position as the server position, by default it will take a random position.
Take into account your position will be disclosed publicly if you allow it.
Take into account that your position will be disclosed publicly if you allow it.

You can also set up a real [Dlocker server](https://github.com/EddyTheCo/DLockers/tree/main/Server)
You can book on the server by using the [Dlocker Client](https://github.com/EddyTheCo/DLockers/tree/main/Client)
4 changes: 4 additions & 0 deletions wasm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# DLockers

Use the [web client](https://eddytheco.github.io/DLockers/Client/) or set a [MockUpServer](https://eddytheco.github.io/DLockers/MockupServer/).

0 comments on commit e5b4704

Please sign in to comment.