@ocap/client 1.30.25 → 1.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/types.js CHANGED
@@ -1376,6 +1376,7 @@
1376
1376
  * @typedef {object} GraphQLClient.DelegateLimit
1377
1377
  * @property {Array<...GraphQLClient.TokenLimit>} tokens
1378
1378
  * @property {Array<...GraphQLClient.AssetLimit>} assets
1379
+ * @property {boolean} unlimited
1379
1380
  */
1380
1381
 
1381
1382
  /**
@@ -1991,6 +1992,57 @@
1991
1992
  * @property {...GraphQLClient.Any} data
1992
1993
  */
1993
1994
 
1995
+ /**
1996
+ * Structure of GraphQLClient.LedgerCheckpoint
1997
+ *
1998
+ * @memberof GraphQLClient
1999
+ * @typedef {object} GraphQLClient.LedgerCheckpoint
2000
+ * @property {number} height
2001
+ * @property {number} sequence
2002
+ * @property {number} prevSequence
2003
+ * @property {string} txRoot
2004
+ * @property {number} txCount
2005
+ * @property {string} stateRoot
2006
+ * @property {string} timestamp
2007
+ * @property {string} prevCheckpoint
2008
+ * @property {string} proposer
2009
+ * @property {string} hash
2010
+ * @property {string} signature
2011
+ */
2012
+
2013
+ /**
2014
+ * Structure of GraphQLClient.LedgerEntry
2015
+ *
2016
+ * @memberof GraphQLClient
2017
+ * @typedef {object} GraphQLClient.LedgerEntry
2018
+ * @property {number} sequence
2019
+ * @property {string} hash
2020
+ * @property {string} from
2021
+ * @property {number} nonce
2022
+ * @property {string} pk
2023
+ * @property {string} signature
2024
+ * @property {string} txRaw
2025
+ * @property {object} tx
2026
+ * @property {string} txType
2027
+ * @property {string} timestamp
2028
+ * @property {string} chainId
2029
+ * @property {string} entryHash
2030
+ * @property {object} txExtra
2031
+ * @property {string} stateCommitHash
2032
+ * @property {boolean} finalized
2033
+ */
2034
+
2035
+ /**
2036
+ * Structure of GraphQLClient.LedgerMerkleProof
2037
+ *
2038
+ * @memberof GraphQLClient
2039
+ * @typedef {object} GraphQLClient.LedgerMerkleProof
2040
+ * @property {number} index
2041
+ * @property {string} leaf
2042
+ * @property {Array<string>} proof
2043
+ * @property {string} root
2044
+ */
2045
+
1994
2046
  /**
1995
2047
  * Structure of GraphQLClient.MigrateRollupTx
1996
2048
  *
@@ -2051,6 +2103,7 @@
2051
2103
  * @property {string} pk
2052
2104
  * @property {string} signature
2053
2105
  * @property {string} delegator
2106
+ * @property {string} extra
2054
2107
  * @property {...GraphQLClient.Any} data
2055
2108
  */
2056
2109
 
@@ -2343,6 +2396,76 @@
2343
2396
  * @property {...GraphQLClient.ForgeStats} forgeStats
2344
2397
  */
2345
2398
 
