Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.89 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.89 KB
Raw

DEGov Interpreter Typescript

This repo contains a system to store and track governance files on both mobile and web.

Dependencies

Both mobile and web are dependent on fetch

Mobile is dependent on React Native Async Storage

Web is dependent on the Node File system

How to use

import promises from "fs/promises"
import ReactStorage from "@react-native-async-storage/async-storage"
import fetch from ""
//first create and instance of the internal storage object for your 
//platform ie (ReactNativeStorage or WebStoreage)

//Mobile
const storage = ReactNativeStorage(ReactStorage)

//Node
const storage = WebStorage(promises)

//Create service instance
const service = DegovService(fetch, storage)
//Initialize the service to resume and previous state
await service.init()

//Use the service object to manage and check dids against the governance files

//Adds a list of files to the service
service.setFiles(["https://someUrl.com", "https://someOtherUrl.com"])

Features

  1. Tracking active files
    • Files set as active are the only files dids are checked against
    • You can retrieve a list of all active or inactive files denoted by their url
  2. Automatic refetch after ttl(time to live) expirations
    • Every governace file with a valid ttl is automatically refetched when you attempt to use it if it has expired
  3. Cached storage
    • Files are cached and only refetched when they have expired
  4. Long term storage
    • Files are stored using either node file system or react native storage so that a sense of state can persist between sessions, this means that when you reload an app or restart an agent the files you have used and the active or inactive state they had is pulled from storage instead of refetching them all at start up (expired files are still refetched).