Interface with a Replicator Contract

WARNING: The API is not stable yet and is subject to change.

Description

Is command set implementing ContractReplicator which is a part of DFMSR API which is responsible for creating and managing SuperContracts and their state, contracts, etc. The API extends DFMS ContractClient API with features related to replicating Drive and accepting Drive contracts.

Child commands

CommandDescription
dfms-replicator contract composecompose new Drive Contract
dfms-replicator contract lslists all the SuperContracts in which Node participates as an owner or member
dfms-replicator contract getget Contract body of any Drive in the network
dfms-replicator contract ammendssubscribe for Drive Contract updates
dfms-replicator contract acceptaccept Drive Contract
dfms-replicator contract acceptedsubscribe for newly accepted Drive Contracts of the node
dfms-replicator contract invitessubscribe for Drive Contract invites
dfms-replicator contract acceptingautomatically accept every received invitation

dfms-replicator contract compose

This command composes Contract for new Drive between current DFMS node and multiple DFMSR nodes with conditions to store space amount of data for subscription time period.

First of all, a Contract invitation is built from configured arguments and options. This invitation broadcasted throughout the network. Then, Storage Replicator Nodes receive the invitation and decide to accept it or not. Their decision is based on the configured fields. The composing, at the same moment, awaits the configured amount of Storage Replicator Nodes to accept invitations. If throughout 10 minutes the minimal amount of Storage Replicator Nodes do not accept the invitation - composing fails. In another case, it succeeds. From that moment new Drive is considered to be created.

Arguments

NameDescription
spacerequired space (in MB)
durationDrive duration (in month)

Options

NameDescription
replicas(r)to set the amount of Drive replicas. One replica = one Storage Replicator Node. The default is 3
min-replicators(mr)to set a minimum amount of joined Storage Replicator Node for composing to succeed. The default is 3
subscription-price(p)to set a price in tokens for one subscription period. The default is space * replicas
number-subscription-periods(sn)to set number of desired subscriptions. The default is 3
percent-approvers(pa)to set percent of Storage Replicator Node needed to come up to consensus to proceed any Drive account related action
private-key(key)to set a custom private key to generate Drive account from
helpto see description with examples

Examples

  • Create a new contract with the needed parameters:

    $ dfms-replicator contract compose 1000 1 \        # size & duration
                --replicas=5 \
                --min-replicators=3 \
                --billing-price=5000 \
                --billing-period=1 \  
                --percent-approvers=67
{
  "drive": "baegaajaiaqjcahaxr4ry4styn74ronvr2nvfdmgxtrzyhsci2xqpw5eisrisrgn5",
  "owner": "080412200eb448d07c7ccb312989ac27aa052738ff589e2f83973f909b506b450dc5c4e2",
  "replicators": [
          "0804122068f50e10e5b8be2b7e9ddb687a667d6e94dd55fe02b4aed8195f51f9a242558b",
          "0804122073472a2e9dcea5c2a36eb7f6a34a634010391ec89e883d67360db16f28b9443c",
          "08041220d03918e35573c66578b5a0eed723fe2a46208783e13498751d9315115ca06d4b"
  ],
  "root": "QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn",
  "created": 741,
  "duration": 1,
  "space": 1000,
  "replicas": 5,
  "minReplicators": 3,
  "percentApprovers": 67,
  "billingPrice": 5000,
  "billingPeriod": 1
}

dfms-replicator contract ls

Lists all the SuperContracts in which Node participates as an owner or member.

Examples

  • Get client drives:

    $ dfms-replicator contract ls
