kleros/escrow-react

Kleros Escrow React Library

kleros-escrow

Kleros escrow react library

Usage

import React, { Component } from 'react'

import PayWithEscrowButton from 'kleros-escrow'
import 'kleros-escrow/dist/index.css'

class Example extends Component {
  render() {
    return <MyComponent />
  }
}

Development

In the root directory run yarn start to spin up a development server that builds new changes to /dist.

In /example run yarn start to run the test webapp that uses the built components.

License

MIT © satello

escrow-react's Issues

Component: Go to escrow

Not in figma.

After a dispute has been raised a component should be made available that links to the escrow interface. Alternatively the RaiseDisputeModal component can become a link after the dispute has been created.

Add transaction status notifications

Add the Pending Transaction and Transaction Complete notifications. Alternatively we can leave this up to the sellers website as they get a callback when a transaction is submitted.

Generate MetaEvidence and Add to IPFS

Upon submission of the transaction MetaEvidence should be generated and included in the transaction. Can use same MetaEvidence as is used with escrow.

Evidence display interface can be found here: https://github.com/kleros/escrow-evidence-display

escrow-react/src/index.tsx

Line 71 in 4394ff4

// TODO generate meta evidence and add to IPFS

Email notification handling for buyer

The buyer needs to register their emails for Escrow notifications. Use similar notification signup flow as we have with other DApps.

escrow-react/src/components/notification-view.tsx

Line 19 in 4394ff4

// TODO

Fix escrow email notifications

Escrow email notifications haven't been functional for some time. Handlers already exist for them so they probably just need to be debugged.

https://github.com/kleros/event-microservices/blob/develop/src/event-handlers/escrow-emails.js

Add email notification handling for seller

Sellers need to be notified when a transaction is submitted and also become subscribed to the escrow notifications.

escrow-react/src/index.tsx

Line 86 in 4394ff4

// TODO register emails with AWS

Library Documentation

The widget requires a significant number of inputs. Some full length documentation needs to be written to explain what they all do, what is optional and what is not.

Support/logic for supporting ETH + ERC20 tokens

The component takes currency as an input but there is no logic to route it to the ERC20 contract instead of the normal arbitrable contract. Will need to get address from T2CR and throw an error if a token ticker is used that is not in the list. Alternatively you can have seller pass a contract address in addition to the ticker and bypass using the T2CR

Component: RaiseDisputeModal

The view for raising a dispute needs to be created.

Can be seen here: https://www.figma.com/file/b7DEUKDeHlOl4ocDTMv7UIhZ/Kleros?node-id=7790%3A43446