2399
+ /**
2400
+ * Structure of GraphQLClient.ResponseGetLatestCheckpoint
2401
+ *
2402
+ * Checkout the following snippet for the format of ResponseGetLatestCheckpoint:
2403
+ * ```json
2404
+ {
2405
+ "code": "abc",
2406
+ "checkpoint": {
2407
+ "height": 123,
2408
+ "sequence": 123,
2409
+ "prevSequence": 123,
2410
+ "txRoot": "abc",
2411
+ "txCount": 123,
2412
+ "stateRoot": "abc",
2413
+ "timestamp": "abc",
2414
+ "prevCheckpoint": "abc",
2415
+ "proposer": "abc",
2416
+ "hash": "abc",
2417
+ "signature": "abc"
2418
+ }
2419
+ }
2420
+ * ```
2421
+ *
2422
+ * @memberof GraphQLClient
2423
+ * @typedef {object} GraphQLClient.ResponseGetLatestCheckpoint
2424
+ * @property {string} code
2425
+ * @property {...GraphQLClient.LedgerCheckpoint} checkpoint
2426
+ */
2427
+
2428
+ /**
2429
+ * Structure of GraphQLClient.ResponseGetLedgerEntry
2430
+ *
2431
+ * Checkout the following snippet for the format of ResponseGetLedgerEntry:
2432
+ * ```json
2433
+ {
2434
+ "code": "abc",
2435
+ "entry": {
2436
+ "sequence": 123,
2437
+ "hash": "abc",
2438
+ "from": "abc",
2439
+ "nonce": 123,
2440
+ "pk": "abc",
2441
+ "signature": "abc",
2442
+ "txRaw": "abc",
2443
+ "txType": "abc",
2444
+ "timestamp": "abc",
2445
+ "chainId": "abc",
2446
+ "entryHash": "abc",
2447
+ "stateCommitHash": "abc",
2448
+ "finalized": true
2449
+ }
2450
+ }
2451
+ * ```
2452
+ *
2453
+ * @memberof GraphQLClient
2454
+ * @typedef {object} GraphQLClient.ResponseGetLedgerEntry
2455
+ * @property {string} code
2456
+ * @property {...GraphQLClient.LedgerEntry} entry
2457
+ */
2458
+
2459
+ /**
2460
+ * Structure of GraphQLClient.ResponseGetMerkleProof
2461
+ *
2462
+ * @memberof GraphQLClient
2463
+ * @typedef {object} GraphQLClient.ResponseGetMerkleProof
2464
+ * @property {string} code
2465
+ * @property {...GraphQLClient.LedgerMerkleProof} proof
2466
+ * @property {...GraphQLClient.LedgerCheckpoint} checkpoint
2467
+ */
2468
+
2346
2469
  /**
2347
2470
  * Structure of GraphQLClient.ResponseGetNetInfo
2348
2471
  *
@@ -2618,7 +2741,27 @@
2618
2741
  * ```json
2619
2742
  {
2620
2743
  "code": "abc",
2621
- "hash": "abc"
2744
+ "hash": "abc",
2745
+ "warning": {
2746
+ "tier": "abc",
2747
+ "code": "abc",
2748
+ "message": "abc",
2749
+ "actor": "abc",
2750
+ "strikeCount": 123,
2751
+ "warningThreshold": 123,
2752
+ "throttleThreshold": 123,
2753
+ "slashThreshold": 123,
2754
+ "gasStakeQuotaRemaining": 123,
2755
+ "cooldownUntilMs": 123,
2756
+ "telemetry": {
2757
+ "loadRatio": 123,
2758
+ "remainingNormalQuota": 123,
2759
+ "currentGasMultiplier": 123,
2760
+ "nextTxEstimatedGas": "abc",
2761
+ "recommendedBackoffMs": 123,
2762
+ "stakeRequiredFor1x": "abc"
2763
+ }
2764
+ }
2622
2765
  }
2623
2766
  * ```
2624
2767
  *
@@ -2626,6 +2769,7 @@
2626
2769
  * @typedef {object} GraphQLClient.ResponseSendTx
2627
2770
  * @property {string} code
2628
2771
  * @property {string} hash
2772
+ * @property {...GraphQLClient.TxSecurityWarning} warning
2629
2773
  */
2630
2774
 
2631
2775
  /**
@@ -2945,6 +3089,16 @@
2945
3089
  * @property {number} lastTx
2946
3090
  * @property {number} decimal
2947
3091
  * @property {string} symbol
3092
+ * @property {string} maxPerTx
3093
+ * @property {string} windowLimit
3094
+ * @property {number} windowSeconds
3095
+ * @property {number} windowStart
3096
+ * @property {string} windowSpent
3097
+ * @property {string} coSignAllowance
3098
+ * @property {boolean} coSignRequired
3099
+ * @property {boolean} requirePinnedPayee
3100
+ * @property {boolean} notifyBeforeDebit
3101
+ * @property {number} notifyLeadSeconds
2948
3102
  */
2949
3103
 
2950
3104
  /**
@@ -3124,6 +3278,37 @@
3124
3278
  * @property {number} stakeLockPeriod
3125
3279
  */
3126
3280
 
