Class Schema

constructor

• new Schema(val): Schema

• Parameters

  • val: MichelsonV1Expression

  Returns Schema

[schemaTypeSymbol]

Readonly val

ComputeState

• ComputeState(tx, state): any

• Parameters

  • tx: RpcTransaction[]
  • state: any

  Returns any

  Deprecated

  Throws

  InvalidBigMapSchemaError

Encode

• Encode(value?, semantics?): any

• Parameters

  • Optional value: any
  • Optional semantics: SemanticEncoding

  Returns any

  Throws

  TokenValidationError

  Throws

  StorageEncodingError

EncodeBigMapKey

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

• Parameters

  • key: BigMapKeyType

  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

  Throws

  InvalidBigMapSchemaError

  Throws

  BigMapEncodingError

Execute

• Execute(val, semantics?): any

• Parameters

  • val: any
  • Optional semantics: Semantic

  Returns any

ExecuteOnBigMapDiff

• ExecuteOnBigMapDiff(diff, semantics?): any

• Parameters

  • diff: any[]
  • Optional semantics: Semantic

  Returns any

  Throws

  InvalidBigMapSchemaError

  Throws

  InvalidBigMapDiffError

ExecuteOnBigMapValue

• ExecuteOnBigMapValue(key, semantics?): any

• Parameters

  • key: any
  • Optional semantics: Semantic

  Returns any

  Throws

  InvalidBigMapSchemaError

ExtractSchema

• ExtractSchema(): any

• Returns any

  Deprecated

  ExtractSchema has been deprecated in favor of generateSchema

FindFirstInTopLevelPair

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

• Type Parameters

  • T extends MichelsonV1Expression

  Parameters

  • storage: any

    storage to parse to find the value
  • valueType: any

    type of value to look for

  Returns undefined | T

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

  Description

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

Typecheck

• Typecheck(val): void

• Parameters

  • val: any

  Returns void

findToken

• findToken(tokenToFind): 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

  Description

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

  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

• Returns TokenSchema

  Description

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

Static fromRPCResponse

• fromRPCResponse(val): Schema

• Parameters

  • val: {
        script: ScriptedContracts;
    }

    • script: ScriptedContracts

  Returns Schema

  Throws

  InvalidRpcResponseError

Static isSchema

• isSchema(obj): boolean

• Parameters

  • obj: Schema

  Returns boolean