Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Delegate

A delegate is an account to which another account has delegated their baking and endorsement rights.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Delegate(type: null | AccountTypeParameter, alias: null | string, address: null | string, publicKey: null | string, revealed: boolean, balance: number, frozenDeposits: number, frozenRewards: number, frozenFees: number, counter: number, delegate: any, delegationLevel: null | number, delegationTime: null | Date, stakingBalance: number, numContracts: number, numDelegators: number, numBlocks: number, numEndorsements: number, numBallots: number, numProposals: number, numActivations: number, numDoubleBaking: number, numDoubleEndorsing: number, numNonceRevelations: number, numRelevationPenalties: number, numDelegations: number, numOriginations: number, numTransactions: number, numReveals: number, numMigrations: number, firstActivity: null | number, firstActivityTime: null | Date, lastActivity: null | number, lastActivityTime: null | Date, contracts: null | Contract[], operations: null | Operation[], metadata: any, software: null | ShortSoftware): Delegate
  • internal

    Parameters

    • type: null | AccountTypeParameter
    • alias: null | string
    • address: null | string
    • publicKey: null | string
    • revealed: boolean
    • balance: number
    • frozenDeposits: number
    • frozenRewards: number
    • frozenFees: number
    • counter: number
    • delegate: any
    • delegationLevel: null | number
    • delegationTime: null | Date
    • stakingBalance: number
    • numContracts: number
    • numDelegators: number
    • numBlocks: number
    • numEndorsements: number
    • numBallots: number
    • numProposals: number
    • numActivations: number
    • numDoubleBaking: number
    • numDoubleEndorsing: number
    • numNonceRevelations: number
    • numRelevationPenalties: number
    • numDelegations: number
    • numOriginations: number
    • numTransactions: number
    • numReveals: number
    • numMigrations: number
    • firstActivity: null | number
    • firstActivityTime: null | Date
    • lastActivity: null | number
    • lastActivityTime: null | Date
    • contracts: null | Contract[]
    • operations: null | Operation[]
    • metadata: any
    • software: null | ShortSoftware

    Returns Delegate

Properties

Readonly address

address: null | string

Readonly alias

alias: null | string

Readonly balance

balance: number

Readonly contracts

contracts: null | Contract[]

Readonly counter

counter: number

Readonly delegate

delegate: any

Readonly delegationLevel

delegationLevel: null | number

Readonly delegationTime

delegationTime: null | Date

Readonly firstActivity

firstActivity: null | number

Readonly firstActivityTime

firstActivityTime: null | Date

Readonly frozenDeposits

frozenDeposits: number

Readonly frozenFees

frozenFees: number

Readonly frozenRewards

frozenRewards: number

Readonly lastActivity

lastActivity: null | number

Readonly lastActivityTime

lastActivityTime: null | Date

Readonly metadata

metadata: any

Readonly numActivations

numActivations: null | number

Readonly numBallots

numBallots: number

Readonly numBlocks

numBlocks: number

Readonly numContracts

numContracts: null | number

Readonly numDelegations

numDelegations: null | number

Readonly numDelegators

numDelegators: number

Readonly numDoubleBaking

numDoubleBaking: number

Readonly numDoubleEndorsing

numDoubleEndorsing: number

Readonly numEndorsements

numEndorsements: number

Readonly numMigrations

numMigrations: null | number

Readonly numNonceRevelations

numNonceRevelations: number

Readonly numOriginations

numOriginations: null | number

Readonly numProposals

numProposals: number

Readonly numRelevationPenalties

numRelevationPenalties: number

Readonly numReveals

numReveals: null | number

Readonly numTransactions

numTransactions: null | number

Readonly operations

operations: null | Operation[]

Readonly publicKey

publicKey: null | string

Readonly revealed

revealed: boolean

Readonly software

software: null | ShortSoftware

Readonly stakingBalance

stakingBalance: number

Readonly type

type: null | AccountTypeParameter

Methods

toString

  • toString(): null | string

Static byAddress

  • byAddress(address: string, domain?: string): Promise<Delegate>

  • Returns a delegate with the specified address from tzKT.

    see

    get delegate by address.

    example

    Fetching Delegate Count

    Usage

     
    let address: string = 'tz1VA615KkeXTfZVAxsjAXfnozt3gMzYk8Zv';
let delegate: Delegate = await Delegate.byAddress(address);

    Parameters

    • address: string
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<Delegate>

    Returns a delegate with the specified address.

Static count

  • count(active?: boolean, domain?: string): Promise<number>

  • Fetches a number of delegate accounts from tzKT.

    see

    get delegates count.

    example

    Fetching Delegate Count

    Usage

    Filter by Active Status

     
    let activeDelegateCount: number = await Delegate.count(true);
let inactiveDelegateCount: number = await Delegate.count(false);
let allDelegateCount: number = await Delegate.count();

    Parameters

    • Optional active: boolean
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<number>

    Returns a number of delegate accounts.

Static fromAPI

Static get

Generated using TypeDoc