@ocap/client 1.18.34 → 1.18.35

package/lib/types.js

@@ -833,6 +833,28 @@
  * @property {...GraphQLClient.Any} data
  */
 
+/**
+ * Structure of GraphQLClient.CloseRollupTx 
+ *
+ * Checkout the following snippet for the format of CloseRollupTx:
+ * ```json
+{
+  "rollup": "abc",
+  "message": "abc",
+  "data": {
+    "typeUrl": "abc",
+    "value": "abc"
+  }
+}
+ * ```
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.CloseRollupTx
+ * @property {string} rollup
+ * @property {string} message
+ * @property {...GraphQLClient.Any} data
+ */
+
 /**
  * Structure of GraphQLClient.ConsensusParams 
  *
@@ -899,6 +921,7 @@
  * @property {Array<...GraphQLClient.Multisig>} signatures
  * @property {string} rollup
  * @property {string} minReward
+ * @property {boolean} governance
  * @property {...GraphQLClient.Any} data
  */
 
@@ -909,6 +932,7 @@
  * @typedef {object} GraphQLClient.CreateRollupTx
  * @property {string} address
  * @property {string} tokenAddress
+ * @property {string} vaultAddress
  * @property {string} contractAddress
  * @property {Array<...GraphQLClient.RollupValidator>} seedValidators
  * @property {string} minStakeAmount
@@ -1374,6 +1398,7 @@
  * @property {string} mintedAmount
  * @property {string} burnedAmount
  * @property {string} rewardAmount
+ * @property {boolean} governance
  * @property {...GraphQLClient.IndexedTokenInput} tokenInfo
  * @property {...GraphQLClient.Any} data
  */
@@ -1385,6 +1410,7 @@
  * @typedef {object} GraphQLClient.IndexedRollupState
  * @property {string} address
  * @property {string} tokenAddress
+ * @property {string} vaultAddress
  * @property {string} contractAddress
  * @property {Array<...GraphQLClient.RollupValidator>} seedValidators
  * @property {Array<...GraphQLClient.RollupValidator>} validators
@@ -1422,6 +1448,8 @@
  * @property {number} publishWaitingPeriod
  * @property {number} publishSlashRate
  * @property {Array<string>} migrateHistory
+ * @property {boolean} closed
+ * @property {Array<string>} vaultHistory
  * @property {...GraphQLClient.Any} data
  */
 
@@ -1552,40 +1580,15 @@
  */
 
 /**
- * Structure of GraphQLClient.MigrateRollupContractTx 
- *
- * Checkout the following snippet for the format of MigrateRollupContractTx:
- * ```json
-{
-  "rollup": "abc",
-  "to": "abc",
-  "data": {
-    "typeUrl": "abc",
-    "value": "abc"
-  }
-}
- * ```
- *
- * @memberof GraphQLClient
- * @typedef {object} GraphQLClient.MigrateRollupContractTx
- * @property {string} rollup
- * @property {string} to
- * @property {...GraphQLClient.Any} data
- */
-
-/**
- * Structure of GraphQLClient.MigrateRollupTokenTx 
+ * Structure of GraphQLClient.MigrateRollupTx 
  *
- * Checkout the following snippet for the format of MigrateRollupTokenTx:
+ * Checkout the following snippet for the format of MigrateRollupTx:
  * ```json
 {
   "rollup": "abc",
-  "from": "abc",
   "to": "abc",
-  "token": {
-    "address": "abc",
-    "value": "abc"
-  },
+  "type": "abc",
+  "message": "abc",
   "data": {
     "typeUrl": "abc",
     "value": "abc"
@@ -1594,11 +1597,11 @@
  * ```
  *
  * @memberof GraphQLClient
- * @typedef {object} GraphQLClient.MigrateRollupTokenTx
+ * @typedef {object} GraphQLClient.MigrateRollupTx
  * @property {string} rollup
- * @property {string} from
  * @property {string} to
- * @property {...GraphQLClient.TokenInput} token
+ * @property {string} type
+ * @property {string} message
  * @property {...GraphQLClient.Any} data
  */
 
@@ -2185,6 +2188,7 @@
  * @property {string} burnedAmount
  * @property {string} rewardAmount
  * @property {string} minReward
+ * @property {boolean} governance
  * @property {...GraphQLClient.StateContext} context
  * @property {...GraphQLClient.Any} data
  */
@@ -2196,6 +2200,7 @@
  * @typedef {object} GraphQLClient.RollupState
  * @property {string} address
  * @property {string} tokenAddress
+ * @property {string} vaultAddress
  * @property {string} contractAddress
  * @property {Array<...GraphQLClient.RollupValidator>} seedValidators
  * @property {Array<...GraphQLClient.RollupValidator>} validators
@@ -2231,6 +2236,8 @@
  * @property {number} publishWaitingPeriod
  * @property {number} publishSlashRate
  * @property {Array<string>} migrateHistory
+ * @property {boolean} closed
+ * @property {Array<string>} vaultHistory
  * @property {...GraphQLClient.StateContext} context
  * @property {...GraphQLClient.Any} data
  */
@@ -3410,6 +3417,33 @@
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
 
