@ocap/client 1.30.26 → 1.31.1

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/dist/types.js CHANGED
@@ -162,6 +162,7 @@
162
162
  * @property {string} sender
163
163
  * @property {string} receiver
164
164
  * @property {...GraphQLClient.Direction} direction
165
+ * @property {string} gasPayer
165
166
  */
166
167
 
167
168
  /**
@@ -750,6 +751,7 @@
750
751
  * @memberof GraphQLClient
751
752
  * @typedef {object} GraphQLClient.TxFilterInput
752
753
  * @property {Array<string>} txs
754
+ * @property {string} gasPayer
753
755
  */
754
756
 
755
757
  /**
@@ -1376,6 +1378,7 @@
1376
1378
  * @typedef {object} GraphQLClient.DelegateLimit
1377
1379
  * @property {Array<...GraphQLClient.TokenLimit>} tokens
1378
1380
  * @property {Array<...GraphQLClient.AssetLimit>} assets
1381
+ * @property {boolean} unlimited
1379
1382
  */
1380
1383
 
1381
1384
  /**
@@ -1957,6 +1960,7 @@
1957
1960
  * @property {string} code
1958
1961
  * @property {Array<...GraphQLClient.TokenMeta>} tokenSymbols
1959
1962
  * @property {Array<...GraphQLClient.TransactionReceipt>} receipts
1963
+ * @property {string} gasPayer
1960
1964
  */
1961
1965
 
1962
1966
  /**
@@ -1991,6 +1995,57 @@
1991
1995
  * @property {...GraphQLClient.Any} data
1992
1996
  */
1993
1997
 
1998
+ /**
1999
+ * Structure of GraphQLClient.LedgerCheckpoint
2000
+ *
2001
+ * @memberof GraphQLClient
2002
+ * @typedef {object} GraphQLClient.LedgerCheckpoint
2003
+ * @property {number} height
2004
+ * @property {number} sequence
2005
+ * @property {number} prevSequence
2006
+ * @property {string} txRoot
2007
+ * @property {number} txCount
2008
+ * @property {string} stateRoot
2009
+ * @property {string} timestamp
2010
+ * @property {string} prevCheckpoint
2011
+ * @property {string} proposer
2012
+ * @property {string} hash
2013
+ * @property {string} signature
2014
+ */
2015
+
2016
+ /**
2017
+ * Structure of GraphQLClient.LedgerEntry
2018
+ *
2019
+ * @memberof GraphQLClient
2020
+ * @typedef {object} GraphQLClient.LedgerEntry
2021
+ * @property {number} sequence
2022
+ * @property {string} hash
2023
+ * @property {string} from
2024
+ * @property {string} nonce
2025
+ * @property {string} pk
2026
+ * @property {string} signature
2027
+ * @property {string} txRaw
2028
+ * @property {object} tx
2029
+ * @property {string} txType
2030
+ * @property {string} timestamp
2031
+ * @property {string} chainId
2032
+ * @property {string} entryHash
2033
+ * @property {object} txExtra
2034
+ * @property {string} stateCommitHash
2035
+ * @property {boolean} finalized
2036
+ */
2037
+
2038
+ /**
2039
+ * Structure of GraphQLClient.LedgerMerkleProof
2040
+ *
2041
+ * @memberof GraphQLClient
2042
+ * @typedef {object} GraphQLClient.LedgerMerkleProof
2043
+ * @property {number} index
2044
+ * @property {string} leaf
2045
+ * @property {Array<string>} proof
2046
+ * @property {string} root
2047
+ */
2048
+
1994
2049
  /**
1995
2050
  * Structure of GraphQLClient.MigrateRollupTx
1996
2051
  *
@@ -2051,6 +2106,7 @@
2051
2106
  * @property {string} pk
2052
2107
  * @property {string} signature
2053
2108
  * @property {string} delegator
2109
+ * @property {string} extra
2054
2110
  * @property {...GraphQLClient.Any} data
2055
2111
  */
2056
2112
 
@@ -2343,6 +2399,76 @@
2343
2399
  * @property {...GraphQLClient.ForgeStats} forgeStats
2344
2400
  */
2345
2401
 
