@ocap/client 1.21.2 → 1.22.0

package/lib/types.js

@@ -17,6 +17,7 @@
  * //   getTokenState,
  * //   getEvidenceState,
  * //   getForgeState,
+ * //   getTokenFactoryState,
  * //   getTx,
  * //   getBlock,
  * //   getBlocks,
@@ -48,6 +49,7 @@
  * //   listTokenFlows,
  * //   verifyAccountRisk,
  * //   getTokenDistribution,
+ * //   listTokenFactories,
  * // ]
  */
 
@@ -464,6 +466,7 @@
  * @property {...GraphQLClient.RollupFilterInput} rollupFilter
  * @property {...GraphQLClient.StakeFilterInput} stakeFilter
  * @property {...GraphQLClient.DelegationFilterInput} delegationFilter
+ * @property {...GraphQLClient.TokenFactoryFilterInput} tokenFactoryFilter
  */
 
 /**
@@ -522,6 +525,14 @@
  * @property {string} field
  */
 
+/**
+ * Structure of GraphQLClient.TokenFactoryFilterInput 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.TokenFactoryFilterInput
+ * @property {Array<string>} tokenFactories
+ */
+
 /**
  * Structure of GraphQLClient.TokenFilterInput 
  *
@@ -1111,6 +1122,18 @@
  * @property {...GraphQLClient.Any} data
  */
 
+/**
+ * Structure of GraphQLClient.CurveConfig 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.CurveConfig
+ * @property {string} type
+ * @property {string} basePrice
+ * @property {string} fixedPrice
+ * @property {string} slope
+ * @property {number} constant
+ */
+
 /**
  * Structure of GraphQLClient.DelegateConfig 
  *
@@ -1616,6 +1639,27 @@
  * @property {...GraphQLClient.Any} data
  */
 
+/**
+ * Structure of GraphQLClient.IndexedTokenFactoryState 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.IndexedTokenFactoryState
+ * @property {string} address
+ * @property {string} owner
+ * @property {string} tokenAddress
+ * @property {string} reserveAddress
+ * @property {...GraphQLClient.CurveConfig} curve
+ * @property {number} feeRate
+ * @property {string} currentSupply
+ * @property {string} reserveBalance
+ * @property {string} status
+ * @property {string} genesisTime
+ * @property {string} renaissanceTime
+ * @property {...GraphQLClient.IndexedTokenInput} token
+ * @property {...GraphQLClient.IndexedTokenInput} reserveToken
+ * @property {...GraphQLClient.Any} data
+ */
+
 /**
  * Structure of GraphQLClient.IndexedTokenFlow 
  *
@@ -1656,6 +1700,7 @@
  * @property {string} genesisTime
  * @property {string} renaissanceTime
  * @property {...GraphQLClient.ForeignToken} foreignToken
+ * @property {string} tokenFactoryAddress
  * @property {...GraphQLClient.Any} data
  */
 
@@ -2120,6 +2165,15 @@
  * @property {...GraphQLClient.TokenDistribution} data
  */
 
+/**
+ * Structure of GraphQLClient.ResponseGetTokenFactoryState 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.ResponseGetTokenFactoryState
+ * @property {string} code
+ * @property {...GraphQLClient.TokenFactoryState} state
+ */
+
 /**
  * Structure of GraphQLClient.ResponseGetTokenState 
  *
@@ -2247,6 +2301,16 @@
  * @property {Array<...GraphQLClient.IndexedStakeState>} stakes
  */
 
+/**
+ * Structure of GraphQLClient.ResponseListTokenFactories 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.ResponseListTokenFactories
+ * @property {string} code
+ * @property {...GraphQLClient.PageInfo} page
+ * @property {Array<...GraphQLClient.IndexedTokenFactoryState>} tokenFactories
+ */
+
 /**
  * Structure of GraphQLClient.ResponseListTokenFlows 
  *
@@ -2560,6 +2624,24 @@
  * @property {string} gasStake
  */
 
