Skip to main content

Command line interface for the Tezos Bakers Registry

Project description

Bakers Registry client

PyPI version made_with pytezos License: MIT

Console client for the Tezos Bakers Registry

bakers-registry

Decentralized approach

  • Does not depend on a particular indexer: you can choose from several options, or add new one with little efforts
  • Most data is retrieved from a pool of public RPC nodes

Installation

pip install bakers-registry

Requirements

  • python 3.6+
  • pip

Get the current baker config

bakers get BAKER_ADDRESS <flags>

Arguments

  • BAKER_ADDRESS tz-address
  • --output_file=OUTPUT_FILE path to the file to store the data (optional)
  • --raw=RAW keep intermediate data representation (default is False)
  • --network=NETWORK Tezos network (default is mainnet)
  • --registry_address=REGISTRY_ADDRESS address of the registry contract (predefined)

Sample output

{
  "bakerName": "Bake'n'Rolls",
  "openForDelegation": true,
  "bakerOffchainRegistryUrl": "https://bakenrolls.com/registry.json",
  "fee": "0.09",
  "bakerPaysFromAccounts": [
    "tz1Zrqm4TkJwqTxm5TiyVFh6taXG4Wrq7tko"
  ],
  "minDelegation": "10",
  "subtractPayoutsLessThanMin": true,
  "payoutDelay": 6,
  "payoutFrequency": 1,
  "minPayout": "0",
  "bakerChargesTransactionFee": true,
  "paymentConfig": {
    "payForOwnBlocks": true,
    "payForStolenBlocks": true,
    "compensateMissedBlocks": false,
    "payForEndorsements": true,
    "compensateLowPriorityEndorsementLoss": false,
    "compensateMissedEndorsements": false,
    "payGainedFees": true,
    "payForAccusationGains": true,
    "subtractLostDepositsWhenAccused": true,
    "subtractLostRewardsWhenAccused": true,
    "subtractLostFeesWhenAccused": true,
    "payForRevelation": true,
    "subtractLostRewardsWhenMissRevelation": true,
    "subtractLostFeesWhenMissRevelation": true
  },
  "overDelegationThreshold": 100,
  "subtractRewardsFromUninvitedDelegation": true
}
Raw format
{
  "bakerName": "42616b65276e27526f6c6c73",
  "openForDelegation": true,
  "bakerOffchainRegistryUrl": "68747470733a2f2f62616b656e726f6c6c732e636f6d2f72656769737472792e6a736f6e",
  "split": 9100,
  "bakerPaysFromAccounts": [
    "tz1Zrqm4TkJwqTxm5TiyVFh6taXG4Wrq7tko"
  ],
  "minDelegation": 100000,
  "subtractPayoutsLessThanMin": true,
  "payoutDelay": 6,
  "payoutFrequency": 1,
  "minPayout": 0,
  "bakerChargesTransactionFee": true,
  "paymentConfigMask": 16383,
  "overDelegationThreshold": 100,
  "subtractRewardsFromUninvitedDelegation": true,
  "reporterAccount": "tz1Zrqm4TkJwqTxm5TiyVFh6taXG4Wrq7tko"
}

Generate tezos-client command from the config file

bakers set BAKER_ADDRESS INPUT_FILE <flags>

Arguments

  • BAKER_ADDRESS tz-address
  • INPUT_FILE path to the file with configuration (can contain any-level representation)
  • --preview=PREVIEW print resulting config instead of command line (default is False)
  • --network=NETWORK Tezos network (default is mainnet)
  • --registry_address=REGISTRY_ADDRESS address of the registry contract (predefined)

Sample output

transfer 0 from tz1NortRftucvAkD1J58L32EhSVrQEWJCEnB to KT1ChNsEFxwyCbJyWGSL3KdjeXE28AY1Kaog --entrypoint 'set_data' --arg 'Pair "tz1NortRftucvAkD1J58L32EhSVrQEWJCEnB" (Pair (Some (Pair (Pair (Pair 0x42616b65276e27526f6c6c73 True) 0x68747470733a2f2f62616b656e726f6c6c732e636f6d2f72656769737472792e6a736f6e) (Pair (Pair 9100 { "tz1Zrqm4TkJwqTxm5TiyVFh6taXG4Wrq7tko" }) (Pair (Pair (Pair 100000 True) (Pair 6 (Pair 1 0))) (Pair (Pair True 16383) (Pair 100 True)))))) None)'

