Package Exports

@rsksmart/rif-storage-pinning

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rsksmart/rif-storage-pinning) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

RIF Storage.js Pinning service

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

Install
Usage
Contribute
License

Install

npm

> npm install @rsksmart/rif-storage-pinning

Usage

Example of usage:

$ rif-pinning init --offerId=0x123456789
$ rif-pinning --provider='ws://localhost:8546' --ipfs='/ip4/127.0.0.1/tcp/5001' --network=testnet --strategy=blockchain

This will:

initialize pinning service for given Offer
start the daemon of the pinning service
listens only for events for the Offer ID 0x123456789
use blockchain node for listening on events at ws://localhost:8546 that is connected to testnet network
thanks to --network testnet will use predefined deployed smart-contracts on testnet
connects to your locally running IPFS node at /ip4/127.0.0.1/tcp/5001

`rif-pinning agreements`

Agreements info

USAGE
  $ rif-pinning agreements

OPTIONS
  -d, --db=db                                                   Name or path to DB file
  -p, --pinningStatus=running|backoff|created|finished|errored  Filter by pinning status
  -s, --status=active|inactive                                  Filter by status
  --config=config                                               path to JSON config file to load
  --log=error|warn|info|verbose|debug                           [default: error] what level of information to log
  --log-filter=log-filter                                       what components should be logged (+-, chars allowed)
  --log-path=log-path                                           log to file, default is STDOUT
  --skipPrompt                                                  Answer yes for any prompting

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

`rif-pinning cleanup`

Cleanup pinner files

USAGE
  $ rif-pinning cleanup

OPTIONS
  -d, --db=db                          Name or path to DB file
  -u, --unpin                          Unpin all files
  --config=config                      path to JSON config file to load
  --log=error|warn|info|verbose|debug  [default: error] what level of information to log
  --log-filter=log-filter              what components should be logged (+-, chars allowed)
  --log-path=log-path                  log to file, default is STDOUT
  --skipPrompt                         Answer yes for any prompting

EXAMPLES
  $ rif-pinning cleanup
  $ rif-pinning cleanup --db myOffer.sqlite
  $ rif-pinning cleanup --unpin

`rif-pinning daemon`

Run pinning service

USAGE
  $ rif-pinning daemon

OPTIONS
  -d, --db=db                          Name or path to DB file
  -n, --network=testnet|mainnet        specifies to which network is the provider connected
  -p, --provider=provider              URL to blockchain node or Marketplace server
  --config=config                      path to JSON config file to load

  --ipfs=ipfs                          specifies a connection URL to IPFS node. Default is go-ipfs listening
                                       configuration.

  --log=error|warn|info|verbose|debug  [default: error] what level of information to log

  --log-filter=log-filter              what components should be logged (+-, chars allowed)

  --log-path=log-path                  log to file, default is STDOUT

  --skipPrompt                         Answer yes for any prompting

  --strategy=marketplace|blockchain    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.

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 '/ip4/127.0.0.1/tcp/5001' --network testnet

`rif-pinning db-migration`

DB migration

USAGE
  $ rif-pinning db-migration

OPTIONS
  -d, --db=db                          Name or path to DB file
  -d, --down                           Undo db migration
  -d, --generate=generate              Generate migrations using template [--generate=migration_name]
  -m, --migration=migration            Migration file
  -t, --to=to                          Migrate to
  -u, --up                             Migrate DB
  --config=config                      path to JSON config file to load
  --log=error|warn|info|verbose|debug  [default: error] what level of information to log
  --log-filter=log-filter              what components should be logged (+-, chars allowed)
  --log-path=log-path                  log to file, default is STDOUT
  --skipPrompt                         Answer yes for any prompting

EXAMPLES
  $ rif-pinning db --up
  $ rif-pinning db --down
  $ rif-pinning db --up --to 0-test
  $ rif-pinning db --up --migration 01-test --migration 02-test
  $ rif-pinning db --up --db ./test.sqlite --to 09-test
  $ rif-pinning db --down --db ./test.sqlite --to 09-test
  $ rif-pinning db --generate my_first_migration

`rif-pinning help [COMMAND]`

display help for rif-pinning

USAGE
  $ rif-pinning help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`rif-pinning init`

Initialize Pinner service dependencies

USAGE
  $ rif-pinning init

OPTIONS
  -d, --db=db                          Name or path to DB file
  -o, --offerId=offerId                ID of Offer to which should the service listen to
  --config=config                      path to JSON config file to load
  --log=error|warn|info|verbose|debug  [default: error] what level of information to log
  --log-filter=log-filter              what components should be logged (+-, chars allowed)
  --log-path=log-path                  log to file, default is STDOUT
  --skipPrompt                         Answer yes for any prompting

EXAMPLES
  $ rif-pinning init
  $ rif-pinning init --offerId 0x123 --db ./relativeOrAbsolutePath/db.sqlite
  $ rif-pinning init --db fileName.sqlite
  $ rif-pinning init --db ./folder

Environmental variables

Pinning service supports following environmental variables:

RIFS_OFFER (string) - Specifies Offer Id which the Pinning service should listen on. Same like --offerId flag.
RIFS_DB (string) - Specify the name or path to the data base file.
RIFS_NETWORK (testnet|mainnet) - Same like --network flag.
RIFS_PROVIDER (string) - Same like --provider flag.
RIFS_CONFIG (string) - Same like --config flag.
RIFS_CONTRACT_ADDR (string) - Specifies address of smart contract to listen the events from. Mainly for development as this is otherwise configured using --network flag.
RIFS_IPFS (string) - Same like --ipfs flag.
LOG_LEVEL (string) - Same like --log flag.
LOG_FILTER (string) - Same like --log-filter flag.
LOG_PATH (string) - Same like --log-path flag.

Contribute

There are some ways you can make this module better:

Consult our open issues and take on one of them
Help our tests reach 100% coverage!

Development

Requirements:

IPFSv5 and higher
Ganache
Node & NPM

Please on how to set up the development environment see Development guide

Tips

Using the npm run ipfs:consumer and npm run ipfs:provider you can interact with each IPFS node using the standard commands that IPFS supports.
You can interact with the CLI using npm run bin script from the local folder.

License

MIT

@rsksmart/rif-storage-pinning