+/**
+ * Structure of GraphQLClient.TokenFactoryState 
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.TokenFactoryState
+ * @property {string} address
+ * @property {string} tokenAddress
+ * @property {string} reserveAddress
+ * @property {string} currentSupply
+ * @property {string} reserveBalance
+ * @property {number} feeRate
+ * @property {...GraphQLClient.CurveConfig} curve
+ * @property {...GraphQLClient.StateContext} context
+ * @property {...GraphQLClient.TokenState} token
+ * @property {...GraphQLClient.TokenState} reserveToken
+ * @property {...GraphQLClient.Any} data
+ */
+
 /**
  * Structure of GraphQLClient.TokenInfo 
  *
@@ -2615,6 +2697,7 @@
  * @property {string} icon
  * @property {string} totalSupply
  * @property {...GraphQLClient.ForeignToken} foreignToken
+ * @property {string} tokenFactoryAddress
  * @property {...GraphQLClient.StateContext} context
  * @property {...GraphQLClient.Any} data
  */
@@ -3158,6 +3241,21 @@
  * @property {Array<string>} keys
  */
 
+/**
+ * Structure of GraphQLClient.GetTokenFactoryStateParams 
+ *
+ * Checkout the following snippet for the format of GetTokenFactoryStateParams:
+ * ```json
+{
+  "address": "abc"
+}
+ * ```
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.GetTokenFactoryStateParams
+ * @property {string} address
+ */
+
 /**
  * Structure of GraphQLClient.GetTxParams 
  *
@@ -3328,6 +3426,7 @@
  * @property {...GraphQLClient.RollupFilterInput} rollupFilter
  * @property {...GraphQLClient.StakeFilterInput} stakeFilter
  * @property {...GraphQLClient.DelegationFilterInput} delegationFilter
+ * @property {...GraphQLClient.TokenFactoryFilterInput} tokenFactoryFilter
  */
 
 /**
@@ -3628,6 +3727,27 @@
  * @property {string} tokenAddress
  */
 
+/**
+ * Structure of GraphQLClient.ListTokenFactoriesParams 
+ *
+ * Checkout the following snippet for the format of ListTokenFactoriesParams:
+ * ```json
+{
+  "tokenAddress": "abc",
+  "reserveAddress": "abc",
+  "owner": "abc"
+}
+ * ```
+ *
+ * @memberof GraphQLClient
+ * @typedef {object} GraphQLClient.ListTokenFactoriesParams
+ * @property {string} tokenAddress
+ * @property {string} reserveAddress
+ * @property {string} owner
+ * @property {...GraphQLClient.PageInput} paging
+ * @property {...GraphQLClient.TimeFilterInput} timeFilter
+ */
+
 /**
  * Structure of GraphQLClient.SendTxParams 
  *
@@ -3732,6 +3852,33 @@
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
 
+/**
+ * @memberof GraphQLClient
+ * @typedef {Object} GraphQLClient.BurnTokenTxInput
+ * @prop {object} input
+ * @prop {object} input.tx - data of the transaction
+ * @prop {GraphQLClient.BurnTokenTx} 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 BurnTokenTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ *
+ * @memberof GraphQLClient
+ * @function
+ * @name GraphQLClient#sendBurnTokenTx
+ * @param {GraphQLClient.BurnTokenTxInput} params
+ * @param {object} extra
+ * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
+ */
+
 /**
  * @memberof GraphQLClient
  * @typedef {Object} GraphQLClient.ClaimBlockRewardTxInput
@@ -3948,6 +4095,33 @@
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
 
+/**
+ * @memberof GraphQLClient
+ * @typedef {Object} GraphQLClient.CreateTokenFactoryTxInput
+ * @prop {object} input
+ * @prop {object} input.tx - data of the transaction
+ * @prop {GraphQLClient.CreateTokenFactoryTx} 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 CreateTokenFactoryTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ *
+ * @memberof GraphQLClient
+ * @function
+ * @name GraphQLClient#sendCreateTokenFactoryTx
+ * @param {GraphQLClient.CreateTokenFactoryTxInput} params
+ * @param {object} extra
+ * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
+ */
+
 /**
  * @memberof GraphQLClient
  * @typedef {Object} GraphQLClient.CreateTokenTxInput
@@ -4191,6 +4365,33 @@
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
 
+/**
+ * @memberof GraphQLClient
+ * @typedef {Object} GraphQLClient.MintTokenTxInput
+ * @prop {object} input
+ * @prop {object} input.tx - data of the transaction
+ * @prop {GraphQLClient.MintTokenTx} 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 MintTokenTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ *
+ * @memberof GraphQLClient
+ * @function
+ * @name GraphQLClient#sendMintTokenTx
+ * @param {GraphQLClient.MintTokenTxInput} params
+ * @param {object} extra
+ * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
+ */
+
 /**
  * @memberof GraphQLClient
  * @typedef {Object} GraphQLClient.PauseRollupTxInput
@@ -4515,6 +4716,33 @@
  * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
  */
 
