UNPKG

@rsksmart/rif-storage-pinning

Version:

Application for providing your storage space to other to use in exchange of RIF Tokens

1 lines 8.01 kB
{"version":"0.2.4","commands":{"agreements":{"id":"agreements","description":"Agreements info","pluginName":"@rsksmart/rif-storage-pinning","pluginType":"core","aliases":[],"examples":["$ rif-pinning agreements","$ rif-pinning agreements --db myOffer.sqlite","$ rif-pinning agreements --ls -f active","$ rif-pinning agreements --ls -f inactive","$ rif-pinning agreements --ls -f inactive -p pinned","$ rif-pinning agreements --ls -f active -p not-pinned"],"flags":{"db":{"name":"db","type":"option","char":"d","description":"Name or path to DB file","required":false},"config":{"name":"config","type":"option","description":"path to JSON config file to load"},"log":{"name":"log","type":"option","description":"what level of information to log","options":["error","warn","info","verbose","debug"],"default":"info"},"skipPrompt":{"name":"skipPrompt","type":"boolean","description":"Answer yes for any prompting","allowNo":false},"log-filter":{"name":"log-filter","type":"option","description":"what components should be logged (+-, chars allowed)"},"log-path":{"name":"log-path","type":"option","description":"log to file, default is STDOUT"},"network":{"name":"network","type":"option","char":"n","description":"specifies to which network is the provider connected","options":["testnet","mainnet"]},"status":{"name":"status","type":"option","char":"s","description":"Filter by status","options":["active","inactive"]},"pinningStatus":{"name":"pinningStatus","type":"option","char":"p","description":"Filter by pinning status","options":["running","backoff","created","finished","errored"]}},"args":[]},"cleanup":{"id":"cleanup","description":"Cleanup pinner files","pluginName":"@rsksmart/rif-storage-pinning","pluginType":"core","aliases":[],"examples":["$ rif-pinning cleanup","$ rif-pinning cleanup --db myOffer.sqlite","$ rif-pinning cleanup --unpin"],"flags":{"db":{"name":"db","type":"option","char":"d","description":"Name or path to DB file","required":false},"config":{"name":"config","type":"option","description":"path to JSON config file to load"},"log":{"name":"log","type":"option","description":"what level of information to log","options":["error","warn","info","verbose","debug"],"default":"info"},"skipPrompt":{"name":"skipPrompt","type":"boolean","description":"Answer yes for any prompting","allowNo":false},"log-filter":{"name":"log-filter","type":"option","description":"what components should be logged (+-, chars allowed)"},"log-path":{"name":"log-path","type":"option","description":"log to file, default is STDOUT"},"unpin":{"name":"unpin","type":"boolean","char":"u","description":"Unpin all files","allowNo":false}},"args":[]},"daemon":{"id":"daemon","description":"Run pinning service","pluginName":"@rsksmart/rif-storage-pinning","pluginType":"core","aliases":[],"examples":["$ rif-pinning daemon --strategy=blockchain --provider 'ws://localhost:8546' --ipfs '/ip4/127.0.0.1/tcp/5001' --network testnet","","$ rif-pinning daemon --strategy=marketplace --ipfs 'http://localhost:5001' --network testnet"],"flags":{"db":{"name":"db","type":"option","char":"d","description":"Name or path to DB file","required":false},"config":{"name":"config","type":"option","description":"path to JSON config file to load"},"log":{"name":"log","type":"option","description":"what level of information to log","options":["error","warn","info","verbose","debug"],"default":"info"},"skipPrompt":{"name":"skipPrompt","type":"boolean","description":"Answer yes for any prompting","allowNo":false},"log-filter":{"name":"log-filter","type":"option","description":"what components should be logged (+-, chars allowed)"},"log-path":{"name":"log-path","type":"option","description":"log to file, default is STDOUT"},"network":{"name":"network","type":"option","char":"n","description":"specifies to which network is the provider connected","options":["testnet","mainnet"]},"provider":{"name":"provider","type":"option","char":"p","description":"URL to blockchain node or Marketplace server"},"strategy":{"name":"strategy","type":"option","description":"what type of provider will be used for listening on events. Default is \"marketplace\". For blockchain you have to have access to a node that has allowed eth_getLogs call.","options":["marketplace","blockchain"],"default":"marketplace"},"ipfs":{"name":"ipfs","type":"option","description":"specifies a connection URL to IPFS node. Default is go-ipfs listening configuration."}},"args":[]},"db-migration":{"id":"db-migration","description":"DB migration","pluginName":"@rsksmart/rif-storage-pinning","pluginType":"core","aliases":[],"examples":["$ rif-pinning db-migration --up","$ rif-pinning db-migration --down","$ rif-pinning db-migration --up --to 0-test","$ rif-pinning db-migration --up --migration 01-test --migration 02-test","$ rif-pinning db-migration --up --db ./test.sqlite --to 09-test","$ rif-pinning db-migration --down --db ./test.sqlite --to 09-test","$ rif-pinning db-migration --generate my_first_migration"],"flags":{"db":{"name":"db","type":"option","char":"d","description":"Name or path to DB file","required":false},"config":{"name":"config","type":"option","description":"path to JSON config file to load"},"log":{"name":"log","type":"option","description":"what level of information to log","options":["error","warn","info","verbose","debug"],"default":"info"},"skipPrompt":{"name":"skipPrompt","type":"boolean","description":"Answer yes for any prompting","allowNo":false},"log-filter":{"name":"log-filter","type":"option","description":"what components should be logged (+-, chars allowed)"},"log-path":{"name":"log-path","type":"option","description":"log to file, default is STDOUT"},"up":{"name":"up","type":"boolean","char":"u","description":"Migrate DB","allowNo":false},"down":{"name":"down","type":"boolean","char":"d","description":"Undo db migration","allowNo":false},"generate":{"name":"generate","type":"option","char":"d","description":"Generate migrations using template [--generate=migration_name]"},"to":{"name":"to","type":"option","char":"t","description":"Migrate to"},"migration":{"name":"migration","type":"option","char":"m","description":"Migration file"}},"args":[]},"init":{"id":"init","description":"Initialize Pinner service dependencies","pluginName":"@rsksmart/rif-storage-pinning","pluginType":"core","aliases":[],"examples":["$ rif-pinning init","$ rif-pinning init --offerId 0x123 --db ./relativeOrAbsolutePath/db.sqlite","$ rif-pinning init --db fileName.sqlite","$ rif-pinning init --db ./folder"],"flags":{"db":{"name":"db","type":"option","char":"d","description":"Name or path to DB file","required":false},"config":{"name":"config","type":"option","description":"path to JSON config file to load"},"log":{"name":"log","type":"option","description":"what level of information to log","options":["error","warn","info","verbose","debug"],"default":"info"},"skipPrompt":{"name":"skipPrompt","type":"boolean","description":"Answer yes for any prompting","allowNo":false},"log-filter":{"name":"log-filter","type":"option","description":"what components should be logged (+-, chars allowed)"},"log-path":{"name":"log-path","type":"option","description":"log to file, default is STDOUT"},"network":{"name":"network","type":"option","char":"n","description":"specifies to which network is the provider connected","options":["testnet","mainnet"]},"offerId":{"name":"offerId","type":"option","char":"o","description":"ID of Offer to which should the service listen to","required":false},"keyType":{"name":"keyType","type":"option","char":"t","description":"Type of private key that will be used for Peer Identity","options":["rsa","ed25519","secp256k1"],"default":"rsa"},"keySize":{"name":"keySize","type":"option","char":"s","description":"Size of private key that will be used for Peer Identity","default":2048},"override-db":{"name":"override-db","type":"boolean","description":"Skip the prompt when database exists with used value --override-db/--no-override-db","allowNo":true}},"args":[]}}}