Giter VIP home page Giter VIP logo

tanglestash's Introduction

Tanglestash

license npm npm daviddm
The tangle of IOTA meets BitTorrent: An algorithm to persist any file onto the tangle of IOTA

Features

  • Persist any data onto the tangle of IOTA
  • Retrieve data that was persisted with this module beforehand
  • Optionally encrypt your data with a password (via AES)
  • Store a string or even a whole file without any prior conversion

GUI

Check out my other project tanglesta.sh here on GitHub which implements this module into a full-blown desktop app available for Windows, macOS and Linux.

Idea

I really like the idea of the tangle of IOTA and I think that this cryptocurrency has a bright future. I run a full node myself and want the idea to succeed. The more I messed with IOTA, the further this idea formed in my mind to use the 2187 trytes of each transactions signature to store any data on the decentralised tangle.

This module can persist any string or even files directly onto the tangle via creating a torrent-esque chain of transactions that reference other transactions holding the data while also referencing their direct predecessor in the chain. That way, this module can also retrieve any data that was persisted beforehand by just passing the 'entry-hash' into it, which is the first transaction hash of the created chain. The data can be optionally encrypted with a secret via AES so that even if someone gets hold of an 'entry-hash', the data will still be illegible. Data is stored as a Base64 string and files will be automatically encoded if passed into the algorithm as well as decoded if retrieved โ€“ no prior conversion of the file needed.

Installation

NPM

npm install --save tanglestash

Yarn

yarn add tanglestash

Usage

First off, create a new instance of the modules class

let tanglestash = new Tanglestash(provider, datatype, seed);

with the following arguments:

  1. provider: String A URI of an IOTA full node
  2. datatype: String Either 'file' or 'string' based on the data that will later be used
  3. seed: String [Optional] An IOTA wallet seed; will be automatically generated if not passed here

readFromTangle

Retrieves data that was persisted onto the tangle in the past.

Input

tanglestash.readFromTangle(entryHash, secret)
  1. entryHash: String Any transaction hash that was output after successfully persisting data beforehand; called 'entry-hash'
  2. secret: String [Optional] The password the data was encrypted with; if any

Return Value

  1. Promise.<*> - A file buffer of the retrieved data or a string based on this.datatype

saveToTangle

Persists data onto the tangle.

Input

tanglestash.saveToTangle(data, secret)
  1. data: String The data as a string or file path based on this.datatype
  2. secret: String [Optional] The password the data should be encrypted with; if any

Return Value

  1. Promise.<string> - The last transaction hash of the created chain; called 'entry-hash'

generateRandomIotaSeed

Generates a random valid IOTA wallet seed.

Input

tanglestash.generateRandomIotaSeed()

Return Value

  1. String - The generated seed

getNewIotaAddress

Retrieves a new valid IOTA wallet address based on this.seed.

Input

tanglestash.getNewIotaAddress()

Return Value

  1. Promise.<string> - The retrieved wallet address

getAllMarkyEntries

Returns all the marky entries used to time the main processes. If you've never used marky before, learn more about it here.

Input

tanglestash.getAllMarkyEntries()

Return Value

  1. Array.<object> - All the timing entries created by marky

Donations

If you like this module and want to support it, you can of course donate some IOTA ๐Ÿ˜Š
QIFKUOEQBCEV9NKFWDBTQYBHLFFORLVKDQSYDSZQQMKTCBLBFDQMJWIOUDH9DLZXVKGNQGKLSAJCQQMEDESLCTHGZD

License

MIT

tanglestash's People

Contributors

loehnertz avatar gagathos avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.