+/**
+ * @memberof GraphQLClient
+ * @typedef {Object} GraphQLClient.UpdateTokenFactoryTxInput
+ * @prop {object} input
+ * @prop {object} input.tx - data of the transaction
+ * @prop {GraphQLClient.UpdateTokenFactoryTx} 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 UpdateTokenFactoryTx transaction and get the hash, use {@link GraphQLClient#getTx} to get transaction detail
+ *
+ * @memberof GraphQLClient
+ * @function
+ * @name GraphQLClient#sendUpdateTokenFactoryTx
+ * @param {GraphQLClient.UpdateTokenFactoryTxInput} params
+ * @param {object} extra
+ * @returns {Promise<string>} returns transaction hash if success, otherwise error was thrown
+ */
+
 /**
  * @memberof GraphQLClient
  * @typedef {Object} GraphQLClient.UpgradeNodeTxInput
@@ -4599,6 +4827,16 @@
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */
 
+/**
+ * Encode a BurnTokenTx transaction for later use
+ *
+ * @name GraphQLClient#encodeBurnTokenTx
+ * @function
+ * @memberof GraphQLClient
+ * @param {GraphQLClient.BurnTokenTxInput} params
+ * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
+ */
+
 /**
  * Encode a ClaimBlockRewardTx transaction for later use
  *
@@ -4679,6 +4917,16 @@
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */
 
+/**
+ * Encode a CreateTokenFactoryTx transaction for later use
+ *
+ * @name GraphQLClient#encodeCreateTokenFactoryTx
+ * @function
+ * @memberof GraphQLClient
+ * @param {GraphQLClient.CreateTokenFactoryTxInput} params
+ * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
+ */
+
 /**
  * Encode a CreateTokenTx transaction for later use
  *
@@ -4769,6 +5017,16 @@
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */
 
+/**
+ * Encode a MintTokenTx transaction for later use
+ *
+ * @name GraphQLClient#encodeMintTokenTx
+ * @function
+ * @memberof GraphQLClient
+ * @param {GraphQLClient.MintTokenTxInput} params
+ * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
+ */
+
 /**
  * Encode a PauseRollupTx transaction for later use
  *
@@ -4889,6 +5147,16 @@
  * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
  */
 
+/**
+ * Encode a UpdateTokenFactoryTx transaction for later use
+ *
+ * @name GraphQLClient#encodeUpdateTokenFactoryTx
+ * @function
+ * @memberof GraphQLClient
+ * @param {GraphQLClient.UpdateTokenFactoryTxInput} params
+ * @returns {Promise<GraphQLClient.TxEncodeOutput>} result - we provide two formats of the encoding result, binary presentation and human readable object
+ */
+
 /**
  * Encode a UpgradeNodeTx transaction for later use
  *
@@ -4979,6 +5247,16 @@
  * @returns {Promise<GraphQLClient.ResponseGetForgeState>} Checkout {@link GraphQLClient.ResponseGetForgeState} for resolved data format
  */
 
+/**
+ * getTokenFactoryState
+ *
+ * @name GraphQLClient#getTokenFactoryState
+ * @param {GraphQLClient.GetTokenFactoryStateParams} params
+ * @function
+ * @memberof GraphQLClient
+ * @returns {Promise<GraphQLClient.ResponseGetTokenFactoryState>} Checkout {@link GraphQLClient.ResponseGetTokenFactoryState} for resolved data format
+ */
+
 /**
  * getTx
  *
@@ -5284,6 +5562,16 @@
  * @returns {Promise<GraphQLClient.ResponseGetTokenDistribution>} Checkout {@link GraphQLClient.ResponseGetTokenDistribution} for resolved data format
  */
 
+/**
+ * listTokenFactories
+ *
+ * @name GraphQLClient#listTokenFactories
+ * @param {GraphQLClient.ListTokenFactoriesParams} params
+ * @function
+ * @memberof GraphQLClient
+ * @returns {Promise<GraphQLClient.ResponseListTokenFactories>} Checkout {@link GraphQLClient.ResponseListTokenFactories} for resolved data format
+ */
+
 /**
  * sendTx
  *