Coder Social home page Coder Social logo

isabella232 / proxy-retrieval Goto Github PK

View Code? Open in Web Editor NEW

This project forked from filecoin-shipyard/proxy-retrieval

0.0 0.0 0.0 1.11 MB

A simple method of allowing a browser node to retrieve from a stroage miner indirectly through this proxy

License: MIT License

TypeScript 99.51% JavaScript 0.49%

proxy-retrieval's Introduction

Retrieval Proxy Server

Status

This repository is in a frozen state. It is not being maintained or kept in sync with the tools and libraries it builds on. Even though work on this repository has been shelved, anyone interested in updating or maintaining this project should express their interest on one Filecoin community conversation mediums: https://github.com/filecoin-project/community#join-the-community.


The Retrieval Proxy (RP) server is a simple method of allowing a browser node to retrieve from a stroage miner indirectly.

When the browser wishes to retrieve a file from a Storage Miner, it opens a websockets connection to the RP server. The browser sends the CID it wants and FIL to fund the retrieval to a wallet created on the RP server. The RP server, which is running a full Lotus daemon instance, then does the requested retrieval and sends the data back to the browser.

Diagram of Browser and Retrieval Proxy Working Together

Retrieval Proxy Protocol

The draft protocol is described in this Protocol Design Google Doc.

As we finalize the first version of the API, that document will be brought into this repo as markdown.

Contributing

This repo contains all information needed to run an RP server yourself. See the docs/ directory.

We welcome contributions in the form of issues and PRs to this repo. We also have a daily standup at 3pm UTC. Email [email protected] or contact @mike - pl on Filecoin Slack if you'd like to join. Curious lurkers and serious contributors are equally welcome!

License

Copyright Filecoin Project, 2020. MIT License.

proxy-retrieval's People

Contributors

aistoc avatar brunolm avatar ionutiorgulescu avatar rvagg 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.