Skip to content

Commit 2cc8545

Browse files
changed bitcoin to auroracoin
1 parent cf8693b commit 2cc8545

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# *insight API*
22

3-
*insight API* is an open-source bitcoin blockchain REST
3+
*insight API* is an open-source auroracoin blockchain REST
44
and websocket API. Insight API runs in NodeJS and uses LevelDB for storage.
55

66
This is a backend-only service. If you're looking for the web frontend application,
7-
take a look at https://github.com/bitpay/insight.
7+
take a look at https://github.com/stirling/insight.
88

9-
*Insight API* allows to develop bitcoin-related applications (such as wallets) that
10-
require certain information from the blockchain that bitcoind does not provide.
9+
*Insight API* allows to develop auroracoin-related applications (such as wallets) that
10+
require certain information from the blockchain that auroracoind does not provide.
1111

1212
A blockchain explorer front-end has been developed on top of *Insight API*. It can
13-
be downloaded at [Github Insight Repository](https://github.com/bitpay/insight).
13+
be downloaded at [Github Insight Repository](https://github.com/stirling/insight).
1414

1515

1616
## Prerequisites
1717

18-
* **bitcoind** - Download and Install [Bitcoin](http://bitcoin.org/en/download)
18+
* **auroracoind** - Download and Install [Auroracoin](http://auroracoin.org/)
1919

20-
*insight API* needs a *trusted* bitcoind node to run. *insight API* will connect to the node
21-
through the RPC API, bitcoin peer-to-peer protocol, and will even read its raw block .dat files for syncing.
20+
*insight API* needs a *trusted* auroracoind node to run. *insight API* will connect to the node
21+
through the RPC API, auroracoin peer-to-peer protocol, and will even read its raw block .dat files for syncing.
2222

23-
Configure bitcoind to listen to RPC calls and set `txindex` to true.
24-
The easiest way to do this is by copying `./etc/bitcoind/bitcoin.conf` to your
25-
bitcoin data directory (usually `~/.bitcoin` on Linux, `%appdata%\Bitcoin\` on Windows,
26-
or `~/Library/Application Support/Bitcoin` on Mac OS X).
23+
Configure auroracoind to listen to RPC calls and set `txindex` to true.
24+
The easiest way to do this is by copying `./etc/auroracoind/auroracoin.conf` to your
25+
auroracoin data directory (usually `~/.AuroraCoin` on Linux, `%appdata%\Auroracoin\` on Windows,
26+
or `~/Library/Application Support/AuroraCoin` on Mac OS X).
2727

28-
bitcoind must be running and must have finished downloading the blockchain **before** running *insight API*.
28+
auroracoind must be running and must have finished downloading the blockchain **before** running *insight API*.
2929

3030

3131
* **Node.js v0.10.x** - Download and Install [Node.js](http://www.nodejs.org/download/).
@@ -37,7 +37,7 @@ bitcoind must be running and must have finished downloading the blockchain **bef
3737

3838
To install Insight API, clone the main repository:
3939

40-
$ git clone https://github.com/bitpay/insight-api && cd insight-api
40+
$ git clone https://github.com/stirling/insight-api && cd insight-api
4141

4242
Install dependencies:
4343

@@ -61,13 +61,13 @@ bitcoind must be running and must have finished downloading the blockchain **bef
6161
All configuration is specified in the [config](config/) folder, particularly the [config.js](config/config.js) file. There you can specify your application name and database name. Certain configuration values are pulled from environment variables if they are defined:
6262

6363
```
64-
BITCOIND_HOST # RPC bitcoind host
65-
BITCOIND_PORT # RPC bitcoind Port
66-
BITCOIND_P2P_HOST # P2P bitcoind Host (will default to BITCOIND_HOST, if specified)
67-
BITCOIND_P2P_PORT # P2P bitcoind Port
64+
BITCOIND_HOST # RPC auroracoind host
65+
BITCOIND_PORT # RPC auroracoind Port
66+
BITCOIND_P2P_HOST # P2P auroracoind Host (will default to BITCOIND_HOST, if specified)
67+
BITCOIND_P2P_PORT # P2P auroracoind Port
6868
BITCOIND_USER # RPC username
6969
BITCOIND_PASS # RPC password
70-
BITCOIND_DATADIR # bitcoind datadir. 'testnet3' will be appended automatically if testnet is used. NEED to finish with '/'. e.g: `/vol/data/`
70+
BITCOIND_DATADIR # auroracoind datadir. 'testnet3' will be appended automatically if testnet is used. NEED to finish with '/'. e.g: `/vol/data/`
7171
INSIGHT_NETWORK [= 'livenet' | 'testnet']
7272
INSIGHT_PORT # insight api port
7373
INSIGHT_DB # Path where to store insight's internal DB. (defaults to $HOME/.insight)
@@ -85,33 +85,33 @@ INSIGHT_EMAIL_CONFIRM_HOST # Only meanfull if ENABLE_EMAILSTORE is enable. Hostn
8585
8686
```
8787

88-
Make sure that bitcoind is configured to [accept incoming connections using 'rpcallowip'](https://en.bitcoin.it/wiki/Running_Bitcoin).
88+
Make sure that auroracoind is configured to [accept incoming connections using 'rpcallowip'](https://en.bitcoin.it/wiki/Running_Bitcoin).
8989

9090
In case the network is changed (testnet to livenet or vice versa) levelDB database needs to be deleted. This can be performed running:
9191
```util/sync.js -D``` and waiting for *insight* to synchronize again. Once the database is deleted, the sync.js process can be safely interrupted (CTRL+C) and continued from the synchronization process embedded in main app.
9292

9393
## Synchronization
9494

95-
The initial synchronization process scans the blockchain from the paired bitcoind server to update addresses and balances. *insight-api* needs exactly one trusted bitcoind node to run. This node must have finished downloading the blockchain before running *insight-api*.
95+
The initial synchronization process scans the blockchain from the paired auroracoind server to update addresses and balances. *insight-api* needs exactly one trusted auroracoind node to run. This node must have finished downloading the blockchain before running *insight-api*.
9696

9797
While *insight* is synchronizing the website can be accessed (the sync process is embedded in the webserver), but there may be missing data or incorrect balances for addresses. The 'sync' status is shown at the `/api/sync` endpoint.
9898

99-
The blockchain can be read from bitcoind's raw `.dat` files or RPC interface.
99+
The blockchain can be read from auroracoind's raw `.dat` files or RPC interface.
100100
Reading the information from the `.dat` files is much faster so it's the
101101
recommended (and default) alternative. `.dat` files are scanned in the default
102-
location for each platform (for example, `~/.bitcoin` on Linux). In case a
102+
location for each platform (for example, `~/.AuroraCoin` on Linux). In case a
103103
non-standard location is used, it needs to be defined (see the Configuration section).
104104
As of June 2014, using `.dat` files the sync process takes 9 hrs.
105105
for livenet and 30 mins. for testnet.
106106

107107
While synchronizing the blockchain, *insight-api* listens for new blocks and
108-
transactions relayed by the bitcoind node. Those are also stored on *insight-api*'s database.
108+
transactions relayed by the auroracoind node. Those are also stored on *insight-api*'s database.
109109
In case *insight-api* is shutdown for a period of time, restarting it will trigger
110110
a partial (historic) synchronization of the blockchain. Depending on the size of
111111
that synchronization task, a reverse RPC or forward `.dat` syncing strategy will be used.
112112
113-
If bitcoind is shutdown, *insight-api* needs to be stopped and restarted
114-
once bitcoind is restarted.
113+
If auroracoind is shutdown, *insight-api* needs to be stopped and restarted
114+
once auroracoind is restarted.
115115
116116
### Syncing old blockchain data manually
117117
@@ -135,7 +135,7 @@ Two DBs are created: txs and blocks. By default these are stored on
135135
136136
Please note that some older versions of Insight-API store that on `<insight's root>/db`.
137137
138-
This can be changed at config/config.js. As of June 2014, storing the livenet blockchain takes ~35GB of disk space (2GB for the testnet).
138+
This can be changed at config/config.js. As of March 2015, storing the livenet blockchain takes ~1GB of disk space.
139139
140140
## Development
141141
@@ -148,7 +148,7 @@ To run the tests
148148
```$ grunt test```
149149
150150
151-
Contributions and suggestions are welcome at [insight-api github repository](https://github.com/bitpay/insight-api).
151+
Contributions and suggestions are welcome at [insight-api github repository](https://github.com/stirling/insight-api).
152152
153153
## Caching schema
154154
@@ -341,7 +341,7 @@ POST response:
341341
/api/peer
342342
```
343343

344-
### Status of the bitcoin network
344+
### Status of the auroracoin network
345345
```
346346
/api/status?q=xxx
347347
```

0 commit comments

Comments
 (0)