Skip to content

Commit

Permalink
Merge pull request #41 from mempool/nymkappa/ocean-pool
Browse files Browse the repository at this point in the history
Add Ocean Pool
  • Loading branch information
softsimon authored Dec 2, 2023
2 parents 8a11b95 + f61c7a0 commit de0ad43
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Mining pools definition used on https://mempool.space/mining/pools

# Contributing

Contributions welcome. All changes must be applied in `pools.json` file.
Contributions welcome. All changes must be applied in `pools-v2.json` file.

## Adding a new mining pool

Regardless of the choosen method, we recommend adding a appropriate slug to each
new mining pool you add to `pools.json`. The slug will be used as a unique tag for
new mining pool you add to `pools-v2.json`. The slug will be used as a unique tag for
the mining pool, for example in the public facing urls like https://mempool.space/mining/pool/foundryusa (here `foundryusa` is the slug).

You can specify mining pool slugs in the `slugs` object in `pools.json`. If you
You can specify mining pool slugs in the `slugs` object in `pools-v2.json`. If you
don't specify one, we will automatically generate one [as such](https://github.com/mempool/mempool/blob/02820b0e6836c4202c2e346195e8aace357e3483/backend/src/api/pools-parser.ts#L106-L110).

```javascript
Expand Down Expand Up @@ -95,15 +95,15 @@ for (let i = 0; i < pools.length; ++i) {
## Change an existing mining pool metadata
You can also change an existing mining pool's name, link and slug. In order to
do so properly, you must update all existing entry in the `pools.json` file.
do so properly, you must update all existing entry in the `pools-v2.json` file.
For example, if you'd like to rename `Foundry USA` to `Foundry Pool`, you must replace
all occurences of the old string with the new one in `pools.json` file, with no
all occurences of the old string with the new one in `pools-v2.json` file, with no
exception, otherwise you'll end with two mining pools. The samme idea applies if
you want to change the link or the slug.
For example, to rename `Foundry USA` to `Foundry Pool` you'd need to update the
following (using today's `pools.json` as reference):
following (using today's `pools-v2.json` as reference):
```json
// Original
Expand Down Expand Up @@ -181,14 +181,14 @@ the latest mining pool data.
## Mining pool definition
When the mempool backend starts, we automatically fetch the latest `pools.json`
version from github. By default the url points to https://github.com/mempool/mining-pools/blob/master/pools.json but you can configure it to points to another repo by setting
When the mempool backend starts, we automatically fetch the latest `pools-v2.json`
version from github. By default the url points to https://github.com/mempool/mining-pools/blob/master/pools-v2.json but you can configure it to points to another repo by setting
the following backend variables:
```
{
"MEMPOOL": {
'POOLS_JSON_URL': 'https://raw.githubusercontent.com/mempool/mining-pools/master/pools.json',
'POOLS_JSON_URL': 'https://raw.githubusercontent.com/mempool/mining-pools/master/pools-v2.json',
'POOLS_JSON_TREE_URL': 'https://api.github.com/repos/mempool/mining-pools/git/trees/master'
}
}
Expand Down
13 changes: 12 additions & 1 deletion pools-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -1540,5 +1540,16 @@
"SecPool"
],
"link": "https://www.secpool.com"
},
{
"id": 141,
"name": "OCEAN",
"addresses": [
"37dvwZZoT3D7RXpTCpN2yKzMmNs2i2Fd1n"
],
"tags": [
"OCEAN.XYZ"
],
"link": "https://ocean.xyz/"
}
]
]

0 comments on commit de0ad43

Please sign in to comment.