Skip to content

Commit 9085562

Browse files
authored
Fix readme and add env comments (#20)
1 parent 9d020f5 commit 9085562

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed

.env.example

+6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
# Infura
12
INFURA_API_KEY=00000000000000000000000000000000
23

4+
# Twilio
35
TWILIO_ACCOUNT_SID=0000000000000000000000000000000000
46
TWILIO_API_KEY=00000000000000000000000000000000
57
TWILIO_FROM_NUMBER=+12345678900
68

9+
# Redis
10+
REDIS_URL=redis://localhost:6379/0
11+
12+
# Prisma
713
PRISMA_ENDPOINT=http://localhost:4466
814
PRISMA_MANAGEMENT_API_SECRET=not-a-secret

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# eth-explorer
1+
# multi-api
22

3-
![npm](https://img.shields.io/npm/v/eth-explorer.svg)
3+
![npm](https://img.shields.io/npm/v/multi-api.svg)
44

55
Explore the Ethereum blockchain using a rich GraphQL API. [**Try it in your browser!**](https://www.graphqlbin.com/v2/nrk9s6)
66

77
Users want consistent experiences across platforms, but delivering this leads to headaches for developers of decentralized applications. Developers often end up duplicating Ethereum-related application logic between native and web-based clients to support the advanced functionalities of smart contracts, such as identity management and ENS address resolution.
88

9-
`eth-explorer` is an extensible and general purpose GraphQL gateway for Ethereum. Thanks to the composability of GraphQL queries, its interface makes it convenient to walk the Ethereum blockchain from block to transaction to address, provides methods for common action such as retrieving address balances, supports inspecting/sending transactions, and more. Better yet, you can use it right within your browser. This library works by proxying requests via [web3](https://web3js.readthedocs.io/en/1.0/) to the wonderful [Infura](https://infura.io/docs) service, with caching handled using the [DataLoader pattern](https://github.com/facebook/dataloader). Its simple, stateless architecture lends itself toward extension: you can use `eth-explorer` as a starting point for your decentralized application's backend to support native and web clients.
9+
`multi-api` is an extensible and general purpose GraphQL gateway for Ethereum. Thanks to the composability of GraphQL queries, its interface makes it convenient to walk the Ethereum blockchain from block to transaction to address, provides methods for common action such as retrieving address balances, supports inspecting/sending transactions, and more. Better yet, you can use it right within your browser. This library works by proxying requests via [web3](https://web3js.readthedocs.io/en/1.0/) to the wonderful [Infura](https://infura.io/docs) service, with caching handled using the [DataLoader pattern](https://github.com/facebook/dataloader). Its simple, stateless architecture lends itself toward extension: you can use `multi-api` as a starting point for your decentralized application's backend to support native and web clients.
1010

11-
This service has [or will have](https://github.com/dsys/eth-explorer/issues) first-class support for a number of existing or emerging standards in the Ethereum ecosystem, including:
11+
This service has [or will have](https://github.com/dsys/multi-api/issues) first-class support for a number of existing or emerging standards in the Ethereum ecosystem, including:
1212

1313
* **ERC 20/ERC 721 support:** register token contracts with a curated registry and retrieve address balances and token metadata
14-
* **Identity/multi-sig:** using the [solidity-sigutils](https://github.com/dsys/solidity-sigutils) library, eth-explorer will support compatible identity ERC 725 contracts, including ENS resolution
14+
* **Identity/multi-sig:** using the [solidity-sigutils](https://github.com/dsys/solidity-sigutils) library, multi-api will support compatible identity ERC 725 contracts, including ENS resolution
1515
* **Filters via WebSockets:** flexible and resilient filters for Ethereum events backed by GraphQL subscriptions, making interactive dapps a breeze
1616
* **Transaction cost estimation:** give end-users a notice of how much a transaction may cost in gas, ether, a token, or a fiat currency of choice
1717
* **Deep contract analysis:** high-resolution analysis of trace calls and value transfers within contracts, also known as "internal transactions," via an instrumented EVM
1818

1919
## Usage
2020

21-
A hosted instance is available at [eth-explorer-gbirnihhso.now.sh](https://eth-explorer-gbirnihhso.now.sh).
21+
A hosted instance is available at [api.multi.app](https://api.multi.app).
2222

2323
```sh
24-
git clone [email protected]:dsys/eth-explorer.git
25-
cd eth-explorer
24+
git clone [email protected]:dsys/multi-api.git
25+
cd multi-api
2626
yarn install
2727
yarn start # listening on localhost:4000
2828
```

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "eth-explorer",
2+
"name": "multi-api",
33
"version": "0.1.0",
44
"license": "Apache-2.0",
55
"author": "Alex Kern <[email protected]>",
@@ -16,8 +16,8 @@
1616
"lint": "tslint --fix --exclude src/generated/prisma.ts 'src/**/*.ts'",
1717
"check": "tsc --noEmit && tslint --exclude src/generated/prisma.ts 'src/**/*.ts'",
1818
"precommit": "yarn run check",
19-
"docker:build": "docker build -t dsys/eth-explorer:latest .",
20-
"docker:run": "docker run -it dsys/eth-explorer:latest"
19+
"docker:build": "docker build -t dsys/multi-api:latest .",
20+
"docker:run": "docker run -it dsys/multi-api:latest"
2121
},
2222
"dependencies": {
2323
"bluebird": "^3.5.1",

0 commit comments

Comments
 (0)