Skip to content
This repository was archived by the owner on Jun 30, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:
docker run \
--name station \
--detach \
--env FIL_WALLET_ADDRESS=f410fhgyuvi4k35wnqkvtdpewptt2oihbchvy5bdlmxy \
--env FIL_WALLET_ADDRESS=0x000000000000000000000000000000000000dEaD \
$IMAGEID
env:
IMAGEID: ${{ steps.docker_build.outputs.imageid }}
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ $ npm install -g @filecoin-station/core
## Usage

```bash
$ FIL_WALLET_ADDRESS=f410/0x... station
$ FIL_WALLET_ADDRESS=... station
```

## Common Configuration
Expand All @@ -47,12 +47,12 @@ Station Core is configured using environment variables (see

The following configuration options are shared by all Station commands:

- `$CACHE_ROOT`_(string; optional)_: Station stores temporary files (e.g. cached
data) in this directory. Defaults to
- `$CACHE_ROOT` _(string; optional)_: Station stores temporary files (e.g.
cached data) in this directory. Defaults to
- Linux: `${XDG_CACHE_HOME:-~/.cache}/filecoin-station-core`
- macOS: `~/Library/Caches/app.filstation.core`
- Windows: `%TEMP%/Filecoin Station Core`
- `$STATE_ROOT`_(string; optional)_: Station stores logs and module state in
- `$STATE_ROOT` _(string; optional)_: Station stores logs and module state in
this directory. Defaults to
- Linux: `${XDG_STATE_HOME:-~/.local/state}/filecoin-station-core`
- macOS: `~/Library/Application Support/app.filstation.core`
Expand All @@ -70,12 +70,14 @@ the configuration options described in
[Common Configuration](#common-configuration):

- `FIL_WALLET_ADDRESS` _(string; required)_: Address of the Filecoin wallet that
will receive rewards. The value must be a mainnet address starting with `f410`
or `0x`.
will receive rewards. The value must be a mainnet address starting with
`f410`, `0x`.

Addresses starting with `f1` are deprecated. We allow them for now but will
start rejecting them in an upcoming version.

If you just want to give `core` a quick spin, you can use the address
`f410fhgyuvi4k35wnqkvtdpewptt2oihbchvy5bdlmxy` or respectively
`0x39b14aa38adf6cd82aB31BC967Ce7a720E111Eb8`. Please note that any earnings
`0x000000000000000000000000000000000000dEaD`. Please note that any earnings
sent there will be lost.

This command outputs metrics and activity events:
Expand Down Expand Up @@ -150,7 +152,7 @@ Deploy Station with [Docker](https://www.docker.com/). Please replace
$ docker run \
--name station \
--detach \
--env FIL_WALLET_ADDRESS=f410fhgyuvi4k35wnqkvtdpewptt2oihbchvy5bdlmxy \
--env FIL_WALLET_ADDRESS=0x000000000000000000000000000000000000dEaD \
ghcr.io/filecoin-station/core
```

Expand Down
8 changes: 7 additions & 1 deletion commands/station.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ export const station = async ({ json, experimental }) => {
console.error('FIL_WALLET_ADDRESS required')
process.exit(1)
}
if (!FIL_WALLET_ADDRESS.startsWith('f410') && !FIL_WALLET_ADDRESS.startsWith('0x')) {
if (FIL_WALLET_ADDRESS.startsWith('f1')) {
console.error('Warning: f1... addresses are deprecated and will not receive any rewards.')
console.error('Please use an address starting with f410 or 0x')
} else if (
!FIL_WALLET_ADDRESS.startsWith('f410') &&
!FIL_WALLET_ADDRESS.startsWith('0x')
) {
console.error('FIL_WALLET_ADDRESS must start with f410 or 0x')
process.exit(1)
}
Expand Down
2 changes: 1 addition & 1 deletion test/util.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { fileURLToPath } from 'node:url'

export const FIL_WALLET_ADDRESS = 'f410fhgyuvi4k35wnqkvtdpewptt2oihbchvy5bdlmxy'
export const FIL_WALLET_ADDRESS = '0x000000000000000000000000000000000000dEaD'

export const station = fileURLToPath(
new URL('../bin/station.js', import.meta.url)
Expand Down