3281
+ /**
3282
+ * Structure of GraphQLClient.TxGasQuotaTelemetry
3283
+ *
3284
+ * @memberof GraphQLClient
3285
+ * @typedef {object} GraphQLClient.TxGasQuotaTelemetry
3286
+ * @property {number} loadRatio
3287
+ * @property {number} remainingNormalQuota
3288
+ * @property {number} currentGasMultiplier
3289
+ * @property {string} nextTxEstimatedGas
3290
+ * @property {number} recommendedBackoffMs
3291
+ * @property {string} stakeRequiredFor1x
3292
+ */
3293
+
3294
+ /**
3295
+ * Structure of GraphQLClient.TxSecurityWarning
3296
+ *
3297
+ * @memberof GraphQLClient
3298
+ * @typedef {object} GraphQLClient.TxSecurityWarning
3299
+ * @property {string} tier
3300
+ * @property {string} code
3301
+ * @property {string} message
3302
+ * @property {string} actor
3303
+ * @property {number} strikeCount
3304
+ * @property {number} warningThreshold
3305
+ * @property {number} throttleThreshold
3306
+ * @property {number} slashThreshold
3307
+ * @property {number} gasStakeQuotaRemaining
3308
+ * @property {number} cooldownUntilMs
3309
+ * @property {...GraphQLClient.TxGasQuotaTelemetry} telemetry
3310
+ */
3311
+
3127
3312
  /**
3128
3313
  * Structure of GraphQLClient.TxStakeConfig
3129
3314
  *
@@ -3637,6 +3822,53 @@
3637
3822
  * @property {boolean} parsed
3638
3823
  */
3639
3824
 
3825
+ /**
3826
+ * Structure of GraphQLClient.GetLatestCheckpointParams
3827
+ *
3828
+ * Checkout the following snippet for the format of GetLatestCheckpointParams:
3829
+ * ```json
3830
+ {
3831
+ "height": 123
3832
+ }
3833
+ * ```
3834
+ *
3835
+ * @memberof GraphQLClient
3836
+ * @typedef {object} GraphQLClient.GetLatestCheckpointParams
3837
+ * @property {number} height
3838
+ */
3839
+
3840
+ /**
3841
+ * Structure of GraphQLClient.GetLedgerEntryParams
3842
+ *
3843
+ * Checkout the following snippet for the format of GetLedgerEntryParams:
3844
+ * ```json
3845
+ {
3846
+ "hash": "abc",
3847
+ "sequence": 123
3848
+ }
3849
+ * ```
3850
+ *
3851
+ * @memberof GraphQLClient
3852
+ * @typedef {object} GraphQLClient.GetLedgerEntryParams
3853
+ * @property {string} hash
3854
+ * @property {number} sequence
3855
+ */
3856
+
3857
+ /**
3858
+ * Structure of GraphQLClient.GetMerkleProofParams
3859
+ *
3860
+ * Checkout the following snippet for the format of GetMerkleProofParams:
3861
+ * ```json
3862
+ {
3863
+ "sequence": 123
3864
+ }
3865
+ * ```
3866
+ *
3867
+ * @memberof GraphQLClient
3868
+ * @typedef {object} GraphQLClient.GetMerkleProofParams
3869
+ * @property {number} sequence
3870
+ */
3871
+
3640
3872
  /**
3641
3873
  * Structure of GraphQLClient.ListAssetTransactionsParams
3642
3874
  *
@@ -5661,6 +5893,36 @@
5661
5893
  * @returns {Promise<GraphQLClient.ResponseGetForgeStats>} Checkout {@link GraphQLClient.ResponseGetForgeStats} for resolved data format
5662
5894
  */
5663
5895
 
5896
+ /**
5897
+ * getLatestCheckpoint
5898
+ *
5899
+ * @name GraphQLClient#getLatestCheckpoint
5900
+ * @param {GraphQLClient.GetLatestCheckpointParams} params
5901
+ * @function
5902
+ * @memberof GraphQLClient
5903
+ * @returns {Promise<GraphQLClient.ResponseGetLatestCheckpoint>} Checkout {@link GraphQLClient.ResponseGetLatestCheckpoint} for resolved data format
5904
+ */
5905
+
5906
+ /**
5907
+ * getLedgerEntry
5908
+ *
5909
+ * @name GraphQLClient#getLedgerEntry
5910
+ * @param {GraphQLClient.GetLedgerEntryParams} params
5911
+ * @function
5912
+ * @memberof GraphQLClient
5913
+ * @returns {Promise<GraphQLClient.ResponseGetLedgerEntry>} Checkout {@link GraphQLClient.ResponseGetLedgerEntry} for resolved data format
5914
+ */
5915
+
5916
+ /**
5917
+ * getMerkleProof
5918
+ *
5919
+ * @name GraphQLClient#getMerkleProof
5920
+ * @param {GraphQLClient.GetMerkleProofParams} params
5921
+ * @function
5922
+ * @memberof GraphQLClient
5923
+ * @returns {Promise<GraphQLClient.ResponseGetMerkleProof>} Checkout {@link GraphQLClient.ResponseGetMerkleProof} for resolved data format
5924
+ */
5925
+
5664
5926
  /**
5665
5927
  * listAssetTransactions
5666
5928
  *