Warn

Our current smart contract abstraction feature is currently in preview. It's API is not final, and it may not cover every use case (yet). We will greatly appreciate any feedback on this feature.

Hierarchy

  • Schema

Constructors

Properties

[schemaTypeSymbol]: boolean
bigMap?: any
findValue: any
isExpressionExtended: any
removeTopLevelAnnotation: any
root: any

Methods

  • Parameters

    Returns { key: { [key: string]: string | object[] }; type: { args?: object[]; prim: string } }

    • key: { [key: string]: string | object[] }
      • [key: string]: string | object[]
    • type: { args?: object[]; prim: string }
      • Optional args?: object[]
      • prim: string
  • Parameters

    Returns any

  • Parameters

    • diff: any[]
    • Optional semantics: Semantic

    Returns any

  • Parameters

    Returns any

  • Deprecated

    ExtractSchema has been deprecated in favor of generateSchema

    Returns any

  • Description

    Look up in top-level pairs of the storage to find a value matching the specified type

    Returns

    The first value found that match the type or undefined if no value is found

    Type Parameters

    Parameters

    • storage: any

      storage to parse to find the value

    • valueType: any

      type of value to look for

    Returns undefined | T

  • Parameters

    • val: any

    Returns boolean

  • Description

    Look up the schema to find any occurrence of a particular token.

    Returns

    an array of tokens of the specified kind or an empty array if no token was found

    Example

    Useful to find all global constants in a script, an array of GlobalConstantToken is returned:

    const schema = new Schema(script);
    const allGlobalConstantTokens = schema.findToken('constant');

    Parameters

    • tokenToFind: string

      string representing the prim property of the token to find

    Returns Token[]

  • Description

    Produce a representation of the storage schema. Note: Provide guidance on how to write the storage object for the origination operation with Taquito.

    Returns TokenSchema

  • Parameters

    Returns boolean

Generated using TypeDoc