mint.json

{
	"$schema": "https://mintlify.com/schema.json",
	"name": "Quai Network Docs",
	"logo": {
		"dark": "/images/logo.png",
		"light": "/images/logo.png"
	},
	"favicon": "/favicon.svg",
	"colors": {
		"primary": "#e22901",
		"light": "#e22901",
		"dark": "#e22901",
		"anchors": {
			"from": "#e22901",
			"to": "#222222"
		}
	},
	"feedback": {
		"suggestEdit": true,
		"raiseIssue": true,
		"thumbsRating": true
	},
	"search": {
		"prompt": "What can I build on Quai?"
	},
	"topbarLinks": [
		{
			"name": "Discord",
			"url": "https://discord.gg/quai"
		}
	],
	"topbarCtaButton": {
		"name": "Quai Network",
		"url": "https://qu.ai"
	},
	"tabs": [
		{
			"name": "Build",
			"url": "build"
		},
		{
			"name": "SDK",
			"url": "sdk"
		},
		{
			"name": "Client",
			"url": "client"
		},
		{
			"name": "Guides",
			"url": "guides"
		}
	],
	"primaryTab": {
		"name": "Learn"
	},
	"navigation": [
		{
			"group": "Getting Started",
			"pages": ["learn/introduction"]
		},
		{
			"group": "Advanced Topics",
			"pages": [
				{
					"group": "Proof-of-Entropy-Minima (PoEM)",
					"pages": [
						"learn/advanced-introduction/poem/poem",
						{
							"group": "Fork Choice",
							"pages": [
								"learn/advanced-introduction/poem/fork-choice/instant-fork-resolution",
								"learn/advanced-introduction/poem/fork-choice/intrinsic-block-weight",
								"learn/advanced-introduction/poem/fork-choice/calc-total-entropy"
							]
						},
						{
							"group": "Finality",
							"pages": [
								"learn/advanced-introduction/poem/finality/finality",
								"learn/advanced-introduction/poem/finality/statistical-finality"
							]
						},
						{
							"group": "Sharding",
							"pages": [
								"learn/advanced-introduction/poem/sharding/execution-sharding",
								"learn/advanced-introduction/poem/sharding/dynamic-sharding"
							]
						}
					]
				},
				{
					"group": "Merged Mining",
					"pages": [
						"learn/advanced-introduction/merged-mining/overview",
						"learn/advanced-introduction/merged-mining/coincident-blocks",
						"learn/advanced-introduction/merged-mining/energy-efficiency",
						"learn/advanced-introduction/merged-mining/parachains"
					]
				},
				"learn/advanced-introduction/multithreaded-execution",
				{
					"group": "Interoperability",
					"pages": ["learn/advanced-introduction/interoperability/overview", "learn/advanced-introduction/interoperability/etxs"]
				},
				{
					"group": "Hierarchical Structure",
					"pages": [
						"learn/advanced-introduction/hierarchical-structure/hierarchical-structure",
						"learn/advanced-introduction/hierarchical-structure/sharding",
						"learn/advanced-introduction/hierarchical-structure/latency"
					]
				}
			]
		},
		{
			"group": "Tokenomics",
			"pages": [
				{
					"group": "Two Tokens",
					"pages": [
						"learn/tokenomics/tokenomics-overview/tokenomics-overview",
						"learn/tokenomics/tokenomics-overview/quai",
						"learn/tokenomics/tokenomics-overview/qi"
					]
				},
				{
					"group": "Token Dynamics",
					"pages": [
						"learn/tokenomics/token-dynamics/token-dynamics",
						"learn/tokenomics/token-dynamics/conversions",
						"learn/tokenomics/token-dynamics/block-rewards",
						"learn/tokenomics/token-dynamics/difficulty-adjustments",
						"learn/tokenomics/token-dynamics/supply-growth"
					]
				},
				"learn/tokenomics/genesis-allocations"
			]
		},
		{
			"group": "Academic Resources",
			"pages": ["learn/academic-resources/whitepapers", "learn/academic-resources/lectures"]
		},
		{
			"group": "Getting Started",
			"pages": ["build/introduction", "build/networks", "build/quick-links"]
		},
		{
			"group": "Smart Contracts",
			"pages": [
				{
					"group": "Languages",
					"pages": [
						"build/smart-contracts/languages/overview",
						"build/smart-contracts/languages/solidity",
						"build/smart-contracts/languages/solidityx"
					]
				},
				"build/smart-contracts/opcode-additions",
				"build/smart-contracts/deployment"
			]
		},
		{
			"group": "Transactions",
			"pages": ["build/transactions/overview", "build/transactions/types"]
		},
		{
			"group": "API Libaries",
			"pages": [
				"build/apis/javascript-libraries",
				{
					"group": "Postman",
					"pages": ["build/apis/postman/setup", "build/apis/postman/environment", "build/apis/postman/use"]
				}
			]
		},
		{
			"group": "API Playground",
			"pages": [
				"build/playground/overview",
				{
					"group": "Addresses",
					"pages": [
						"build/playground/addresses/getBalance",
						"build/playground/addresses/getCode",
						"build/playground/addresses/getStorageAt",
						"build/playground/addresses/getProof",
						"build/playground/addresses/getTransactionCount",
						"build/playground/addresses/getOutpointsByAddressAndRange"
					],
					"icon": "address-card"
				},
				{
					"group": "Blocks",
					"pages": [
						"build/playground/blocks/blockNumber",
						"build/playground/blocks/getHeaderHashByNumber",
						"build/playground/blocks/getHeaderByHash",
						"build/playground/blocks/getHeaderByNumber",
						"build/playground/blocks/getPendingHeader",
						"build/playground/blocks/getBlockByNumber",
						"build/playground/blocks/getBlockByHash",
						"build/playground/blocks/getBlockOrCandidateByHash",
						"build/playground/blocks/getUncleByBlockNumberAndIndex",
						"build/playground/blocks/getUncleByBlockHashAndIndex",
						"build/playground/blocks/getUncleCountByBlockNumber",
						"build/playground/blocks/getUncleCountByBlockHash"
					],
					"icon": "cube"
				},
				{
					"group": "Transactions",
					"pages": [
						"build/playground/transactions/getBlockTransactionCountByHash",
						"build/playground/transactions/getBlockTransactionCountByNumber",
						"build/playground/transactions/getTransactionByBlockNumberAndIndex",
						"build/playground/transactions/getTransactionByBlockHashAndIndex",
						"build/playground/transactions/getRawTransactionByBlockNumberAndIndex",
						"build/playground/transactions/getRawTransactionByBlockHashAndIndex",
						"build/playground/transactions/getRawTransactionByHash",
						"build/playground/transactions/getTransactionByHash",
						"build/playground/transactions/getTransactionReceipt",
						"build/playground/transactions/sendRawTransaction",
						"build/playground/transactions/createAccessList",
						"build/playground/transactions/call"
					],
					"icon": "right-left"
				},
				{
					"group": "Gas and Fee",
					"pages": [
						"build/playground/gas-and-fee/gasPrice",
						"build/playground/gas-and-fee/maxPriorityFeePerGas",
						"build/playground/gas-and-fee/feeHistory",
						"build/playground/gas-and-fee/estimateGas"
					],
					"icon": "gas-pump"
				},
				{
					"group": "Txpool",
					"pages": [
						"build/playground/txpool/content",
						"build/playground/txpool/contentFrom",
						"build/playground/txpool/inspect",
						"build/playground/txpool/status"
					],
					"icon": "line-columns"
				},
				{
					"group": "Debug",
					"pages": ["build/playground/debug/getBlockRlp", "build/playground/debug/printBlock", "build/playground/debug/traceTransaction"],
					"icon": "bug"
				},
				{
					"group": "Net",
					"pages": ["build/playground/net/listening", "build/playground/net/peerCount", "build/playground/net/version"],
					"icon": "wifi"
				},
				{
					"group": "Miner",
					"pages": ["build/playground/miner/setLockupByte", "build/playground/miner/setMinerPreference"],
					"icon": "pickaxe"
				},
				{
					"group": "Other",
					"pages": [
						"build/playground/other/chainId",
						"build/playground/other/nodeLocation",
						"build/playground/other/listRunningChains",
						"build/playground/other/getProtocolExpansionNumber",
						"build/playground/other/quaiRateAtBlock",
						"build/playground/other/qiRateAtBlock"
					],
					"icon": "screwdriver-wrench"
				}
			]
		},
		{
			"group": "Getting Started",
			"pages": ["sdk/introduction"]
		},
		{
			"group": "Fundamentals",
			"pages": [
				"sdk/static/address",
				"sdk/static/contract",
				"sdk/static/provider",
				"sdk/static/transactions",
				"sdk/static/wallet",
				{
					"group": "Examples",
					"pages": [
						"sdk/static/examples/wallet-management",
						"sdk/static/examples/send-transaction",
						"sdk/static/examples/contract-deploy-interact"
					]
				}
			]
		},
		{
			"group": "Reference",
			"pages": [
				{
					"group": "Address",
					"pages": [
						"sdk/content/interfaces/Addressable",
						"sdk/content/type-aliases/AddressLike",
						"sdk/content/functions/computeAddress",
						"sdk/content/functions/getAddress",
						"sdk/content/functions/getCreate2Address",
						"sdk/content/functions/getCreateAddress",
						"sdk/content/functions/isAddress",
						"sdk/content/functions/isAddressable",
						"sdk/content/functions/isQiAddress",
						"sdk/content/functions/isQuaiAddress",
						"sdk/content/functions/recoverAddress",
						"sdk/content/functions/resolveAddress",
						"sdk/content/functions/validateAddress"
					]
				},
				{
					"group": "Application Binary Interface",
					"pages": [
						"sdk/content/classes/AbiCoder",
						"sdk/content/classes/ConstructorFragment",
						"sdk/content/classes/ErrorDescription",
						"sdk/content/classes/ErrorFragment",
						"sdk/content/classes/EventFragment",
						"sdk/content/classes/FallbackFragment",
						"sdk/content/classes/Fragment",
						"sdk/content/classes/FunctionFragment",
						"sdk/content/classes/Indexed",
						"sdk/content/classes/Interface",
						"sdk/content/classes/LogDescription",
						"sdk/content/classes/NamedFragment",
						"sdk/content/classes/ParamType",
						"sdk/content/classes/Result",
						"sdk/content/classes/StructFragment",
						"sdk/content/classes/TransactionDescription",
						"sdk/content/classes/Typed",
						"sdk/content/interfaces/JsonFragment",
						"sdk/content/interfaces/JsonFragmentType",
						"sdk/content/type-aliases/FormatType",
						"sdk/content/type-aliases/FragmentType",
						"sdk/content/type-aliases/InterfaceAbi",
						"sdk/content/type-aliases/ParamTypeWalkAsyncFunc",
						"sdk/content/type-aliases/ParamTypeWalkFunc",
						"sdk/content/functions/checkResultErrors"
					]
				},
				{
					"group": "Constants",
					"pages": [
						"sdk/content/enumerations/Shard",
						"sdk/content/enumerations/Zone",
						"sdk/content/variables/MaxInt256",
						"sdk/content/variables/MaxUint256",
						"sdk/content/variables/MessagePrefix",
						"sdk/content/variables/MinInt256",
						"sdk/content/variables/N",
						"sdk/content/variables/WeiPerEther",
						"sdk/content/variables/ZeroAddress",
						"sdk/content/variables/ZeroHash",
						"sdk/content/variables/quaisymbol"
					]
				},
				{
					"group": "Contract",
					"pages": [
						"sdk/content/classes/BaseContract",
						"sdk/content/classes/Contract",
						"sdk/content/classes/ContractEventPayload",
						"sdk/content/classes/ContractFactory",
						"sdk/content/classes/ContractTransactionReceipt",
						"sdk/content/classes/ContractTransactionResponse",
						"sdk/content/classes/ContractUnknownEventPayload",
						"sdk/content/classes/EventLog",
						"sdk/content/classes/UndecodedEventLog",
						"sdk/content/interfaces/BaseContractMethod",
						"sdk/content/interfaces/ConstantContractMethod",
						"sdk/content/interfaces/ContractDeployTransaction",
						"sdk/content/interfaces/ContractEvent",
						"sdk/content/interfaces/ContractInterface",
						"sdk/content/interfaces/ContractMethod",
						"sdk/content/interfaces/ContractRunner",
						"sdk/content/interfaces/ContractTransaction",
						"sdk/content/interfaces/DeferredTopicFilter",
						"sdk/content/interfaces/Overrides",
						"sdk/content/interfaces/WrappedFallback",
						"sdk/content/type-aliases/ContractEventName"
					]
				},
				{
					"group": "Crypto",
					"pages": [
						"sdk/content/classes/Signature",
						"sdk/content/classes/SigningKey",
						"sdk/content/type-aliases/ProgressCallback",
						"sdk/content/type-aliases/SignatureLike",
						"sdk/content/functions/computeHmac",
						"sdk/content/functions/keccak256",
						"sdk/content/functions/lock",
						"sdk/content/functions/pbkdf2",
						"sdk/content/functions/randomBytes",
						"sdk/content/functions/ripemd160",
						"sdk/content/functions/scrypt",
						"sdk/content/functions/scryptSync",
						"sdk/content/functions/sha256",
						"sdk/content/functions/sha512"
					]
				},
				{
					"group": "Encoding",
					"pages": [
						"sdk/content/type-aliases/UnicodeNormalizationForm",
						"sdk/content/type-aliases/Utf8ErrorFunc",
						"sdk/content/type-aliases/Utf8ErrorReason",
						"sdk/content/functions/decodeBase58",
						"sdk/content/functions/decodeBase64",
						"sdk/content/functions/decodeBytes32",
						"sdk/content/functions/encodeBase58",
						"sdk/content/functions/encodeBase64",
						"sdk/content/functions/encodeBytes32",
						"sdk/content/functions/toUtf8Bytes",
						"sdk/content/functions/toUtf8CodePoints",
						"sdk/content/functions/toUtf8String"
					]
				},
				{
					"group": "Hash",
					"pages": [
						"sdk/content/classes/TypedDataEncoder",
						"sdk/content/interfaces/TypedDataDomain",
						"sdk/content/interfaces/TypedDataField",
						"sdk/content/functions/ethHashMessage",
						"sdk/content/functions/ethVerifyMessage",
						"sdk/content/functions/hashMessage",
						"sdk/content/functions/id",
						"sdk/content/functions/solidityPacked",
						"sdk/content/functions/solidityPackedKeccak256",
						"sdk/content/functions/solidityPackedSha256",
						"sdk/content/functions/verifyMessage",
						"sdk/content/functions/verifyTypedData"
					]
				},
				{
					"group": "Other",
					"pages": [
						"sdk/content/interfaces/SerializedHDWallet",
						"sdk/content/interfaces/SerializedQiHDWallet",
						"sdk/content/type-aliases/ErrorCode"
					]
				},
				{
					"group": "Providers",
					"pages": [
						"sdk/content/classes/AbstractProvider",
						"sdk/content/classes/Block",
						"sdk/content/classes/BrowserProvider",
						"sdk/content/classes/FeeData",
						"sdk/content/classes/JsonRpcApiProvider",
						"sdk/content/classes/JsonRpcProvider",
						"sdk/content/classes/JsonRpcSigner",
						"sdk/content/classes/Log",
						"sdk/content/classes/Network",
						"sdk/content/classes/SocketBlockSubscriber",
						"sdk/content/classes/SocketEventSubscriber",
						"sdk/content/classes/SocketPendingSubscriber",
						"sdk/content/classes/SocketProvider",
						"sdk/content/classes/SocketSubscriber",
						"sdk/content/classes/TransactionReceipt",
						"sdk/content/classes/UnmanagedSubscriber",
						"sdk/content/classes/WebSocketProvider",
						"sdk/content/interfaces/BlockParams",
						"sdk/content/interfaces/Eip1193Provider",
						"sdk/content/interfaces/EventFilter",
						"sdk/content/interfaces/Filter",
						"sdk/content/interfaces/FilterByBlockHash",
						"sdk/content/interfaces/LogParams",
						"sdk/content/interfaces/MinedBlock",
						"sdk/content/interfaces/Provider",
						"sdk/content/interfaces/Subscriber",
						"sdk/content/interfaces/TransactionReceiptParams",
						"sdk/content/interfaces/WebSocketLike",
						"sdk/content/type-aliases/BlockTag",
						"sdk/content/type-aliases/DebugEventBrowserProvider",
						"sdk/content/type-aliases/JsonRpcApiProviderOptions",
						"sdk/content/type-aliases/JsonRpcError",
						"sdk/content/type-aliases/JsonRpcPayload",
						"sdk/content/type-aliases/JsonRpcResult",
						"sdk/content/type-aliases/MinedTransactionResponse",
						"sdk/content/type-aliases/Networkish",
						"sdk/content/type-aliases/OrphanFilter",
						"sdk/content/type-aliases/PerformActionFilter",
						"sdk/content/type-aliases/PerformActionRequest",
						"sdk/content/type-aliases/PerformActionTransaction",
						"sdk/content/type-aliases/PreparedTransactionRequest",
						"sdk/content/type-aliases/ProviderEvent",
						"sdk/content/type-aliases/Subscription",
						"sdk/content/type-aliases/TopicFilter",
						"sdk/content/type-aliases/TransactionRequest",
						"sdk/content/type-aliases/TransactionResponse",
						"sdk/content/type-aliases/TransactionResponseParams",
						"sdk/content/type-aliases/WebSocketCreator",
						"sdk/content/functions/copyRequest"
					]
				},
				{
					"group": "Signers",
					"pages": ["sdk/content/classes/AbstractSigner", "sdk/content/classes/VoidSigner", "sdk/content/interfaces/Signer"]
				},
				{
					"group": "Transaction",
					"pages": [
						"sdk/content/classes/FewestCoinSelector",
						"sdk/content/classes/QiTransaction",
						"sdk/content/classes/QuaiTransaction",
						"sdk/content/classes/UTXO",
						"sdk/content/interfaces/TransactionLike",
						"sdk/content/type-aliases/AccessList",
						"sdk/content/type-aliases/AccessListEntry",
						"sdk/content/type-aliases/AccessListish",
						"sdk/content/variables/denominations",
						"sdk/content/functions/accessListify"
					]
				},
				{
					"group": "Utils",
					"pages": [
						"sdk/content/classes/EventPayload",
						"sdk/content/classes/FetchRequest",
						"sdk/content/classes/FetchResponse",
						"sdk/content/classes/FixedNumber",
						"sdk/content/interfaces/ActionRejectedError",
						"sdk/content/interfaces/BadDataError",
						"sdk/content/interfaces/BufferOverrunError",
						"sdk/content/interfaces/CallExceptionError",
						"sdk/content/interfaces/CancelledError",
						"sdk/content/interfaces/EventEmitterable",
						"sdk/content/interfaces/InsufficientFundsError",
						"sdk/content/interfaces/InvalidArgumentError",
						"sdk/content/interfaces/MissingArgumentError",
						"sdk/content/interfaces/NetworkError",
						"sdk/content/interfaces/NonceExpiredError",
						"sdk/content/interfaces/NotImplementedError",
						"sdk/content/interfaces/NumericFaultError",
						"sdk/content/interfaces/ReplacementUnderpricedError",
						"sdk/content/interfaces/ServerError",
						"sdk/content/interfaces/TimeoutError",
						"sdk/content/interfaces/TransactionReplacedError",
						"sdk/content/interfaces/UnexpectedArgumentError",
						"sdk/content/interfaces/UnknownError",
						"sdk/content/interfaces/UnsupportedOperationError",
						"sdk/content/interfaces/quaisError",
						"sdk/content/type-aliases/BigNumberish",
						"sdk/content/type-aliases/BytesLike",
						"sdk/content/type-aliases/CallExceptionAction",
						"sdk/content/type-aliases/CallExceptionTransaction",
						"sdk/content/type-aliases/CodedquaisError",
						"sdk/content/type-aliases/FetchGatewayFunc",
						"sdk/content/type-aliases/FetchGetUrlFunc",
						"sdk/content/type-aliases/FetchPreflightFunc",
						"sdk/content/type-aliases/FetchProcessFunc",
						"sdk/content/type-aliases/FetchRetryFunc",
						"sdk/content/type-aliases/FixedFormat",
						"sdk/content/type-aliases/GetUrlResponse",
						"sdk/content/type-aliases/Listener",
						"sdk/content/type-aliases/Numeric",
						"sdk/content/functions/concat",
						"sdk/content/functions/dataLength",
						"sdk/content/functions/dataSlice",
						"sdk/content/functions/formatQi",
						"sdk/content/functions/formatQuai",
						"sdk/content/functions/formatUnits",
						"sdk/content/functions/fromTwos",
						"sdk/content/functions/getAddressDetails",
						"sdk/content/functions/getBigInt",
						"sdk/content/functions/getBytes",
						"sdk/content/functions/getBytesCopy",
						"sdk/content/functions/getNumber",
						"sdk/content/functions/getTxType",
						"sdk/content/functions/getUint",
						"sdk/content/functions/getZoneForAddress",
						"sdk/content/functions/hexlify",
						"sdk/content/functions/isBytesLike",
						"sdk/content/functions/isCallException",
						"sdk/content/functions/isError",
						"sdk/content/functions/isHexString",
						"sdk/content/functions/makeError",
						"sdk/content/functions/mask",
						"sdk/content/functions/parseQi",
						"sdk/content/functions/parseQuai",
						"sdk/content/functions/parseUnits",
						"sdk/content/functions/stripZerosLeft",
						"sdk/content/functions/toBeArray",
						"sdk/content/functions/toBeHex",
						"sdk/content/functions/toBigInt",
						"sdk/content/functions/toNumber",
						"sdk/content/functions/toQuantity",
						"sdk/content/functions/toTwos",
						"sdk/content/functions/uuidV4",
						"sdk/content/functions/zeroPadBytes",
						"sdk/content/functions/zeroPadValue"
					]
				},
				{
					"group": "Wallet",
					"pages": [
						"sdk/content/classes/Mnemonic",
						"sdk/content/classes/QiHDWallet",
						"sdk/content/classes/QuaiHDWallet",
						"sdk/content/classes/Wallet",
						"sdk/content/type-aliases/EncryptOptions",
						"sdk/content/type-aliases/KeystoreAccount",
						"sdk/content/functions/decryptKeystoreJson",
						"sdk/content/functions/decryptKeystoreJsonSync",
						"sdk/content/functions/encryptKeystoreJson",
						"sdk/content/functions/encryptKeystoreJsonSync",
						"sdk/content/functions/isKeystoreJson"
					]
				},
				{
					"group": "Wordlists",
					"pages": [
						"sdk/content/classes/LangEn",
						"sdk/content/classes/LangEs",
						"sdk/content/classes/Wordlist",
						"sdk/content/classes/WordlistOwl",
						"sdk/content/classes/WordlistOwlA",
						"sdk/content/variables/wordlists"
					]
				}
			]
		},
		{
			"group": "Client",
			"pages": ["client/node", "client/proxy", "client/miner"]
		},
		{
			"group": "Client",
			"pages": ["guides/client/node", "guides/client/node-monitoring", "guides/client/stratum", "guides/client/local-node"]
		},
		{
			"group": "Miner",
			"pages": ["guides/miner/hiveos-flight-sheet", "guides/miner/hiveos", "guides/miner/ubuntu", "guides/miner/clore-ai"]
		},
		{
			"group": "Development",
			"pages": ["guides/development/solidity"]
		}
	],
	"integrations": {
		"intercom": "crmoyy2i"
	},
	"footerSocials": {
		"x": "https://twitter.com/QuaiNetwork",
		"github": "https://github.com/dominant-strategies/quais.js/tree/alpha",
		"linkedin": "https://www.linkedin.com/company/dominant-strategies"
	}
}