Estuary
An experimental ipfs node
Building
Requirements:
- Run
make clean all
inside the estuary directory
Running your own node
To run locally in a 'dev' environment, first run:
./estuary setup
Save the auth token that this outputs, you will need it for interacting with and controlling the node.
NOTE: if you want to use a different database than a sqlite instance stored in your local directory, you will need to configure that with the --database
flag, passed before the setup command: ./estuary --database=XXXXX setup
Once you have the setup complete, choose an appropriate directory for estuary to keep its data, and use it as your datadir flag when running estuary. You will also need to tell estuary where it can access a lotus gateway api, we recommend using:
export FULLNODE_API_INFO=wss://api.chain.love
Then run:
./estuary --datadir=/path/to/storage --database=IF-YOU-NEED-THIS --logging
Running as daemon with Systemd
The Makefile has a target that will install a generic but workable systemd service for estuary.
Run make install-estuary-service
on the machine you wish to run estuary on.
Make sure to follow the instructions output by the make
command as configuration is required before the service can run succesfully.
Contributing
See CONTRIBUTING.md
for contributing and development instructions.
Contributing
See CONTRIBUTING.md
for contributing instructions.
Troubleshooting
Make sure to install all dependencies as indicated above. Here are a few issues that one can encounter while building estuary
route ip+net: netlinkrib: too many open files
Guide for: Error
If you get the following error:
/ERROR basichost basic/basic_host.go:328 failed to resolve local interface addresses {"error": "route ip+net: netlinkrib: too many open files"}
It is because you do not have enough open file handles available.
Solution
Update this with the following command:
ulimit -n 10000
hwloc
on M1 Macs
Guide for: Missing The Portable Hardware Locality (hwloc) software package provides a portable abstraction of the hierarchical structure of current architectures, including NUMA memory nodes, sockets, shared caches, cores, and simultaneous multi-threading (across OS, versions, architectures, etc.).
lhwloc
is used by libp2p-core. Estuary uses libp2p for the majority of its features including network communication, pinning, replication and resource manager.
Error
`ld: library not found for -lhwloc`
Solution
For M1 Macs, here's the following steps needed
- Step 1:
brew install go bzr jq pkg-config rustup hwloc
- Uninstall rust as it would clash with rustup in case you have installed. - Step 2: export LIBRARY_PATH=/opt/homebrew/lib
- Step 3: Follow the steps as per the docs.
cannot find -lfilcrypto collect2
Guide for: Related issue here
Error
When trying to build estuary in an ARM machine, it returns an error
# github.com/filecoin-project/filecoin-ffi/generated /usr/bin/ld: skipping incompatible extern/filecoin-ffi/generated/../libfilcrypto.a when searching for -lfilcrypto /usr/bin/ld: skipping incompatible extern/filecoin-ffi/generated/../libfilcrypto.a when searching for -lfilcrypto /usr/bin/ld: skipping incompatible extern/filecoin-ffi/generated/../libfilcrypto.a when searching for -lfilcrypto /usr/bin/ld: skipping incompatible extern/filecoin-ffi/generated/../libfilcrypto.a when searching for -lfilcrypto /usr/bin/ld: skipping incompatible extern/filecoin-ffi/generated/../libfilcrypto.a when searching for -lfilcrypto /usr/bin/ld: cannot find -lfilcrypto collect2: error: ld returned 1 exit status make: *** [Makefile:67: estuary] Error 2
Solution
Related solution here
RUSTFLAGS="-C target-cpu=native -g" FFI_BUILD_FROM_SOURCE=1 make clean deps bench