Skip to content

Latest commit

 

History

History
182 lines (154 loc) · 4.55 KB

README.md

File metadata and controls

182 lines (154 loc) · 4.55 KB
Raw

valid-ator

Protocol data structures

Validator adresses

Use the owners field to select deployment phase using the valid-ator's address.

stage: x0cuVieEDTFjtxI5m5i22u2IMr-WpBiTS-Vir8U3dbw
live: 53E8wWz8XkP9pGDQrgTi69GLAzZ6geX8bJckcifBr1Q

Querying for protocol data

  • Use graphQL to query Arweave - https://arweave.net/graphql

  • Fetch most recent transaction (change Entity-Type to match protocol data type)

query {
  transactions(
    first:1,
    tags:[
      {
          name: "Protocol",
          values: ["ator"]
      },
      {
        name: "Entity-Type",
        values: ["validation/stats"]
      }
    ],
    owners: ["53E8wWz8XkP9pGDQrgTi69GLAzZ6geX8bJckcifBr1Q"]
  ){
    edges {
      node {
        id
        tags {
            name
            value
        }
      }
    }
  }
}

Tags

Protocol: 'ator'
Protocol-Version: '0.2'
Content-Type: 'application/json'
Content-Timestamp: <string number of milliseconds elapsed since midnight, January 1, 1970 UTC>
Entity-Type: <string with the type of entities stored in the datafile>

Entity types and data format

  • Entity-Type: relay/metrics - contains an array of objects with relay verification results and associated relay metrics observed during the verification process.
{
    result: 'OK' | 'AlreadyVerified' | 'AlreadyRegistered' | 'Failed'
    relay: {
        fingerprint: string (required)
        ator_address: string (required)
        consensus_weight: number (optional, default: 0)
        consensus_weight_fraction: number (optional, default: 0)
        observed_bandwidth: number (optional, default: 0)
        running: boolean (optional, default: false)
    }
}
  • Entity-Type: relay/hex-map - contains an array with objects identified with with H3 cell id and carrying relay counts for the region. View live sample
[
  {
    h3cell: string (required),
    claimable: number,
    verified: number,
    running: number,
    running_verified: number
  },
  
  ...
]
  • Entity-Type: validation/stats - contains an object detailing the metrics of the relay verification process. View live sample
{
    consensus_weight: number (required)
    consensus_weight_fraction: number (required)
    observed_bandwidth: number (required)
    verification: {
        failed: number (required)
        unclaimed: number (required)
        verified: number (required)
        running: number (required)
    }
    verified_and_running: {
            consensus_weight: number (required)
            observed_bandwidth: number (required)
            consensus_weight_fraction: number (required)
    }
}
  • Entity-Type: distribution/summary - contains summary for a previous distribution round. Most fields are also exposed as tags on the transaction, so downloading the json blob itself is not necessary unless per-fingerprint details are desired. These tags and their values are in the GQL results. View live sample
{
  timeElapsed: string
  tokensDistributedPerSecond: string
  baseNetworkScore: string
  baseDistributedTokens: string
  bonuses: {
    hardware: {
      enabled: boolean
      tokensDistributedPerSecond: string
      networkScore: string
      distributedTokens: string
    }
  }
  multipliers: {
    family: {
      enabled: boolean
      familyMultiplierRate: string
    }
  }
  families: { [fingerprint in Fingerprint as string]: Fingerprint[] }
  totalTokensDistributedPerSecond: string
  totalNetworkScore: string
  totalDistributedTokens: string
  details: {
    [fingerprint: Fingerprint]: {
      address: EvmAddress
      score: string
      distributedTokens: string
      bonuses: {
        hardware: string
      }
      multipliers: {
        family: string
        region: string
      }
    }
  }
}

CLI

Seeding Relay Sale Data

  • Seed Relay Sale Data
npm run cli -- seed relay-sale-data -d <path-to-relay-sale-data.csv>
  • Remove Relay Sale Data
npm run cli -- seed relay-sale-data -d <path-to-relay-sale-data.csv> down

Development

  1. TLS CA key - export NODE_EXTRA_CA_CERTS=$(pwd)/admin-ui-ca.crt

  2. Redis queues - docker run --name validator_dev_redis -p 6379:6379 redis:7.2

  3. MongoDB store - docker run --name validator_dev_mongo -p 27017:27017 mongo:5.0

  4. Dependencies - npm install

  5. Testing - npm test -- --watch

  6. Running - npm run start:dev

deploy!