Create default config

bakers new <flags>

Arguments

  • --output_file=OUTPUT_FILE path to the file to store the data (optional)

Get all bakers data

bakers all OUTPUT_FILE <flags>

Arguments

  • OUTPUT_FILE path to the file
  • --raw=RAW keep intermediate data representation (default is False)
  • --indexer=INDEXER which indexer to use to retrieve operation levels [tzkt, tzstats, conseil]
  • --network=NETWORK Tezos network (default is mainnet)
  • --registry_address=REGISTRY_ADDRESS address of the registry contract (predefined)

Get recent changes

bakers log <flags>

Arguments

  • --output_file=OUTPUT_FILE path to the file
  • --since=SINCE set lower bound, can be level (int) or string "level:700000" "cycle:170"
  • --raw=RAW keep intermediate data representation (default is False)
  • --indexer=INDEXER which indexer to use to retrieve operation levels [tzkt, tzstats, conseil]
  • --network=NETWORK Tezos network (default is mainnet)
  • --registry_address=REGISTRY_ADDRESS address of the registry contract (predefined)

Sample output

738542  Airfoil              subtractLostFeesWhenMissRevelation: true => false
738542  Airfoil              subtractLostRewardsWhenMissRevelation: true => false
738542  Airfoil              payForRevelation: true => false
738542  Airfoil              bakerPaysFromAccounts: [] => ["tz1QH3G2btaWc1vRLNsEfx2gHM7Ad81TeRit"]
738542  Airfoil              bakerOffchainRegistryUrl: "" => "https://airfoil.services/airfoil.json"
738542  Airfoil              openForDelegation: false => true
736381  Crypto Delegate LLC  subtractRewardsFromUninvitedDelegation: true => false
736381  Crypto Delegate LLC  subtractLostFeesWhenMissRevelation: true => false
736381  Crypto Delegate LLC  subtractLostRewardsWhenMissRevelation: true => false
736381  Crypto Delegate LLC  subtractLostFeesWhenAccused: true => false
736381  Crypto Delegate LLC  subtractLostRewardsWhenAccused: true => false
736381  Crypto Delegate LLC  subtractLostDepositsWhenAccused: true => false
736381  Crypto Delegate LLC  compensateMissedEndorsements: false => true
736381  Crypto Delegate LLC  compensateMissedBlocks: false => true
736381  Crypto Delegate LLC  payoutDelay: 6 => 0
736381  Crypto Delegate LLC  subtractPayoutsLessThanMin: true => false
736381  Crypto Delegate LLC  bakerPaysFromAccounts: [] => ["tz1MyXTZmeMCM4yFnrER9LNYDZ9t2rHYDvcH"]
736381  Crypto Delegate LLC  fee: "0.25" => "-80"
736381  Crypto Delegate LLC  bakerOffchainRegistryUrl: "" => "https://www.cryptodelegate.com/files/theme/CDReg.json"
736381  Crypto Delegate LLC  bakerName: "Crypto Delegate" => "Crypto Delegate LLC"
732641  YieldWallet.io       New Baker: tz1Q8QkSBS63ZQnH3fBTiAMPes9R666Rn6Sc
730509  Bake'n'Rolls         minDelegation: "0" => "10"
730226  TezoSteam            minDelegation: "0" => "100"
730226  TezoSteam            bakerPaysFromAccounts: [] => ["tz1YrmJw6Lje27gWqZ94gU9mNavEjkHu1xGc"]
730226  TezoSteam            bakerOffchainRegistryUrl: "" => "https://raw.githubusercontent.com/StakingTeam/TezoSteam/master/info/reg.json"
730151  tezzz                fee: "0.03" => "0.045"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bakers-registry, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size bakers_registry-0.2.1-py3-none-any.whl (11.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size bakers-registry-0.2.1.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page