https://github.com/pappas999/smartkey-poc
SmartKey Chainlink Proof Of Concept
https://github.com/pappas999/smartkey-poc
Last synced: 3 months ago
JSON representation
SmartKey Chainlink Proof Of Concept
- Host: GitHub
- URL: https://github.com/pappas999/smartkey-poc
- Owner: pappas999
- License: mit
- Created: 2021-01-29T06:11:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-07T02:41:31.000Z (about 4 years ago)
- Last Synced: 2025-01-16T21:40:48.610Z (5 months ago)
- Language: Solidity
- Size: 19.7 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SmartKey/Chainlink Proof Of Concept
This is a Proof of Concept to demonstrate how [SmartKey](http://smartkeyplatform.com/) and [Chainlink](http://chain.link) can be used in conjunction with a smart contract. In this example, a smart contract uses Chainlink oracles to obtain external weather data, and based on the result of wind speed at a given location, it can then trigger a SmartKey device such as opening or closing parking lot gates, lock doors within real estate, bring down metal protection over windows or unlock vehicles.
## Requirements
- NPM
- A Chainlink node and somewhere to host the [SmartKey external adapter](https://github.com/pappas999/smartkey-poc/tree/main/src/SmartKey-External-Adapter) is optional. If you leave the code as it is, it will use one currently running on Google Cloud Platform.
- A running [Smartkey External Adapter](https://github.com/pappas999/smartkey-poc/tree/main/src/SmartKey-External-Adapter)
## Installation
Set your `KOVAN_RPC_URL` [environment variable.](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html). You can get one for free at [Infura's site.](https://infura.io/). You'll also need to set the variable `PRIVATE_KEY` which is your private key from you wallet, ie metamask. Finally, you'll also need an API key from [World Weather Online](https://www.worldweatheronline.com/) set as an environment variable. You can obtain a free trial key from their site.
```
export KOVAN_RPC_URL=www.infura.io/asdfadsfafdadf
export PRIVATE_KEY=abcdef
export WWO_KEY=123456
```
Then you can install all the dependencies. This project uses the [Hardhat](http://hardhat.org) development environment
```bash
npm install
```
Or
```bash
yarn install
```
## Deploy
Deployment script is located in the [deploy](https://github.com/pappas999/smartkey-poc/tree/main/deploy) directory. If required, edit the constructor parameters here, because they are sent to the smart contract when it's instantiated.
| Parameter | Description | Default Value |
| ----------------|:------------------------------------------| :---------------------------------------------------------------|
| DEVICE_ADDRESS | The address of the Smart Device | 3MrA71hEHJTS51vJFZGTSevQR1XC9eV6Xup |
| DEVICE_LOCATION | Where the Smart Device is located | Warsaw |
| DEVICE_THRESHOLD| Wind Kmph threshold to trigger the device | 1 |
Once this is done, you can run the hardhat deployment plugin as follows. If no network is specified, it will default to the Kovan network.
```bash
npx hardhat deploy
```
## Run
The deployment output will give you the contract address once it's deployed. You can then use the contract address in conjunction with Hardhat tasks to perform operations on the contract
The SmartKeyConsumer contract has one main task, as well as supporting tasks to read contract staste.
- Task to request external weather data and if required, trigger the Smartkey API to modify the device state
- Supporting task to see the currently recorded weather in the contract state
- Supporting task to see the currently recorded device state in the contract
- Supporting task to see the currently wind threshold set in the contract state
- Supporting task to update the wind threshold in the contract state
- Supporting task to fund the contract with LINK
The main flow of events is as follows:
- Check windspeed at the given location
- If the windspeed goes above or below the threshold, a call to modify the device state is made
This contract needs to be funded with link first:
```bash
npx hardhat fund-link --contract insert-contract-address-here
```
Once it's funded, you can request external weather data as follows:
```bash
npx hardhat check-weather --contract insert-contract-address-here
```
Once you have successfully made a request for weather data, you can see the result via the read-weather task
```bash
npx hardhat read-weather --contract insert-contract-address-here
```
Finally, to see the status of the smart device, you can use the check-device task. It will return either 'Open' or 'Closed'
```bash
npx hardhat check-device --contract insert-contract-address-here
```