Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BigMap

Endpoints for fetching BigMaps. For more information see the BigMap API documentation on tzKT.

BigMaps are data storage structures on the Tezos blockchain.

Hierarchy

  • BigMap

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BigMap(ptr: number, contract: null | string, path: null | string, tags: null | string[], active: boolean, firstLevel: number, lastLevel: number, totalKeys: number, activeKeys: number, updates: number, keyType: any, valueType: any): BigMap

  • Parameters

    • ptr: number
    • contract: null | string
    • path: null | string
    • tags: null | string[]
    • active: boolean
    • firstLevel: number
    • lastLevel: number
    • totalKeys: number
    • activeKeys: number
    • updates: number
    • keyType: any
    • valueType: any

    Returns BigMap

Properties

Readonly active

active: boolean

Readonly activeKeys

activeKeys: number

Readonly contract

contract: null | string

Readonly firstLevel

firstLevel: number

Readonly keyType

keyType: any

Readonly lastLevel

lastLevel: number

Readonly path

path: null | string

Readonly ptr

ptr: number

Readonly tags

tags: null | string[]

Readonly totalKeys

totalKeys: number

Readonly updates

updates: number

Readonly valueType

valueType: any

Methods

Static byContract

Static byID

  • byID(id: number, micheline?: number, domain?: string): Promise<BigMap>

  • Fetches bigmap by ID from tzKT.

    see

    get bigmap by ID.

    Parameters

    • id: number
    • micheline: number = 0
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<BigMap>

    Returns the bigmap corresponding to the given ID.

Static byName

  • byName(address: string, name: string, micheline?: number, domain?: string): Promise<BigMap>

  • Fetches bigmap by name from tzKT.

    see

    get bigmap by name.

    Parameters

    • address: string
    • name: string
    • micheline: number = 0
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<BigMap>

    Returns the bigmap with the given name

Static fromAPI

Static get

Generated using TypeDoc