Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Commitment

Endpoints for fetching Commitments. For more information see the Commitment API documentation on tzKT.

Hierarchy

  • Commitment

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Commitment(address: null | string, balance: number, activated: boolean, activationLevel: null | number, activationTime: null | Date, activatedAccount: any): Commitment
  • internal

    Parameters

    • address: null | string
    • balance: number
    • activated: boolean
    • activationLevel: null | number
    • activationTime: null | Date
    • activatedAccount: any

    Returns Commitment

Properties

activated

activated: boolean

activatedAccount

activatedAccount: any

activationLevel

activationLevel: null | number

activationTime

activationTime: null | Date

address

address: null | string

balance

balance: number

Methods

Static byBlindedAddress

  • byBlindedAddress(address: string, domain?: string): Promise<Commitment>

Static count

  • Fetches a number of commitments from tzKT.

    see

    get commitments count.

    example

    Fetch Commitment Count

    Usage

     
    let parameters: GetCommitmentParameters = {'activated': true, 'balance.gt': 100000000};
let commitmentCount: number = await Commitment.count(parameters);

    Parameters

    Returns Promise<number>

    Returns a number of commitments.

Static fromAPI

Static get

  • Fetches commitments from tzKT.

    see

    get commitments.

    example

    Fetch Commitments

    Usage

     
    let parameters: GetCommitmentParameters = {'activated': true, 'activationLevel.gt': 1500000};
let commitments: Commitment[] = await Commitment.get(parameters);

    Parameters

    Returns Promise<Commitment[]>

    Returns a list of commitments.

Generated using TypeDoc