Class ParameterSchema

Remarks

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.

Index

Constructors

Accessors

hasAnnotation isMultipleEntryPoint

Methods

Encode EncodeObject Execute ExtractSignatures generateSchema fromRPCResponse

Constructors

constructor

new ParameterSchema(val: MichelsonV1Expression): ParameterSchema
Return the schema of the parameter of a specific entry point
Parameters
- val: MichelsonV1Expression
Returns ParameterSchema
Throws
InvalidTokenError
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:76

Accessors

hasAnnotation

get hasAnnotation(): boolean
Check if the Contract parameter has an annotation or not

Returns boolean
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:64

isMultipleEntryPoint

get isMultipleEntryPoint(): boolean
Check if the Contract parameter is multiple entry point or not

Returns boolean
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:54

Methods

Encode

Encode(...args: any[]): any
Returns a micheline formatted object for the values provided
Parameters
- ...args: any[]
Returns any
Throws
TokenValidationError

Throws
ParameterEncodingError
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:92

EncodeObject

EncodeObject(value?: any, semantics?: SemanticEncoding): any
Returns a micheline formatted object for the javascript object provided
Parameters
- Optionalvalue: any
- Optionalsemantics: SemanticEncoding
Returns any
Throws
TokenValidationError

Throws
ParameterEncodingError
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:108

Execute

Execute(val: any, semantics?: Semantic): any
Returns the javascript object equivalent of the Micheline value provided
Parameters
- val: any
- Optionalsemantics: Semantic
Returns any
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:83

ExtractSignatures

ExtractSignatures(): TokenSchema[][]
Returns TokenSchema[][]
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:126

generateSchema

generateSchema(): TokenSchema
Produce a schema grouping together all the entry points of a contract.

Returns TokenSchema
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:122

`Static`fromRPCResponse

fromRPCResponse(val: { script: ScriptedContracts }): ParameterSchema
Create an instance of ParameterSchema from a contract script
Parameters
- val: { script: ScriptedContracts }
  contract script obtained from the RPC
Returns ParameterSchema
ParameterSchema

Throws
If the RPC response is invalid
- Defined in packages/taquito-michelson-encoder/src/schema/parameter.ts:23