@ocap/client 1.29.14 → 1.29.15

package/lib/types.js

@@ -217,7 +217,15 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestEstimateGasInput
+ * Structure of GraphQLClient.RequestEstimateGasInput 
+ *
+ * Checkout the following snippet for the format of RequestEstimateGasInput:
+ * ```json
+{
+  "typeUrl": "abc",
+  "tx": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestEstimateGasInput
@@ -237,7 +245,15 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetAccountTokensInput
+ * Structure of GraphQLClient.RequestGetAccountTokensInput 
+ *
+ * Checkout the following snippet for the format of RequestGetAccountTokensInput:
+ * ```json
+{
+  "address": "abc",
+  "token": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetAccountTokensInput
@@ -246,7 +262,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetBlockInput
+ * Structure of GraphQLClient.RequestGetBlockInput 
+ *
+ * Checkout the following snippet for the format of RequestGetBlockInput:
+ * ```json
+{
+  "height": 123
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetBlockInput
@@ -254,7 +277,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetBlocksInput
+ * Structure of GraphQLClient.RequestGetBlocksInput 
+ *
+ * Checkout the following snippet for the format of RequestGetBlocksInput:
+ * ```json
+{
+  "emptyExcluded": true
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetBlocksInput
@@ -264,7 +294,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetConfigInput
+ * Structure of GraphQLClient.RequestGetConfigInput 
+ *
+ * Checkout the following snippet for the format of RequestGetConfigInput:
+ * ```json
+{
+  "parsed": true
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetConfigInput
@@ -272,7 +309,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetEvidenceStateInput
+ * Structure of GraphQLClient.RequestGetEvidenceStateInput 
+ *
+ * Checkout the following snippet for the format of RequestGetEvidenceStateInput:
+ * ```json
+{
+  "hash": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetEvidenceStateInput
@@ -280,7 +324,16 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetRollupBlockInput
+ * Structure of GraphQLClient.RequestGetRollupBlockInput 
+ *
+ * Checkout the following snippet for the format of RequestGetRollupBlockInput:
+ * ```json
+{
+  "hash": "abc",
+  "height": 123,
+  "rollupAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetRollupBlockInput
@@ -300,7 +353,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetTokenDistributionInput
+ * Structure of GraphQLClient.RequestGetTokenDistributionInput 
+ *
+ * Checkout the following snippet for the format of RequestGetTokenDistributionInput:
+ * ```json
+{
+  "tokenAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetTokenDistributionInput
@@ -308,7 +368,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestGetTxInput
+ * Structure of GraphQLClient.RequestGetTxInput 
+ *
+ * Checkout the following snippet for the format of RequestGetTxInput:
+ * ```json
+{
+  "hash": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestGetTxInput
@@ -316,7 +383,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListAssetTransactionsInput
+ * Structure of GraphQLClient.RequestListAssetTransactionsInput 
+ *
+ * Checkout the following snippet for the format of RequestListAssetTransactionsInput:
+ * ```json
+{
+  "address": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListAssetTransactionsInput
@@ -325,7 +399,15 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListAssetsInput
+ * Structure of GraphQLClient.RequestListAssetsInput 
+ *
+ * Checkout the following snippet for the format of RequestListAssetsInput:
+ * ```json
+{
+  "ownerAddress": "abc",
+  "factoryAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListAssetsInput
@@ -336,7 +418,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListBlocksInput
+ * Structure of GraphQLClient.RequestListBlocksInput 
+ *
+ * Checkout the following snippet for the format of RequestListBlocksInput:
+ * ```json
+{
+  "proposer": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListBlocksInput
@@ -349,7 +438,15 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListDelegationsInput
+ * Structure of GraphQLClient.RequestListDelegationsInput 
+ *
+ * Checkout the following snippet for the format of RequestListDelegationsInput:
+ * ```json
+{
+  "from": "abc",
+  "to": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListDelegationsInput
@@ -371,7 +468,16 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListRollupBlocksInput
+ * Structure of GraphQLClient.RequestListRollupBlocksInput 
+ *
+ * Checkout the following snippet for the format of RequestListRollupBlocksInput:
+ * ```json
+{
+  "rollupAddress": "abc",
+  "tokenAddress": "abc",
+  "proposer": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListRollupBlocksInput
@@ -385,7 +491,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListRollupValidatorsInput
+ * Structure of GraphQLClient.RequestListRollupValidatorsInput 
+ *
+ * Checkout the following snippet for the format of RequestListRollupValidatorsInput:
+ * ```json
+{
+  "rollupAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListRollupValidatorsInput
@@ -394,7 +507,15 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListRollupsInput
+ * Structure of GraphQLClient.RequestListRollupsInput 
+ *
+ * Checkout the following snippet for the format of RequestListRollupsInput:
+ * ```json
+{
+  "tokenAddress": "abc",
+  "foreignTokenAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListRollupsInput
@@ -405,7 +526,12 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListStakesInput
+ * Structure of GraphQLClient.RequestListStakesInput 
+ *
+ * Checkout the following snippet for the format of RequestListStakesInput:
+ * ```json
+{}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListStakesInput
@@ -416,7 +542,17 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListTokenFlowsInput
+ * Structure of GraphQLClient.RequestListTokenFlowsInput 
+ *
+ * Checkout the following snippet for the format of RequestListTokenFlowsInput:
+ * ```json
+{
+  "accountAddress": "abc",
+  "tokenAddress": "abc",
+  "depth": 123,
+  "direction": "IN"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListTokenFlowsInput
@@ -428,7 +564,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListTokensInput
+ * Structure of GraphQLClient.RequestListTokensInput 
+ *
+ * Checkout the following snippet for the format of RequestListTokensInput:
+ * ```json
+{
+  "issuerAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListTokensInput
@@ -438,7 +581,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListTopAccountsInput
+ * Structure of GraphQLClient.RequestListTopAccountsInput 
+ *
+ * Checkout the following snippet for the format of RequestListTopAccountsInput:
+ * ```json
+{
+  "tokenAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListTopAccountsInput
@@ -448,7 +598,12 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestListTransactionsInput
+ * Structure of GraphQLClient.RequestListTransactionsInput 
+ *
+ * Checkout the following snippet for the format of RequestListTransactionsInput:
+ * ```json
+{}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestListTransactionsInput
@@ -469,7 +624,14 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestSearchInput
+ * Structure of GraphQLClient.RequestSearchInput 
+ *
+ * Checkout the following snippet for the format of RequestSearchInput:
+ * ```json
+{
+  "keyword": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestSearchInput
@@ -478,7 +640,17 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestSendTxInput
+ * Structure of GraphQLClient.RequestSendTxInput 
+ *
+ * Checkout the following snippet for the format of RequestSendTxInput:
+ * ```json
+{
+  "tx": "abc",
+  "token": "abc",
+  "commit": true,
+  "extra": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestSendTxInput
@@ -490,7 +662,15 @@
  */
 
 /**
- * Structure of GraphQLClient.RequestVerifyAccountRiskInput
+ * Structure of GraphQLClient.RequestVerifyAccountRiskInput 
+ *
+ * Checkout the following snippet for the format of RequestVerifyAccountRiskInput:
+ * ```json
+{
+  "accountAddress": "abc",
+  "tokenAddress": "abc"
+}
+ * ```
  *
  * @memberof GraphQLClient
  * @typedef {object} GraphQLClient.RequestVerifyAccountRiskInput
@@ -2532,6 +2712,7 @@
  * @typedef {object} GraphQLClient.SearchResult
  * @property {string} type
  * @property {string} id
+ * @property {string} title
  */
 
 /**