baegaajaiaqjca7fnnbv2od5i3uo2zdvruvp2uvbiaoqhnbwqv7tpy6qkbmip7622
baegaajaiaqjcaedinbn4fbtawhvbgmuxv2uklfxabf5ughaii2jbp2vtw2z34cb5
baegaajaiaqjcafssfchukjl77zijwpneyrv5wec7u4yj6f5fqiusqwlas5f4unpd
baegaajaiaqjcah6g44hvl2dcdi7dt4bmlv6uus44eqemz7xdsyy7nrwvm5zormk7
baegaajaiaqjcahzmkrwaftgj47wnao4xqtwjvlizj3ujhz7sd42jhnapjqkc3hmv
baegaajaiaqjcan6rv7ozao7uujwruvm2savlnqyzrb2zq6w2kyvb3djluxnkwh4x
baegaajaiaqjcapacmgyuibklcyxxpkae53fyqsi4fz2ijyfcugl5ze4nvnsscw7z
baegaajaiaqjcat75mpp2lein7cpnu2lw6tho2fn22seasqpzentlnzwpuhz5a4s3
baegaajaiaqjcatslsbbgzdzdx7pdcyawnyrefhsn3s6bwbunrp53xggsifs6yat7
baegaajaiaqjcb47kcxrlqf2lef633v2biondhhje3pguoxtfj22rkkmyvlf43jxn
baegaajaiaqjcb4c53l5t3gcnjehbgvkptb3gnw3qbwq5l2uzuzmarm5snihrz5s2

dfms-replicator contract get

get prints a Contract body of any drive from the network. Takes it from local storage or fetches from the network.

Arguments

NameDescription
driveDrive ID

Examples

  • Get contact by Drive ID:

    $ dfms-replicator contract get baegaajaiaqjcahaxr4ry4styn74ronvr2nvfdmgxtrzyhsci2xqpw5eisrisrgn5
{
  "drive": "baegaajaiaqjcahaxr4ry4styn74ronvr2nvfdmgxtrzyhsci2xqpw5eisrisrgn5",
  "owner": "080412200eb448d07c7ccb312989ac27aa052738ff589e2f83973f909b506b450dc5c4e2",
  "replicators": [
          "0804122068f50e10e5b8be2b7e9ddb687a667d6e94dd55fe02b4aed8195f51f9a242558b",
          "0804122073472a2e9dcea5c2a36eb7f6a34a634010391ec89e883d67360db16f28b9443c",
          "08041220d03918e35573c66578b5a0eed723fe2a46208783e13498751d9315115ca06d4b"
  ],
  "root": "QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn",
  "created": 741,
  "duration": 1,
  "space": 1000,
  "replicas": 3,
  "minReplicators": 3,
  "percentApprovers": 67,
  "billingPrice": 5000,
  "billingPeriod": 1
}

dfms-replicator contract ammends

contract ammends subscribes for Contract amendments of drive. Produced either from owner or Storage Replicator Node consensus.

Arguments

NameDescription
driveDrive ID

Examples

  • Start listen to amendments of some drive:

    $ dfms-replicator contract ammends baegaajaiaqjcahaxr4ry4styn74ronvr2nvfdmgxtrzyhsci2xqpw5eisrisrgn5

dfms-replicator contract accept

Joins drive by it's id. Can join only SuperContracts awaiting new members.

Arguments

NameDescription
driveDrive ID

Examples

  • Accept a contract by ID:

    $ dfms-replicator contract accept baegaajaiaqjcahaxr4ry4styn74ronvr2nvfdmgxtrzyhsci2xqpw5eisrisrgn5

dfms-replicator contract accepted

Subscribes for newly accepted Driver Contracts of the node, either accepted automatically or manually.

Examples

  • Show accepted contracts:

    $ dfms-replicator contract accepted

dfms-replicator contract invites

Subscribes for Drive Contract invitation published on the network to be accepted or not.

Examples

  • Show invites:

    $ dfms-replicator contract invites

dfms-replicator contract accepting

WARNING: This command will be removed in the next minor release.

Subscribes for new invitations and accepts them automatically, ALL OF THEM WITHOUT ANY DECISION MAKING.

Examples

  • Start accepting:

    $ dfms-replicator contract accepting
"Accepting started."

  • Stop accepting:

    $ dfms-replicator contract accepting
"Accepting stoped."
← dfms-replicator (base command)dfms-replicator net →