A MobileCoin service for wallet implementations.
The Full-Service Node provides ledger syncing and validation, account management, and funds transfer and receiving. It uses a JSONRPC API, so you can connect to it from command line tools or build services around its functionality. It serves the use cases of single user (and is the backing to the MobileCoin Desktop Wallet), while also serving high performance, multi-account, multi-subaddress needs (such as backing merchant services platforms).
Please see the full API documentation at: High-Performance Wallet API
- You must read and accept the Terms of Use for MobileCoins and MobileCoin Wallets to use MobileCoin Software.
- Please see CONTRIBUTING.md for notes on contributing bug reports and code.
- License
- Usage and Documentation
- Build and Run
- Docker Build and Run
- Parameters
- Offline (Cold Wallet) Transaction Flow
- Contributing
- Database Schema
- Running Tests
- Linting
MobileCoin Full Service is available under open-source licenses. Look for the LICENSE file for more information.
For documentation, usage, and API specification, see our gitbook page: https://mobilecoin.gitbook.io/full-service-api/
For database encryption features, see DATABASE.md.
Note: Full-Service and mobilecoin are not currently compatible with Xcode 13 (the Xcode that ships with OSX Monterey). Make sure you are using Xcode 12 before building and running Full-service. You can download Xcode 12 from apple's developer downloads page. Download Xcode 12, add it to your applications folder, then set your system to use it with:
sudo xcode-select -s /Applications/<name of xcode application>.app/Contents/Developer
-
Install Rust from https://www.rust-lang.org/tools/install
-
Install dependencies.
On Ubuntu:
sudo apt install build-essential cmake protobuf-compiler libprotobuf-dev llvm llvm-dev clang libclang-dev libsqlite3-dev libssl-dev
On MacOS:
brew bundle
-
Pull submodule.
git submodule update --init --recursive
-
Get the appropriate published enclave measurements, which will be saved to
$(pwd)/consensus-enclave.css
and$(pwd)/ingest-enclave.css
- Note: Namespace is
test
for TestNet andprod
for MainNet.
NAMESPACE=test CONSENSUS_SIGSTRUCT_URI=$(curl -s https://enclave-distribution.${NAMESPACE}.mobilecoin.com/production.json | grep consensus-enclave.css | awk '{print $2}' | tr -d \" | tr -d ,) curl -O https://enclave-distribution.${NAMESPACE}.mobilecoin.com/${CONSENSUS_SIGSTRUCT_URI} INGEST_SIGSTRUCT_URI=$(curl -s https://enclave-distribution.${NAMESPACE}.mobilecoin.com/production.json | grep ingest-enclave.css | awk '{print $2}' | tr -d \" | tr -d ,) curl -O https://enclave-distribution.${NAMESPACE}.mobilecoin.com/${INGEST_SIGSTRUCT_URI}
- Note: Namespace is
-
Install SGX libraries (required for linux distros; not required for MacOS).
On Ubuntu:
wget https://download.01.org/intel-sgx/sgx-linux/2.9.1/distro/ubuntu18.04-server/sgx_linux_x64_sdk_2.9.101.2.bin chmod +x sgx_linux_x64_sdk_2.9.101.2.bin sudo ./sgx_linux_x64_sdk_2.9.101.2.bin --prefix=/opt/intel
Put this line in your .bashrc:
source /opt/intel/sgxsdk/environment
This works on more recent Ubuntu distributions, even though it specifies 18.04.
-
Build
SGX_MODE=HW \ IAS_MODE=PROD \ CONSENSUS_ENCLAVE_CSS=$(pwd)/consensus-enclave.css \ INGEST_ENCLAVE_CSS=$(pwd)/ingest-enclave.css \ cargo build --release -p mc-full-service
-
Set database password if using encryption.
read -rs MC_PASSWORD export MC_PASSWORD=$MC_PASSWORD
-
Run
TestNet Example
mkdir -p /tmp/wallet-db/ ./target/release/full-service \ --wallet-db /tmp/wallet-db/wallet.db \ --ledger-db /tmp/ledger-db/ \ --peer mc://node1.test.mobilecoin.com/ \ --peer mc://node2.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node1.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node2.test.mobilecoin.com/ \ --fog-ingest-enclave-css $(pwd)/ingest-enclave.css
See Parameters for full list of available options.
-
Pull submodule.
git submodule update --init --recursive
-
Build
This build takes advantage of features in Docker BuildKit use
DOCKER_BUILDKIT=1
when building this image.See the Dockerfile comments for the full list of available build arguments to customize the build.
TestNet Version
Use
--build-arg NAMESPACE=test
to configure build to use TestNet enclave measurements.DOCKER_BUILDKIT=1 docker build -t mobilecoin/full-service:0.0.0-testnet --progress=plain \ --build-arg NAMESPACE=test \ --build-arg BUILD_OPTS=--no-default-features .
MainNet Version
Use
--build-arg NAMESPACE=prod
to configure build to use MainNet enclave measurements.DOCKER_BUILDKIT=1 docker build -t mobilecoin/full-service:0.0.0 --progress=plain \ --build-arg NAMESPACE=prod .
-
Run
Volumes
This image includes
VOLUME /data
and configuresfull-service
to use that path for the wallet and ledger database locations.If you want to save your databases outside the default volume you can use
-v path/to/volume:/data
but you mustchown 1000:1000 path/to/volume
so the app running as uid 1000 can access it.mkdir -p /opt/full-service/data chown 1000:1000 /opt/full-service/data docker run -it -p 127.0.0.1:9090:9090 \ -v /opt/full-service/data:data \ --name full-service \ mobilecoin/full-service \ --peer mc://node1.test.mobilecoin.com/ \ --peer mc://node2.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node1.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node2.test.mobilecoin.com/
Listen and Port
This image configures
full-service
to listen on the container0.0.0.0:9090
Use
-p 127.0.0.1:9090:9090
to expose the API to you localhost.Run
Required parameters are added as command options to the container.
TestNet Example
docker run -it -p 127.0.0.1:9090:9090 --name full-service mobilecoin/full-service \ --peer mc://node1.test.mobilecoin.com/ \ --peer mc://node2.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node1.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node2.test.mobilecoin.com/
See Parameters for full list of available options.
Param | Purpose | Requirements |
---|---|---|
wallet-db |
Path to wallet file | Created if does not exist |
ledger-db |
Path to ledger directory | Created if does not exist |
peer |
URI of consensus node. Used to submit transactions and to check the network block height. |
MC URI format |
tx-source-url |
S3 location of archived ledger. Used to sync transactions to the local ledger. |
S3 URI format |
Opional Param | Purpose | Requirements |
---|---|---|
listen-host |
Host to listen on. | Default: 127.0.0.1 |
listen-port |
Port to start webserver on. | Default: 9090 |
ledger-db-bootstrap |
Path to existing ledger_db that contains the origin block, used when initializing new ledger dbs. |
|
quorum-set |
Quorum set for ledger syncing. | Default includes all peers |
poll-interval |
How many seconds to wait between polling for new blocks. | Default: 5 |
offline |
Use Full Service in offline mode. This mode does not download new blocks or submit transactions. | |
fog-ingest-enclave-css |
Path to the Fog ingest enclave sigstruct CSS file. | Needed in order to enable sending transactions to fog addresses. |
You can add an optional API key to full service by adding a .env
file to the root of this repo. The variable you need to set is: MC_API_KEY="<api key of your choosing>"
. If you set this env var, you must provide the X-API-KEY
header in your requests to full-service.
The process exit code indicates why it exited:
Code | Meaning |
---|---|
1 | Unknown error |
2 | Could not connect to database. |
3 | Wrong database password. |
4 | Connecting from a banned IP address. |
101 | Rust Panic. |
For documentation, usage, and API specification, see our gitbook page: https://mobilecoin.gitbook.io/full-service-api/
Full Service supports offline transactions. This flow is recommended to keep an account key on an air-gapped machine which has never connected to the internet.
The recommended flow to get balance and submit transaction is the following:
-
ONLINE MACHINE: Sync ledger by running full service.
./target/release/full-service \ --wallet-db /tmp/wallet-db/wallet.db \ --ledger-db /tmp/ledger-db/ \ --peer mc://node1.test.mobilecoin.com/ \ --peer mc://node2.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node1.test.mobilecoin.com/ \ --tx-source-url https://s3-us-west-1.amazonaws.com/mobilecoin.chain/node2.test.mobilecoin.com/
-
ONLINE MACHINE and USB: Copy the ledger and the full-service binary to USB.
cp -r /tmp/ledger-db /media/ cp ./target/release/full-service /media/
-
OFFLINE MACHINE: Create a ramdisk to store sensitive material.
-
Linux: The following will create a 512 MB ramdisk located at
/keyfs
.sudo swapoff -a sudo mkdir /keyfs sudo mount -t tmpfs -o size=512m tmpfs /keyfs
-
MacOS: The following will create a 512 MB ramdisk located at
/Volumes/KeyFS
.diskutil erasevolume HFS+ 'KeyFS' `hdiutil attach -nomount ram://1048576`
For the remaining instructions, we will refer to
/keyfs
as the ramdisk location, so if on MacOS, know that this maps to/Volumes/KeyFS
.
-
-
OFFLINE MACHINE and USB: Copy the ledger and the full-service binary to the Offline Machine.
cp /media/ledger-db /keyfs/ledger-db cp /media/full-service /keyfs/full-service
-
OFFLINE MACHINE: Run full service in offline mode.
./target/release/full-service \ --wallet-db /keyfs/wallet.db \ --ledger-db /keyfs/ledger-db/ \ --offline
-
OFFLINE MACHINE: You can now create or import your account, check your balance , create assigned subaddresses, and construct transactions, as outlined in the docs above. Note that your entropy, account key, and wallet.db should always remain only on the ramdisk.
-
OFFLINE MACHINE and USB: To send a transaction, you will a Construct a TxProposal using the
build_transaction
endpoint. The output of this call can be written to a file, such as tx_proposal.json, and then copied to the USB.curl -s localhost:9090/wallet \ -d '{ "method": "build_transaction", "params": { "account_id": "a8c9c7acb96cf4ad9154eec9384c09f2c75a340b441924847fe5f60a41805bde", "recipient_public_address": "CaE5bdbQxLG2BqAYAz84mhND79iBSs13ycQqN8oZKZtHdr6KNr1DzoX93c6LQWYHEi5b7YLiJXcTRzqhDFB563Kr1uxD6iwERFbw7KLWA6", "value": "42000000000000" } }' \ -X POST -H 'Content-type: application/json' | jq '.result' > /keyfs/tx_proposal.json cp /keyfs/tx_proposal.json /media/
-
ONLINE MACHINE and USB: Copy the tx_proposal to the online machine.
cp /media/tx_proposal.json ./
-
ONLINE MACHINE: Submit transaction to consensus, using the
submit_transaction
endpoint.
See CONTRIBUTING.
To add or edit tables:
- Ensure that you have
diesel_cli
installed and that it is using the current sqlite version:cargo install --git="https://github.com/mobilecoinofficial/diesel" --rev="22a4a4b973db2b7aadaf088b3279dbbe52176896" diesel_cli --no-default-features --features sqlite
cd full-service
- Create a migration with
diesel migration generate <migration_name>
- Edit the migrations/<migration_name>/up.sql and down.sql.
- Run the migration with
diesel migration run --database-url /tmp/db.db
, and test delete withdiesel migration redo --database-url /tmp/db.db
Note that full-service/diesel.toml provides the path to the schema.rs which will be updated in a migration.
SGX_MODE=HW \
IAS_MODE=DEV \
CONSENSUS_ENCLAVE_CSS=$(pwd)/consensus-enclave.css \
cargo test
Note: providing the CONSENSUS_ENCLAVE_CSS
allows us to bypass the enclave build.
RUST_LOG=info \
SGX_MODE=HW \
IAS_MODE=DEV \
CONSENSUS_ENCLAVE_CSS=$(pwd)/consensus-enclave.css \
cargo clippy --all --all-features