Skip to content

Commit

Permalink
update README.md in oracle
Browse files Browse the repository at this point in the history
  • Loading branch information
johnmssdish committed Dec 19, 2023
1 parent af86cfd commit 351b47d
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion findr/oracle/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
oracle.ts will provide findr back-end api to accept api request from findr UI, and then process Vault validation. If passing Vault validation, it will send all parameters to findr orchestrator to build connection between findr adapters and iot devices and send the response back to findr UI. Otherwise, it will send back the error messages to findr UI.
# Oracle.ts - Findr Back-End API

Oracle.ts is the sophisticated back-end API for FINDR, designed to seamlessly handle API requests from the FINDR UI. This powerhouse not only processes Vault validation but also orchestrates the establishment of connections between FINDR adapters and IoT devices.

## repo structure:
```
findr/
├── oracle/
│ ├── oracle.ts
│ │
│ ├── vault-client.ts
│ │
│ ├── harbor-client.ts
```

## Features

- **Vault Validation:** oracle.ts rigorously verifies requests against the sacred Vault, ensuring only the worthy proceed.

- **Connection Building:** Upon successfully passing Vault validation, oracle.ts collaborates with the FINDR Orchestrator to construct a robust bridge between FINDR adapters and a constellation of IoT devices.

- **Error Handling:** In the event of unsuccessful Vault validation, oracle.ts gracefully communicates detailed error messages back to the FINDR UI.

## Usage

To harness the power of oracle.ts, simply make API requests from the FINDR UI. oracle.ts will work its magic, validating the Vault, facilitating connections, and delivering responses promptly.

## Installation

```bash
npm run compile && node ./dist/oracle.js

0 comments on commit 351b47d

Please sign in to comment.