Class Schema

constructor

• new Schema(val: MichelsonV1Expression): Schema

  Parameters

  • val: MichelsonV1Expression

  Returns Schema

[schemaTypeSymbol]

Readonlyval

Encode

• Encode(value?: any, semantics?: SemanticEncoding): any

  Parameters

  • Optionalvalue: any
  • Optionalsemantics: SemanticEncoding

  Returns any

  Throws

  TokenValidationError

  Throws

  StorageEncodingError

EncodeBigMapKey

• EncodeBigMapKey(
      key: BigMapKeyType,
  ): {
      key: { [key: string]: string | object[] };
      type: { args?: object[]; prim: string };
  }

  Parameters

  • key: BigMapKeyType

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

  Throws

  InvalidBigMapSchemaError

  Throws

  BigMapEncodingError

Execute

• Execute(val: any, semantics?: Semantic): any

  Parameters

  • val: any
  • Optionalsemantics: Semantic

  Returns any

ExecuteOnBigMapDiff

• ExecuteOnBigMapDiff(diff: any[], semantics?: Semantic): any

  Parameters

  • diff: any[]
  • Optionalsemantics: Semantic

  Returns any

  Throws

  InvalidBigMapSchemaError

  Throws

  InvalidBigMapDiffError

ExecuteOnBigMapValue

• ExecuteOnBigMapValue(key: any, semantics?: Semantic): any

  Parameters

  • key: any
  • Optionalsemantics: Semantic

  Returns any

  Throws

  InvalidBigMapSchemaError

FindFirstInTopLevelPair

• FindFirstInTopLevelPair<T extends MichelsonV1Expression>(
      storage: any,
      valueType: any,
  ): T | undefined

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

  Type Parameters

  • T extends MichelsonV1Expression

  Parameters

  • storage: any

    storage to parse to find the value

  • valueType: any

    type of value to look for

  Returns T | undefined

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

findToken

• findToken(tokenToFind: string): Token[]

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

  Parameters

  • tokenToFind: string

    string representing the prim property of the token to find

  Returns Token[]

  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');
  Copy

generateSchema

• generateSchema(): TokenSchema

  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

Typecheck

• Typecheck(val: any): boolean

  Validates that a value matches the schema type. Performs type checking with special handling for BigMap, Ticket, and nested Map tokens.

  Parameters

  • val: any

    The value to validate against the schema

  Returns boolean

  Returns true if validation passes, false if validation fails

StaticfromRPCResponse

• fromRPCResponse(val: { script: ScriptedContracts }): Schema

  Parameters

  • val: { script: ScriptedContracts }

  Returns Schema

  Throws

  InvalidRpcResponseError

StaticisSchema

• isSchema(obj: Schema): boolean

  Parameters

  • obj: Schema

  Returns boolean