+/**
+ * @memberof GraphQLClient
+ * @typedef {Object} GraphQLClient.CloseRollupTxInput
+ * @prop {object} input
+ * @prop {object} input.tx - data of the transaction
+ * @prop {GraphQLClient.CloseRollupTx} input.tx.itx - the actual transaction object
+ * @prop {string} [input.tx.pk] - the sender pk
+ * @prop {string} [input.tx.from] - the sender address, can be derived from wallet
+ * @prop {number} [input.tx.nonce] - the tx nonce, defaults to Date.now if not set
+ * @prop {string} [input.tx.chainId] - the chainId
+ * @prop {string} [input.tx.signature] - transaction signature
+ * @prop {array} [input.tx.signatures] - transaction signatures, should be set when it's a multisig transaction
+ * @prop {object} input.wallet - the wallet used to sign the transaction, either a forge managed wallet or user managed wallet
+ * @prop {string} [input.signature] - the signature of the tx, if this parameter exist, we will not sign the transaction
+ */
+
+/**
+ * Send CloseRollupTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ *
+ * @memberof GraphQLClient
+ * @function
+ * @name GraphQLClient#sendCloseRollupTx
+ * @param {GraphQLClient.CloseRollupTxInput} params
+ * @param {object} extra
+ * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
+ */
+
 /**
  * @memberof GraphQLClient
  * @typedef {Object} GraphQLClient.CreateAssetTxInput
@@ -3736,10 +3770,10 @@
 
 /**
  * @memberof GraphQLClient
- * @typedef {Object} GraphQLClient.MigrateRollupContractTxInput
+ * @typedef {Object} GraphQLClient.MigrateRollupTxInput
  * @prop {object} input
  * @prop {object} input.tx - data of the transaction
- * @prop {GraphQLClient.MigrateRollupContractTx} input.tx.itx - the actual transaction object
+ * @prop {GraphQLClient.MigrateRollupTx} input.tx.itx - the actual transaction object
  * @prop {string} [input.tx.pk] - the sender pk
  * @prop {string} [input.tx.from] - the sender address, can be derived from wallet
  * @prop {number} [input.tx.nonce] - the tx nonce, defaults to Date.now if not set
@@ -3751,39 +3785,12 @@
  */
 
 /**
- * Send MigrateRollupContractTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ * Send MigrateRollupTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
  *
  * @memberof GraphQLClient
  * @function
- * @name GraphQLClient#sendMigrateRollupContractTx
- * @param {GraphQLClient.MigrateRollupContractTxInput} params
- * @param {object} extra
- * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
- */
-
-/**
- * @memberof GraphQLClient
- * @typedef {Object} GraphQLClient.MigrateRollupTokenTxInput
- * @prop {object} input
- * @prop {object} input.tx - data of the transaction
- * @prop {GraphQLClient.MigrateRollupTokenTx} input.tx.itx - the actual transaction object
- * @prop {string} [input.tx.pk] - the sender pk
- * @prop {string} [input.tx.from] - the sender address, can be derived from wallet
- * @prop {number} [input.tx.nonce] - the tx nonce, defaults to Date.now if not set
- * @prop {string} [input.tx.chainId] - the chainId
- * @prop {string} [input.tx.signature] - transaction signature
- * @prop {array} [input.tx.signatures] - transaction signatures, should be set when it's a multisig transaction
- * @prop {object} input.wallet - the wallet used to sign the transaction, either a forge managed wallet or user managed wallet
- * @prop {string} [input.signature] - the signature of the tx, if this parameter exist, we will not sign the transaction
- */
-
-/**
- * Send MigrateRollupTokenTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
- *
- * @memberof GraphQLClient
- * @function
- * @name GraphQLClient#sendMigrateRollupTokenTx
- * @param {GraphQLClient.MigrateRollupTokenTxInput} params
+ * @name GraphQLClient#sendMigrateRollupTx
+ * @param {GraphQLClient.MigrateRollupTxInput} params
  * @param {object} extra
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
@@ -4216,6 +4223,16 @@
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */
 
+/**
+ * Encode a CloseRollupTx transaction for later use
+ *
+ * @name GraphQLClient#encodeCloseRollupTx
+ * @function
+ * @memberof GraphQLClient
+ * @param {GraphQLClient.CloseRollupTxInput} params
+ * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
+ */
+
 /**
  * Encode a CreateAssetTx transaction for later use
  *
@@ -4337,22 +4354,12 @@
  */
 
 /**
- * Encode a MigrateRollupContractTx transaction for later use
- *
- * @name GraphQLClient#encodeMigrateRollupContractTx
- * @function
- * @memberof GraphQLClient
- * @param {GraphQLClient.MigrateRollupContractTxInput} params
- * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
- */
-
-/**
- * Encode a MigrateRollupTokenTx transaction for later use
+ * Encode a MigrateRollupTx transaction for later use
  *
- * @name GraphQLClient#encodeMigrateRollupTokenTx
+ * @name GraphQLClient#encodeMigrateRollupTx
  * @function
  * @memberof GraphQLClient
- * @param {GraphQLClient.MigrateRollupTokenTxInput} params
+ * @param {GraphQLClient.MigrateRollupTxInput} params
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */