Class ViewSchema

constructor

• new ViewSchema(viewArgs): ViewSchema

• Parameters

  • viewArgs: undefined | MichelsonV1Expression[]

  Returns ViewSchema

  Throws

  InvalidScriptError

Readonly instructions

Readonly viewArgsType

Readonly viewName

Readonly viewReturnType

decodeViewResult

• decodeViewResult(val, semantics?): any

• Parameters

  • val: any

    result of the view in JSON Michelson
  • Optional semantics: Semantic

    optional semantics to override the default decoding behavior

  Returns any

  result of the view in a readable format

  Description

  Transform the view result from Michelson to readable data

encodeViewArgs

• encodeViewArgs(args): any

• Parameters

  • args: any

    parameter of the view in js format

  Returns any

  parameter of the view in Michelson

  Description

  Transform the view parameter into Michelson

  Throws

  ParameterEncodingError

extractArgsSchema

• extractArgsSchema(): any

• Returns any

  Description

  Return the signature of the view parameter

extractResultSchema

• extractResultSchema(): any

• Returns any

  Description

  Return the format of the view result

Static fromRPCResponse

• fromRPCResponse(val): ViewSchema[]

• Parameters

  • val: {
        script: ScriptedContracts;
    }

    contract script obtained from the RPC

    • script: ScriptedContracts

  Returns ViewSchema[]

  array of ViewSchema or empty array if there is no view in the contract

  Description

  Create an instance of ViewSchema for each view in a script

  Throws

  InvalidScriptError