2402
+ /**
2403
+ * Structure of GraphQLClient.ResponseGetLatestCheckpoint
2404
+ *
2405
+ * Checkout the following snippet for the format of ResponseGetLatestCheckpoint:
2406
+ * ```json
2407
+ {
2408
+ "code": "abc",
2409
+ "checkpoint": {
2410
+ "height": 123,
2411
+ "sequence": 123,
2412
+ "prevSequence": 123,
2413
+ "txRoot": "abc",
2414
+ "txCount": 123,
2415
+ "stateRoot": "abc",
2416
+ "timestamp": "abc",
2417
+ "prevCheckpoint": "abc",
2418
+ "proposer": "abc",
2419
+ "hash": "abc",
2420
+ "signature": "abc"
2421
+ }
2422
+ }
2423
+ * ```
2424
+ *
2425
+ * @memberof GraphQLClient
2426
+ * @typedef {object} GraphQLClient.ResponseGetLatestCheckpoint
2427
+ * @property {string} code
2428
+ * @property {...GraphQLClient.LedgerCheckpoint} checkpoint
2429
+ */
2430
+
2431
+ /**
2432
+ * Structure of GraphQLClient.ResponseGetLedgerEntry
2433
+ *
2434
+ * Checkout the following snippet for the format of ResponseGetLedgerEntry:
2435
+ * ```json
2436
+ {
2437
+ "code": "abc",
2438
+ "entry": {
2439
+ "sequence": 123,
2440
+ "hash": "abc",
2441
+ "from": "abc",
2442
+ "nonce": "abc",
2443
+ "pk": "abc",
2444
+ "signature": "abc",
2445
+ "txRaw": "abc",
2446
+ "txType": "abc",
2447
+ "timestamp": "abc",
2448
+ "chainId": "abc",
2449
+ "entryHash": "abc",
2450
+ "stateCommitHash": "abc",
2451
+ "finalized": true
2452
+ }
2453
+ }
2454
+ * ```
2455
+ *
2456
+ * @memberof GraphQLClient
2457
+ * @typedef {object} GraphQLClient.ResponseGetLedgerEntry
2458
+ * @property {string} code
2459
+ * @property {...GraphQLClient.LedgerEntry} entry
2460
+ */
2461
+
2462
+ /**
2463
+ * Structure of GraphQLClient.ResponseGetMerkleProof
2464
+ *
2465
+ * @memberof GraphQLClient
2466
+ * @typedef {object} GraphQLClient.ResponseGetMerkleProof
2467
+ * @property {string} code
2468
+ * @property {...GraphQLClient.LedgerMerkleProof} proof
2469
+ * @property {...GraphQLClient.LedgerCheckpoint} checkpoint
2470
+ */
2471
+
2346
2472
  /**
2347
2473
  * Structure of GraphQLClient.ResponseGetNetInfo
2348
2474
  *
@@ -2618,7 +2744,27 @@
2618
2744
  * ```json
2619
2745
  {
2620
2746
  "code": "abc",
2621
- "hash": "abc"
2747
+ "hash": "abc",
2748
+ "warning": {
2749
+ "tier": "abc",
2750
+ "code": "abc",
2751
+ "message": "abc",
2752
+ "actor": "abc",
2753
+ "strikeCount": 123,
2754
+ "warningThreshold": 123,
2755
+ "throttleThreshold": 123,
2756
+ "slashThreshold": 123,
2757
+ "gasStakeQuotaRemaining": 123,
2758
+ "cooldownUntilMs": 123,
2759
+ "telemetry": {
2760
+ "loadRatio": 123,
2761
+ "remainingNormalQuota": 123,
2762
+ "currentGasMultiplier": 123,
2763
+ "nextTxEstimatedGas": "abc",
2764
+ "recommendedBackoffMs": 123,
2765
+ "stakeRequiredFor1x": "abc"
2766
+ }
2767
+ }
2622
2768
  }
2623
2769
  * ```
2624
2770
  *
@@ -2626,6 +2772,7 @@
2626
2772
  * @typedef {object} GraphQLClient.ResponseSendTx
2627
2773
  * @property {string} code
2628
2774
  * @property {string} hash
2775
+ * @property {...GraphQLClient.TxSecurityWarning} warning
2629
2776
  */
2630
2777
 
2631
2778
  /**
@@ -2945,6 +3092,16 @@
2945
3092
  * @property {number} lastTx
2946
3093
  * @property {number} decimal
2947
3094
  * @property {string} symbol
3095
+ * @property {string} maxPerTx
3096
+ * @property {string} windowLimit
3097
+ * @property {number} windowSeconds
3098
+ * @property {number} windowStart
3099
+ * @property {string} windowSpent
3100
+ * @property {string} coSignAllowance
3101
+ * @property {boolean} coSignRequired
3102
+ * @property {boolean} requirePinnedPayee
3103
+ * @property {boolean} notifyBeforeDebit
3104
+ * @property {number} notifyLeadSeconds
2948
3105
  */
2949
3106
 
2950
3107
  /**
@@ -3015,6 +3172,7 @@
3015
3172
  * @property {string} serviceFee
3016
3173
  * @property {string} gasFee
3017
3174
  * @property {string} gasPaid
3175
+ * @property {string} gasPayer
3018
3176
  */
3019
3177
 
3020
3178
  /**
@@ -3124,6 +3282,37 @@
3124
3282
  * @property {number} stakeLockPeriod
3125
3283
  */
3126
3284
 
