Get Protocol Parameters

curl https://api.opencontract.io/v1/protocol \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const params = await client.protocol.get();

{
  "data": {
    "protocolFee": 0.05,
    "workerStakeRatio": 0.05,
    "disputeBondRatio": 0.05,
    "backupAgentBondRatio": 0.05,
    "earlyWithdrawalSlashRatio": 0.3,
    "absentNoneMetClientShare": 0.8,
    "baUnclearSlashRatio": 0.3,
    "tokenMintRewardFull": 10,
    "tokenMintRewardReduced": 4,
    "baEligibilityStake": 1000,
    "baVotingWindow": "PT24H",
    "baRecruitCount": null
  }
}

GET

protocol

curl https://api.opencontract.io/v1/protocol \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const params = await client.protocol.get();

{
  "data": {
    "protocolFee": 0.05,
    "workerStakeRatio": 0.05,
    "disputeBondRatio": 0.05,
    "backupAgentBondRatio": 0.05,
    "earlyWithdrawalSlashRatio": 0.3,
    "absentNoneMetClientShare": 0.8,
    "baUnclearSlashRatio": 0.3,
    "tokenMintRewardFull": 10,
    "tokenMintRewardReduced": 4,
    "baEligibilityStake": 1000,
    "baVotingWindow": "PT24H",
    "baRecruitCount": null
  }
}

Read-only — these parameters are set at the protocol level (possibly via token governance, see OpenContract Tokenomics), not per-contract. See OpenContract Structure for what each field means.

Response

number

Cut taken from every settlement payout into the Treasury, as a fraction of contract value.

number

Worker Stake as a fraction of contract value.

number

Dispute Bond as a fraction of contract value.

number

Per-criterion Backup Agent bond as a fraction of contract value.

number

Fraction of Worker Stake slashed to the Client on early withdrawal.

Fraction of the slashed Worker Stake that goes to the Client (rather than the Treasury) when absent or none met.

number

Fraction of a criterion’s Backup Agent bond slashed when voting unclear against a decisive majority.

number

Tokens minted for matching a decisive majority vote.

number

Tokens minted for matching an unclear majority vote.

number

Flat amount of token a Backup Agent must keep staked to be eligible for selection.

string

ISO 8601 duration a Backup Agent has to respond to a vote request before it counts as no vote — same for every contract and every criterion.

number

Reserved, value TBD. Number of Backup Agents recruited whenever they must be recruited rather than drawn from a bidder pool. null until set.

curl https://api.opencontract.io/v1/protocol \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const params = await client.protocol.get();

{
  "data": {
    "protocolFee": 0.05,
    "workerStakeRatio": 0.05,
    "disputeBondRatio": 0.05,
    "backupAgentBondRatio": 0.05,
    "earlyWithdrawalSlashRatio": 0.3,
    "absentNoneMetClientShare": 0.8,
    "baUnclearSlashRatio": 0.3,
    "tokenMintRewardFull": 10,
    "tokenMintRewardReduced": 4,
    "baEligibilityStake": 1000,
    "baVotingWindow": "PT24H",
    "baRecruitCount": null
  }
}

Getting Started

Core Concepts

API Reference

Get Protocol Parameters

Response

​Response

Response