@ocap/client 1.18.18 → 1.18.19

package/lib/types.js

@@ -1179,6 +1179,7 @@
  * @property {...GraphQLClient.TransactionConfig} txConfig
  * @property {...GraphQLClient.UpgradeInfo} upgradeInfo
  * @property {Array<...GraphQLClient.AccountConfig>} accountConfig
+ * @property {...GraphQLClient.VaultConfig} vaults
  * @property {...GraphQLClient.Any} data
  */
 
@@ -1456,6 +1457,7 @@
  * @property {number} revokeWaitingPeriod
  * @property {Array<...GraphQLClient.TokenInfo>} revokedTokens
  * @property {Array<string>} revokedAssets
+ * @property {Array<string>} slashers
  * @property {...GraphQLClient.Any} data
  */
 
@@ -2243,6 +2245,17 @@
  * @property {string} id
  */
 
+/**
+ * Structure of GraphQLClient.SlashStakeTx 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.SlashStakeTx
+ * @property {string} address
+ * @property {Array<...GraphQLClient.TransactionInput>} outputs
+ * @property {string} message
+ * @property {...GraphQLClient.Any} data
+ */
+
 /**
  * Structure of GraphQLClient.StakeState 
  *
@@ -2258,6 +2271,7 @@
  * @property {number} revokeWaitingPeriod
  * @property {Array<...GraphQLClient.IndexedTokenInput>} revokedTokens
  * @property {Array<string>} revokedAssets
+ * @property {Array<string>} slashers
  * @property {...GraphQLClient.StateContext} context
  * @property {...GraphQLClient.Any} data
  */
@@ -2273,6 +2287,7 @@
  * @property {boolean} locked
  * @property {string} message
  * @property {number} revokeWaitingPeriod
+ * @property {Array<string>} slashers
  * @property {...GraphQLClient.Any} data
  */
 
@@ -2649,6 +2664,16 @@
  * @property {boolean} required
  */
 
+/**
+ * Structure of GraphQLClient.VaultConfig 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.VaultConfig
+ * @property {string} slashedStake
+ * @property {string} txFee
+ * @property {Array<string>} txGas
+ */
+
 /**
  * Structure of GraphQLClient.Version 
  *
@@ -3888,6 +3913,33 @@
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
 
+/**
+ * @memberof GraphQLClient
+ * @typedef {Object} GraphQLClient.SlashStakeTxInput
+ * @prop {object} input
+ * @prop {object} input.tx - data of the transaction
+ * @prop {GraphQLClient.SlashStakeTx} 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 SlashStakeTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ *
+ * @memberof GraphQLClient
+ * @function
+ * @name GraphQLClient#sendSlashStakeTx
+ * @param {GraphQLClient.SlashStakeTxInput} params
+ * @param {object} extra
+ * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
+ */
+
 /**
  * @memberof GraphQLClient
  * @typedef {Object} GraphQLClient.StakeTxInput
@@ -4344,6 +4396,16 @@
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */
 
+/**
+ * Encode a SlashStakeTx transaction for later use
+ *
+ * @name GraphQLClient#encodeSlashStakeTx
+ * @function
+ * @memberof GraphQLClient
+ * @param {GraphQLClient.SlashStakeTxInput} params
+ * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
+ */
+
 /**
  * Encode a StakeTx transaction for later use
  *