3285
+ /**
3286
+ * Structure of GraphQLClient.TxGasQuotaTelemetry
3287
+ *
3288
+ * @memberof GraphQLClient
3289
+ * @typedef {object} GraphQLClient.TxGasQuotaTelemetry
3290
+ * @property {number} loadRatio
3291
+ * @property {number} remainingNormalQuota
3292
+ * @property {number} currentGasMultiplier
3293
+ * @property {string} nextTxEstimatedGas
3294
+ * @property {number} recommendedBackoffMs
3295
+ * @property {string} stakeRequiredFor1x
3296
+ */
3297
+
3298
+ /**
3299
+ * Structure of GraphQLClient.TxSecurityWarning
3300
+ *
3301
+ * @memberof GraphQLClient
3302
+ * @typedef {object} GraphQLClient.TxSecurityWarning
3303
+ * @property {string} tier
3304
+ * @property {string} code
3305
+ * @property {string} message
3306
+ * @property {string} actor
3307
+ * @property {number} strikeCount
3308
+ * @property {number} warningThreshold
3309
+ * @property {number} throttleThreshold
3310
+ * @property {number} slashThreshold
3311
+ * @property {number} gasStakeQuotaRemaining
3312
+ * @property {number} cooldownUntilMs
3313
+ * @property {...GraphQLClient.TxGasQuotaTelemetry} telemetry
3314
+ */
3315
+
3127
3316
  /**
3128
3317
  * Structure of GraphQLClient.TxStakeConfig
3129
3318
  *
@@ -3637,6 +3826,53 @@
3637
3826
  * @property {boolean} parsed
3638
3827
  */
3639
3828
 
3829
+ /**
3830
+ * Structure of GraphQLClient.GetLatestCheckpointParams
3831
+ *
3832
+ * Checkout the following snippet for the format of GetLatestCheckpointParams:
3833
+ * ```json
3834
+ {
3835
+ "height": 123
3836
+ }
3837
+ * ```
3838
+ *
3839
+ * @memberof GraphQLClient
3840
+ * @typedef {object} GraphQLClient.GetLatestCheckpointParams
3841
+ * @property {number} height
3842
+ */
3843
+
3844
+ /**
3845
+ * Structure of GraphQLClient.GetLedgerEntryParams
3846
+ *
3847
+ * Checkout the following snippet for the format of GetLedgerEntryParams:
3848
+ * ```json
3849
+ {
3850
+ "hash": "abc",
3851
+ "sequence": 123
3852
+ }
3853
+ * ```
3854
+ *
3855
+ * @memberof GraphQLClient
3856
+ * @typedef {object} GraphQLClient.GetLedgerEntryParams
3857
+ * @property {string} hash
3858
+ * @property {number} sequence
3859
+ */
3860
+
3861
+ /**
3862
+ * Structure of GraphQLClient.GetMerkleProofParams
3863
+ *
3864
+ * Checkout the following snippet for the format of GetMerkleProofParams:
3865
+ * ```json
3866
+ {
3867
+ "sequence": 123
3868
+ }
3869
+ * ```
3870
+ *
3871
+ * @memberof GraphQLClient
3872
+ * @typedef {object} GraphQLClient.GetMerkleProofParams
3873
+ * @property {number} sequence
3874
+ */
3875
+
3640
3876
  /**
3641
3877
  * Structure of GraphQLClient.ListAssetTransactionsParams
3642
3878
  *
@@ -5661,6 +5897,36 @@
5661
5897
  * @returns {Promise<GraphQLClient.ResponseGetForgeStats>} Checkout {@link GraphQLClient.ResponseGetForgeStats} for resolved data format
5662
5898
  */
5663
5899
 
5900
+ /**
5901
+ * getLatestCheckpoint
5902
+ *
5903
+ * @name GraphQLClient#getLatestCheckpoint
5904
+ * @param {GraphQLClient.GetLatestCheckpointParams} params
5905
+ * @function
5906
+ * @memberof GraphQLClient
5907
+ * @returns {Promise<GraphQLClient.ResponseGetLatestCheckpoint>} Checkout {@link GraphQLClient.ResponseGetLatestCheckpoint} for resolved data format
5908
+ */
5909
+
5910
+ /**
5911
+ * getLedgerEntry
5912
+ *
5913
+ * @name GraphQLClient#getLedgerEntry
5914
+ * @param {GraphQLClient.GetLedgerEntryParams} params
5915
+ * @function
5916
+ * @memberof GraphQLClient
5917
+ * @returns {Promise<GraphQLClient.ResponseGetLedgerEntry>} Checkout {@link GraphQLClient.ResponseGetLedgerEntry} for resolved data format
5918
+ */
5919
+
5920
+ /**
5921
+ * getMerkleProof
5922
+ *
5923
+ * @name GraphQLClient#getMerkleProof
5924
+ * @param {GraphQLClient.GetMerkleProofParams} params
5925
+ * @function
5926
+ * @memberof GraphQLClient
5927
+ * @returns {Promise<GraphQLClient.ResponseGetMerkleProof>} Checkout {@link GraphQLClient.ResponseGetMerkleProof} for resolved data format
5928
+ */
5929
+
5664
5930
  /**
5665
5931
  * listAssetTransactions
5666
5932
  *