Generate md file for zod schemas using modified version of zod2md

[Muhammad-Altabba]

Type of PR:

• Bugfix
• Feature
• Documentation
• Other

Required reviews:

• 1
• 2
• 3

What this does:

High-level idea of the changes introduced in this PR. List relevant API
changes (if any), as well as related PRs and issues.

Issues fixed/closed:

• Fixes #...

Why it's needed:

Explain how this PR fits in the greater context of the NuCypher Network. E.g.,
if this PR address a nucypher/productdev issue, let reviewers know!

Notes for reviewers:

What should reviewers focus on? Is there a particular commit/function/section
of your PR that requires more attention from reviewers?

---

The generated file would be something similar to:

Conditions Schemas

AnyCondition

Union of the following possible types:

• RpcCondition
• TimeCondition
• ContractCondition
• CompoundCondition
• JsonApiCondition
• JsonRpcCondition
• SequentialCondition
• IfThenElseCondition

UserAddress

Enum string, one of the following possible values:

• ':userAddress'
• ':userAddressExternalEIP4361'

BaseCondition

Object containing the following properties:

Property	Type
conditionType (*)	string

(*) Required.

HttpsURL

String which is a valid URL.

JsonPath

String.

PlainString

String.

CompoundCondition

Object containing the following properties:

Property	Type	Default
conditionType	'compound'	'compound'
operator (*)	'and' | 'or' | 'not'
operands (*)	Array of at least 1 and at most 5 AnyCondition item

(*) Required.

ContextParam

String which matches the regular expression /^:[a-zA-Z_][a-zA-Z0-9_]*$/.

ParamOrContextParam

Union of the following possible types:

• PlainString, boolean or number
• ContextParam
• undefined

ContractCondition

Object containing the following properties:

Property	Description	Type	Default
conditionType		'contract'	'contract'
chain (*)		number (int, ≥0)
method (*)		string
parameters (*)		Array of ParamOrContextParam items
returnValueTest (*)	Update to allow multiple return values after expanding supported methods	ReturnValueTest
contractAddress (*)		string
standardContractType		'ERC20' | 'ERC721'
functionAbi		FunctionAbi

(*) Required.

FunctionAbi

Object containing the following properties:

Property	Type
name (*)	string
type (*)	'function'
inputs (*)	Array of at least 0 FunctionAbiVariable item
outputs (*)	Array of at least 1 FunctionAbiVariable items
stateMutability (*)	'view' | 'pure'

(*) Required.

FunctionAbiVariable

Object containing the following properties:

Property	Type
name (*)	string
type (*)	'bool' | 'string' | 'address' | 'address payable' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | ...
internalType (*)	'bool' | 'string' | 'address' | 'address payable' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | ...

(*) Required.

IfThenElseCondition

Object containing the following properties:

Property	Type	Default
conditionType	'if-then-else'	'if-then-else'
ifCondition (*)	AnyCondition
thenCondition (*)	AnyCondition
elseCondition (*)	AnyCondition or boolean

(*) Required.

JsonApiCondition

Object containing the following properties:

Property	Type	Default
conditionType	'json-api'	'json-api'
endpoint (*)	HttpsURL
parameters	Object with dynamic keys of type string and values of type unknown (optional & nullable)
query	JsonPath
authorizationToken	ContextParam
returnValueTest (*)	ReturnValueTest

(*) Required.

JsonRpcCondition

Object containing the following properties:

Property	Type	Default
conditionType	'json-rpc'	'json-rpc'
endpoint (*)	HttpsURL
method (*)	string
params	Array<unknown> or Object with dynamic keys of type string and values of type unknown (optional & nullable)
query	JsonPath
authorizationToken	ContextParam
returnValueTest (*)	ReturnValueTest

(*) Required.

ReturnValueTest

Object containing the following properties:

Property	Type
index	number (int, ≥0)
comparator (*)	'==' | '>' | '<' | '>=' | '<=' | '!='
value (*)	ParamOrContextParam

(*) Required.

RpcCondition

eth_getBalance schema specification

• Ethereum spec: https://ethereum.github.io/execution-apis/api-documentation/
• web3py: https://web3py.readthedocs.io/en/stable/web3.eth.html#web3.eth.Eth.get_balance

Object containing the following properties:

Property	Description	Type	Default
conditionType		'rpc'	'rpc'
chain (*)		number (int, ≥0)
method (*)	Only 'eth_getBalance' method is supported	'eth_getBalance'
parameters (*)		Tuple: string, UserAddress or ContextParam number (int, ≥0), string (regex: /^0x[a-fA-F0-9]{64}$/) or 'earliest' | 'finalized' | 'safe' | 'latest' | 'pending' or ContextParam Description: Spec requires 2 parameters: an address and a block identifier or Tuple: string, UserAddress or ContextParam Description: Block identifier can be omitted, since web3py (which runs on TACo exec layer) defaults to 'latest'
returnValueTest (*)	Update to allow multiple return values after expanding supported methods	ReturnValueTest

(*) Required.

ConditionVariable

Object containing the following properties:

Property	Type
varName (*)	PlainString
condition (*)	AnyCondition

(*) Required.

SequentialCondition

Object containing the following properties:

Property	Type	Default
conditionType	'sequential'	'sequential'
conditionVariables (*)	Array of at least 2 and at most 5 ConditionVariable item

(*) Required.

TimeCondition

Object containing the following properties:

Property	Description	Type	Default
conditionType		'time'	'time'
chain (*)		number (int, ≥0)
method		'blocktime'	'blocktime'
returnValueTest (*)	Update to allow multiple return values after expanding supported methods	ReturnValueTest

(*) Required.

[Muhammad-Altabba]

To check the generated file: zod-schemas.md

Or locally run:
Go inside the package taco (cd packages/taco) and then run pnpm run generate-zod-docs. Please, let me know if adding a script command at the mono-repo root is recommended.

[Muhammad-Altabba]

An issue has been created at zod2md for the changes made in its fork. In this issue a list of the modifications has been provided along with a reference to the pushed commits.