Skip to content

Commit

Permalink
docs: address feedback in examples and default values
Browse files Browse the repository at this point in the history
  • Loading branch information
hopeyen committed Apr 15, 2024
1 parent b7b060f commit c4cfc0c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/client_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Download a single file (`--manifest-type`) into local file system (`local-files`
$ file-exchange downloader \
--ipfs-hash QmHash \
--manifest-type "File" \
--indexer-endpoints http://localhost:5678,http://localhost:5677 \
--indexer-endpoints http://localhost:5678,http://localhost:7600 \
--free-query-auth-token 'Bearer auth_token' \
--network-subgraph https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum-sepolia \
--escrow-subgraph https://api.thegraph.com/subgraphs/name/graphprotocol/scalar-tap-arbitrum-sepolia \
Expand All @@ -63,7 +63,7 @@ Download a bundle of files into remote object storage bucket (`object_storage`)
```
$ file-exchange downloader \
--ipfs-hash QmHash \
--indexer-endpoints http://localhost:5678,http://localhost:5677 \
--indexer-endpoints http://localhost:5678,http://localhost:7600 \
--mnemonic "seed phrase" \
--verifier 0xfC24cE7a4428A6B89B52645243662A02BA734ECF \
--provider "arbitrum-sepolia-rpc-endpoint" \
Expand Down
2 changes: 1 addition & 1 deletion docs/publisher_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ $ file-exchange publisher \
--file-type flatfiles \
--file-version 0.0.0 \
--description "random flatfiles" \
local-files --output-dir ./example-file/
local-files --main-dir ./example-file/
```

Publishing files/objects stored in a remote s3 bucket
Expand Down
4 changes: 2 additions & 2 deletions docs/server_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Run `sqlx migrate run --source file-service/migrations`

CLI with configuration file
```
cargo run -p file-service -- --config ./file-server/template.toml
cargo run -p file-service -- --config ./template.toml
```

(You might need to set an additional envrionmental variable for logs, `RUST_LOG=file_service=debug`)
Expand Down Expand Up @@ -116,7 +116,7 @@ Curl query will be similar to the above examples, here we provide an example in
```
mutation{
addBundles(deployments:["QmeD3dRVV6Gs84TRwiNj3tLt9mBEMVqy3GoWm7WN8oDzGz", "QmeaPp764FjQjPB66M9ijmQKmLhwBpHQhA7dEbH2FA1j3v"],
locations:["./example-file", "./example-file"]){
locations:["/", "/"]){
ipfsHash
}
}
Expand Down
2 changes: 1 addition & 1 deletion template.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ default_price_per_byte = 1
ipfs_gateway = "https://ipfs.network.thegraph.com"
log_format = "Pretty"
[server.storage_method.LocalFiles]
main_dir = "./../example-file"
main_dir = "./example-file"

[common]
[common.indexer]
Expand Down

0 comments on commit c4cfc0c

Please sign in to comment.