Giter Site home page Giter Site logo

cryptonetlab / retriev Goto Github PK

View Code? Open in Web Editor NEW
17.0 6.0 7.0 3.96 MB

Home of Retriev protocol (by CryptoNet + YOMI)

Home Page: https://retriev.org

JavaScript 40.72% Shell 0.76% Solidity 43.12% TypeScript 2.70% Dockerfile 0.04% HTML 0.20% Vue 8.59% SCSS 1.61% Rust 0.91% Makefile 0.04% Nix 0.01% Ruby 1.21% Handlebars 0.09%
blockchain ethereum filecoin decentralized-storage ipfs

retriev's People

Contributors

0xjona avatar 10d9e avatar gruns avatar irenegia avatar maxscience avatar steve-rog avatar turinglabsorg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

retriev's Issues

Reputation score mechanism

We want to design a reputation score mechanism for the providers that we can use during testnet in order to

  1. incentivize early adoption of the protocol;
  2. de-risk users to lose money.

cc @lucaniz, @nicola

Key visuals [product design step 1]

In step 1 we are designing the key visuals.

  • First we’ll have a 2 propositions draft of the visual identity, moving toward one detailed brand identity
  • Then we’ll develop the iconographic setting and the related diagrams and use cases of it

@claudiofabbro will help us define the deliverables and the process
We’ll have a round of reviews to be scheduled

EPIC #34

Homepage design [product design step 2]

In step 2 we are designing together with @claudiofabbro the UX of the alpha version of the product and the landing page.

Coming after a few weeks of work from now, when we’ll have defined all the components of the ALPHA and what the landing page is about.

We’ll have to collect all the inputs coming from key references (e.g. https://drand.love )

Homepage COPY

All the text that will be published on the website!

  • about
  • Team
  • Disclaimer for alpha
  • What else?

release/1st (EPIC)

Within the #milestone 1, due by the end of july, we are designing 2 sprint sessions with a release at the end of each.
In this EPIC we'll track all the issues related to the 1st release!

1st release (due date: 28th June):

smart contract freeze

  • #10
  • #32
  • #2 [only design documentation] --> when specified issue?
  • #12 [we'll develop the CLI in a future release #45 ]

website is live

documentation

MVP —> dApp

NFT feature

README with important links

Can we update the readme to have a bullet point list of all the important links? (kanban, demo, design docs, etc)

Website implementation Round#1

@Steve-Rog is coding the website following design from @claudiofabbro #28 and inputs from #40

We expect to have a design-to-code process, followed by a collection of feedbacks and a new iteration.

Improvements will be done to the product during next weeks, so we'll find a way to keep track of this (from brainstorms, to feedbacks, to updates)

For now I'll consider this a Round#1

OOO

If we want to track when we are Out-Of-Office we can use this issue and regularly update it, so that we can plan accordingly all together!

I’m aware this will be a public information, we can think about another way if you prefer.
Nonetheless, we need to coordinate so that release dates or other important milestones don’t overlap with our OOO time.

Documentation (EPIC)

We need to discuss together what kind of documentation we need to develop and why.
After this brainstorming phase, we’ll have to breakdown this issue into further steps.

As for the issues we were having, do we still need

  • video guides to explain the product or give public updates (blog posts, presentations)
  • public documentation wiki, built using gitbook or similar OSS
  • convert notion documentation to a lite paper
  • write down the read me how to run the demo (github /install)

In this issue me and @irenegia will define the deliverables, which will be planned accordingly (e.g. writing down the lite paper assigned to irene and design a visual guide outsourced to graphic designer)

UPDATE

Naming [product design step 0]

We’re having a serie of issues related to the design of the visual identity and UX of the alpha.

Step 0 is a brainstorming session hold by @irenegia and @nicola to come up with narrative/metaphor to communicate the product and identify each part/moment of the protocol!
This will help us set the limits and directions for the next stage of design.

@claudiofabbro will join this process to better learn about the protocol itself.

Demo day (EPIC)

We’ll have scheduled Demo days showcasing not just a collection of regular updates but a coordinated effort toward a designed release!

We are still deciding what this will consist of (videos, presentations, live walkthroughs ecc) but we need to coordinate to organise this small event

  • #35 expected in late June
  • #62 expected early august
  • #71 expected late september

Client website

The client website https://pldr.dev/ misses some features. For example:

  • How does the client appeal? Proposal: add an appeal button

  • Each field needs some explanations and max/min values stated explicetely

Front-end improvements "MVP --> ALPHA"

We are improving the experience of using the MVP with details coherent with recent discussions and feedbacks, so that everyone can wrap their head around what’s happening via the protocol!

This constant update is carried by @Steve-Rog and in the coming weeks will follow up the design process #29 from @claudiofabbro

Tokens destination

The payment goes from client's account to provider's account (if no appeal, otherwise goes back to provider);
The appeal fee goes from client's account to the referees accounts (split the fee, each part in an account);
The collateral goes from provider's account to the contract account (if there is slash, otherwise back to provider);

Are we fine with this policy?
Or should we use the collateral when there is slash to repay the provider/referees?

~The protocol currently burns the collateral from the provider account when a file is not retrieved.
Should we instead give the collateral to the client (all of it, only a fraction of it)? ~

Product Design & Implementation (EPIC)

Together with @claudiofabbro https://claudio.dance , we are designing the product aspects of the data retrievability oracle protocol
@Steve-Rog will initiate and maintain the code!

DESIGN PROCESS

Each Tuesday morning there will be a kick-off meeting / brief sent via email from client (@irenegia) so that @claudiofabbro knows what we are expecting from him.
Each issue has a due date (one week after kick-off), in order to move to the next one and respect the overall deadline.

This process is made of 3 steps (+1) due for the #1st release milestone

  • #29 that belongs to #2nd release milestone

CODING PROCESS

Stefano will follow up with updates from the design, plus is already intervening to make key improvements on the MVP

We'll track this work in the following issues

  • #43 tracking the front-end improvements to the dApp
  • #49 which is about the implementation of the website (and the future updates we expect)

Foundry tests

We decided to use foundry and run some test to understand the gas cost details of our smart contract (ie, the gas cost of each functions used in the contract).

LITEPAPER

@irenegia will covert notion documentation into a LITEPAPER

What program will you use?
What do we expect to have for #35 ?

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.