vhad/flashwifi
1
0
Fork 0
mirror of https://github.com/DanielPollithy/flashwifi.git synced 2025-10-16 11:45:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Toby 2018-01-25 00:23:55 -05:00 committed by GitHub
parent 741a638309
commit 9695aa2581
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -2,37 +2,40 @@
Share remaining data from your android phone as a hotspot and get paid in iota.
[WiFiota promotion website](https://tobywoerthle.github.io/flashWiFiSite/)
[WiFiota Promotional Website](https://tobywoerthle.github.io/flashWiFiSite/)
# How does it work?
## Iota setup
The app creates a seed for every user and stores it with a password in SharedEncryptedPreferences.
There is a withdraw and deposit view which can be used to interact with the seed.
The app creates a seed for a user and stores it with a password in SharedEncryptedPreferences.
There are withdraw and deposit views, which can be used to interact with the seed (send and receive funds).
The balance of the wallet can be viewed and is cached.
So far everything runs on a testnode but a live node can be set.
A private testnode is used by default but a mainnet (live) node can be set.
When using the testnet, 2000i can be generated and automatically sent to the wallet for testing purposes. See Settings > Add 2000i testnet.
## Discovery
Happens with WiFi P2P. The consumer selects a peer manually so far (-> in the future automatic service discovery)
This uses WiFi P2P. The consumer selects a peer manually (-> in the future there will be automatic service discovery).
Two devices then open a wifi direct group and start the **Negotiation Protocol**
## Negotiation Protocol
The devices talk about each others, how much data they want to share or consume and
whether they could agree on a price and time.
The devices communicate with each other: how much data they want to share or consume and
whether they can agree upon a price and duration.
* If so the future hotspot generates a random SSID like "Iotidy-<random number>".
* And generates a random number which is used as the password
* The hotspot sends it to the consumer and now they start the Billing Protocol
* If they come to an agreement, the future hotspot generates a random SSID like "Iotidy-<random number>".
* The future hostpot device also generates a random number which is used as the WiFi password
* The hotspot sends the password to the consumer and now they start the Billing Protocol
ToDo: Add full protocol
## Billing Protocol
The hotspot is created and the device proving the hotspot starts a new ServerSocket.
Once the consumer is connected to the hotspot he tries to connect to the gateway and
The hotspot is created and the device providing the hotspot starts a new ServerSocket.
Once the consumer is connected to the hotspot, they try to connect to the gateway and
start the Billing Protocol.
* "Hello I am Client and I am in state NOT_PAIRED"
@ -43,25 +46,23 @@ start the Billing Protocol.
### Payment
Every minute a bill is exchanged which contains information about used megabytes and durances.
A **IOTA FLASH CHANNEL** is established between the two (-> in the future more than two parties).
Every minute a bill is exchanged which contains information about used megabytes and duration(s).
A **IOTA FLASH CHANNEL** is established between the two (-> in the future more than two parties will be supported).
Every minute can be associated with a token transfer in the channel.
* Signing a transfer signifies agreement to the the bill
* The funding of the channel results in shared risk on both parties so they have no incentive to leave earlier
* The funding of the channel results in shared risk between both parties so they have no incentive to leave early
* Time guards track whether timing constraints weren't fulfilled (channel not funded, no peers...)
### End
Every bill can contain a "closeAfterwards" flag. Which ends the whole process with a short
exchange of data for the consumer.
Every bill can contain a "closeAfterwards" flag, which ends the whole process with a short exchange of data for the consumer.
The hotspot still has to attach the flash channel to the tangle.
# Good to know
The WiFi P2P roles in a WiFi group are not fixed. So each time either the future hotspot or consumer act as server and client.
The WiFi P2P roles in a WiFi group are not fixed. Therefore, each time, either the future hotspot or consumer can act as server or client.
We wrapped the iota.flash.js with additional javascript bridges and connect them to the **Jota - iota java lib**. The javascript code for the flash channel is executed within J2V8.
We wrapped the iota.flash.js with additional javascript bridges and connected them to the **Jota - iota java lib**. The javascript code for the flash channel is executed within J2V8.
# Next big steps
@ -74,4 +75,3 @@ We wrapped the iota.flash.js with additional javascript bridges and connect them
Total: 17d