ds-sam-sdk

SDK for Marinade's DS-SAM - max yield - auction evaluation tool.

SDK Configuration

{
  // Fetch source data from APIs or from local files
  inputsSource: 'APIS' | 'FILES'
  // Directory where to write/read input data (optional)
  inputsCacheDirPath?: string
  // Whether to cache input data (optional)
  cacheInputs?: boolean

  // Base URL of the API to get validators info from
  validatorsApiBaseUrl: string
  // Base URL of the API to get bonds from
  bondsApiBaseUrl: string
  // Base URL of the API to get TVL info from
  tvlInfoApiBaseUrl: string
  // Base URL of the API to get blacklist from
  blacklistApiBaseUrl: string
  // Base URL of the API to get snapshots from
  snapshotsApiBaseUrl: string
  // Base URL of the scoring API
  scoringApiBaseUrl: string
  // The base URL for the location of the overrides json
  overridesApiBaseUrl: string

  // How many epochs in the past to fetch rewards for
  rewardsEpochsCount: number
  // How many epochs in the past to validators uptimes for
  validatorsUptimeEpochsCount: number
  // Threshold of minimal validator uptime to be eligible (e.g. 0.8 for 80%)
  validatorsUptimeThresholdDec: number
  // Validators client version definition to be eligible
  validatorsClientVersionSemverExpr: string
  // Max effective commission of a validator to be eligible
  validatorsMaxEffectiveCommissionDec: number

  // How many historical bids to consider when deciding how much to charge for
  // the BidTooLowPenalty
  bidTooLowPenaltyHistoryEpochs: number

  // Cap of Marinade stake share in a single country
  maxMarinadeStakeConcentrationPerCountryDec: number
  // Cap of Marinade stake share with a single ASO
  maxMarinadeStakeConcentrationPerAsoDec: number
  // Cap of global stake share in a single country
  maxNetworkStakeConcentrationPerCountryDec: number
  // Cap of global stake share with a single ASO
  maxNetworkStakeConcentrationPerAsoDec: number
  // Cap of Marinade stake share on a single validator
  maxMarinadeTvlSharePerValidatorDec: number

  // The minimal bond balance to have to get and retain any stake
  minBondBalanceSol: number

  // Minimum commission a validator can set on bonds.
  // Prevents validators from setting excessively negative commissions.
  // This is expected to be a negative value, allowing a validator to share
  // additional rewards beyond 100%, but protecting against accidental overcommitment.
  minimalCommission: number

  // Multiplier for bond balance requirements when calculating stake caps constraints.
  // We assume some bond balance for the stake is required and multiply the calculated bond requirement
  // by this factor must be in interval [1.0, 2.0].
  bondObligationSafetyMult: number

  // Validator vote accounts to collect debug info for
  debugVoteAccounts: string[]

  // Whether and how verbose to print logs during auction processing
  logVerbosity: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR
}