@taquito/rpc 24.2.0 → 24.3.0-beta.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.
@@ -5,7 +5,7 @@
5
5
  import { HttpBackend } from '@taquito/http-utils';
6
6
  import BigNumber from 'bignumber.js';
7
7
  import { RpcClientInterface, RPCOptions } from './rpc-client-interface';
8
- import { BakingRightsQueryArguments, BakingRightsResponse, BalanceResponse, UnstakeRequestsResponse, BallotListResponse, BallotsResponse, BigMapResponse, BlockHeaderResponse, BlockMetadata, BlockResponse, ConstantsResponse, ContractResponse, CurrentProposalResponse, CurrentQuorumResponse, DelegateResponse, DelegatesResponse, VotingInfoResponse, AttestationRightsQueryArguments, AttestationRightsResponse, EntrypointsResponse, ForgeOperationsParams, ManagerKeyResponse, OperationHash, PackDataParams, PreapplyParams, PreapplyResponse, ProposalsResponse, ProtocolsResponse, RPCRunCodeParam, RPCRunViewParam, RPCRunScriptViewParam, RunCodeResult, RunViewResult, RunScriptViewResult, SaplingDiffResponse, ScriptResponse, StorageResponse, UnparsingMode, VotesListingsResponse, VotingPeriodBlockResult, TicketTokenParams, AllTicketBalances, PendingOperationsQueryArguments, PendingOperationsV2, RPCSimulateOperationParam, AILaunchCycleResponse, AllDelegatesQueryArguments, ProtocolActivationsResponse, ActiveStakingParametersResponse, PendingStakingParametersResponse, DestinationIndexResponse } from './types';
8
+ import { BakingRightsQueryArguments, BakingRightsResponse, BalanceResponse, UnstakeRequestsResponse, BallotListResponse, BallotsResponse, BigMapResponse, BlockHeaderResponse, BlockMetadata, BlockResponse, ConstantsResponse, ContractResponse, CurrentProposalResponse, CurrentQuorumResponse, DelegateResponse, DelegatesResponse, VotingInfoResponse, AttestationRightsQueryArguments, AttestationRightsResponse, EntrypointsResponse, ForgeOperationsParams, ManagerKeyResponse, OperationHash, PackDataParams, PreapplyParams, PreapplyResponse, ProposalsResponse, ProtocolsResponse, RPCRunCodeParam, RPCRunViewParam, RPCRunScriptViewParam, RunCodeResult, RunViewResult, RunScriptViewResult, SaplingDiffResponse, ScriptResponse, StorageResponse, UnparsingMode, VotesListingsResponse, VotingPeriodBlockResult, TicketTokenParams, AllTicketBalances, PendingOperationsQueryArguments, PendingOperationsV2, RPCSimulateOperationParam, AILaunchCycleResponse, AllDelegatesQueryArguments, ProtocolActivationsResponse, ActiveStakingParametersResponse, PendingStakingParametersResponse, DestinationIndexResponse, MempoolFilterQueryArguments, MempoolFilterResponse } from './types';
9
9
  export { castToBigNumber } from './utils/utils';
10
10
  export { RPCOptions, defaultChain, defaultRPCOptions, RpcClientInterface, } from './rpc-client-interface';
11
11
  export { RpcClientCache } from './rpc-client-modules/rpc-cache';
@@ -13,7 +13,7 @@ export * from './types';
13
13
  export { OpKind } from './opkind';
14
14
  export { VERSION } from './version';
15
15
  /***
16
- * @description RpcClient allows interaction with Tezos network through an rpc node
16
+ * RpcClient allows interaction with Tezos network through an rpc node
17
17
  */
18
18
  export declare class RpcClient implements RpcClientInterface {
19
19
  protected url: string;
@@ -34,82 +34,82 @@ export declare class RpcClient implements RpcClientInterface {
34
34
  private validateContract;
35
35
  /**
36
36
  * @param options contains generic configuration for rpc calls to specified block (default to head)
37
- * @description Get the block's hash, its unique identifier.
37
+ * Get the block's hash, its unique identifier.
38
38
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-hash
39
39
  */
40
40
  getBlockHash({ block }?: RPCOptions): Promise<string>;
41
41
  /**
42
42
  * @param options contains generic configuration for rpc calls to specified block (default to head)
43
- * @description List the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.
43
+ * List the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.
44
44
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-live-blocks
45
45
  */
46
46
  getLiveBlocks({ block }?: RPCOptions): Promise<string[]>;
47
47
  /**
48
48
  * @param address address from which we want to retrieve the spendable balance
49
49
  * @param options contains generic configuration for rpc calls to specified block (default to head)
50
- * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
50
+ * The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
51
51
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-balance
52
52
  */
53
53
  getBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
54
54
  /**
55
55
  * @param address address from which we want to retrieve the spendable balance
56
56
  * @param options contains generic configuration for rpc calls to specified block (default to head)
57
- * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
57
+ * The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
58
58
  */
59
59
  getSpendable(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
60
60
  /**
61
61
  * @param address address from which we want to retrieve balance and frozen bonds
62
62
  * @param options contains generic configuration for rpc calls to specified block (default to head)
63
- * @description The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'spendable_and_frozen_bonds' RPC.
63
+ * The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'spendable_and_frozen_bonds' RPC.
64
64
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
65
65
  */
66
66
  getBalanceAndFrozenBonds(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
67
67
  /**
68
68
  * @param address address from which we want to retrieve spendable and frozen bonds
69
69
  * @param options contains generic configuration for rpc calls to specified block (default to head)
70
- * @description The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'balance_and_frozen_bonds' RPC.
70
+ * The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'balance_and_frozen_bonds' RPC.
71
71
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
72
72
  */
73
73
  getSpendableAndFrozenBonds(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
74
74
  /**
75
75
  * @param address address from which we want to retrieve the full balance
76
76
  * @param options contains generic configuration for rpc calls to specified block (default to head)
77
- * @description Access the full balance of a contract, including frozen bonds and stake.
77
+ * Access the full balance of a contract, including frozen bonds and stake.
78
78
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
79
79
  */
80
80
  getFullBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
81
81
  /**
82
82
  * @param address address from which we want to retrieve the staked balance
83
83
  * @param options contains generic configuration for rpc calls to specified block (default to head)
84
- * @description Access the staked balance of a contract. Returns None if the contract is originated, or neither delegated nor a delegate.
84
+ * Access the staked balance of a contract. Returns None if the contract is originated, or neither delegated nor a delegate.
85
85
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-staked-balance
86
86
  */
87
87
  getStakedBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
88
88
  /**
89
89
  * @param address address from which we want to retrieve the unstaked finalizable balance
90
90
  * @param options contains generic configuration for rpc calls to specified block (default to head)
91
- * @description Access the balance of a contract that was requested for an unstake operation, and is no longer frozen, which means it will appear in the spendable balance of the contract after any stake/unstake/finalize_unstake operation. Returns None if the contract is originated.
91
+ * Access the balance of a contract that was requested for an unstake operation, and is no longer frozen, which means it will appear in the spendable balance of the contract after any stake/unstake/finalize_unstake operation. Returns None if the contract is originated.
92
92
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstaked-finalizable-balance
93
93
  */
94
94
  getUnstakedFinalizableBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
95
95
  /**
96
96
  * @param address address from which we want to retrieve the unstaked frozen balance
97
97
  * @param options contains generic configuration for rpc calls to specified block (default to head)
98
- * @description Access the balance of a contract that was requested for an unstake operation, but is still frozen for the duration of the slashing period. Returns None if the contract is originated.
98
+ * Access the balance of a contract that was requested for an unstake operation, but is still frozen for the duration of the slashing period. Returns None if the contract is originated.
99
99
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstaked-frozen-balance
100
100
  */
101
101
  getUnstakedFrozenBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
102
102
  /**
103
103
  * @param address address from which we want to retrieve the unstaked requests
104
104
  * @param options contains generic configuration for rpc calls to specified block (default to head)
105
- * @description Access the unstake requests of the contract. The requests that appear in the finalizable field can be finalized, which means that the contract can transfer these (no longer frozen) funds to their spendable balance with a [finalize_unstake] operation call. Returns null if there is no unstake request pending.
105
+ * Access the unstake requests of the contract. The requests that appear in the finalizable field can be finalized, which means that the contract can transfer these (no longer frozen) funds to their spendable balance with a [finalize_unstake] operation call. Returns null if there is no unstake request pending.
106
106
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstake-requests
107
107
  */
108
108
  getUnstakeRequests(address: string, { block }?: RPCOptions): Promise<UnstakeRequestsResponse>;
109
109
  /**
110
110
  * @param address contract address from which we want to retrieve the storage
111
111
  * @param options contains generic configuration for rpc calls to specified block (default to head)
112
- * @description Access the data of the contract.
112
+ * Access the data of the contract.
113
113
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-storage
114
114
  */
115
115
  getStorage(address: string, { block }?: {
@@ -118,7 +118,7 @@ export declare class RpcClient implements RpcClientInterface {
118
118
  /**
119
119
  * @param address contract address from which we want to retrieve the script
120
120
  * @param options contains generic configuration for rpc calls to specified block (default to head)
121
- * @description Access the code and data of the contract.
121
+ * Access the code and data of the contract.
122
122
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-script
123
123
  */
124
124
  getScript(address: string, { block }?: {
@@ -128,7 +128,7 @@ export declare class RpcClient implements RpcClientInterface {
128
128
  * @param address contract address from which we want to retrieve the script
129
129
  * @param unparsingMode default is { unparsing_mode: "Readable" }
130
130
  * @param options contains generic configuration for rpc calls to specified block (default to head)
131
- * @description Access the script of the contract and normalize it using the requested unparsing mode.
131
+ * Access the script of the contract and normalize it using the requested unparsing mode.
132
132
  */
133
133
  getNormalizedScript(address: string, unparsingMode?: UnparsingMode, { block }?: {
134
134
  block: string;
@@ -136,7 +136,7 @@ export declare class RpcClient implements RpcClientInterface {
136
136
  /**
137
137
  * @param address contract address from which we want to retrieve
138
138
  * @param options contains generic configuration for rpc calls to specified block (default to head)
139
- * @description Access the complete status of a contract.
139
+ * Access the complete status of a contract.
140
140
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id
141
141
  */
142
142
  getContract(address: string, { block }?: {
@@ -145,7 +145,7 @@ export declare class RpcClient implements RpcClientInterface {
145
145
  /**
146
146
  * @param address contract address from which we want to retrieve the manager
147
147
  * @param options contains generic configuration for rpc calls to specified block (default to head)
148
- * @description Access the manager of an implicit contract
148
+ * Access the manager of an implicit contract
149
149
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-manager-key
150
150
  */
151
151
  getManagerKey(address: string, { block }?: {
@@ -154,7 +154,7 @@ export declare class RpcClient implements RpcClientInterface {
154
154
  /**
155
155
  * @param address contract address from which we want to retrieve the delegate (baker)
156
156
  * @param options contains generic configuration for rpc calls to specified block (default to head)
157
- * @description Access the delegate of a contract, if any
157
+ * Access the delegate of a contract, if any
158
158
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-delegate
159
159
  */
160
160
  getDelegate(address: string, { block }?: {
@@ -164,7 +164,7 @@ export declare class RpcClient implements RpcClientInterface {
164
164
  * @param id Big Map ID
165
165
  * @param expr Expression hash to query (A b58check encoded Blake2b hash of the expression (The expression can be packed using the pack_data method))
166
166
  * @param options contains generic configuration for rpc calls to specified block (default to head)
167
- * @description Access the value associated with a key in a big map.
167
+ * Access the value associated with a key in a big map.
168
168
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
169
169
  */
170
170
  getBigMapExpr(id: string, expr: string, { block }?: {
@@ -173,7 +173,7 @@ export declare class RpcClient implements RpcClientInterface {
173
173
  /**
174
174
  * @param args contains optional query arguments (active, inactive, with_minimal_stake, without_minimal_stake)
175
175
  * @param options contains generic configuration for rpc calls to specified block (default to head)
176
- * @description Lists all registered delegates by default with query arguments to filter unneeded values.
176
+ * Lists all registered delegates by default with query arguments to filter unneeded values.
177
177
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh
178
178
  */
179
179
  getAllDelegates(args?: AllDelegatesQueryArguments, { block }?: {
@@ -182,7 +182,7 @@ export declare class RpcClient implements RpcClientInterface {
182
182
  /**
183
183
  * @param address delegate address which we want to retrieve
184
184
  * @param options contains generic configuration for rpc calls to specified block (default to head)
185
- * @description Everything about a delegate
185
+ * Everything about a delegate
186
186
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh
187
187
  */
188
188
  getDelegates(address: string, { block }?: {
@@ -191,7 +191,7 @@ export declare class RpcClient implements RpcClientInterface {
191
191
  /**
192
192
  * @param address delegate address which we want to retrieve
193
193
  * @param options contains generic configuration for rpc calls to specified block (default to head)
194
- * @description Returns the delegate info (e.g. voting power) found in the listings of the current voting period
194
+ * Returns the delegate info (e.g. voting power) found in the listings of the current voting period
195
195
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-voting-info
196
196
  */
197
197
  getVotingInfo(address: string, { block }?: {
@@ -199,13 +199,13 @@ export declare class RpcClient implements RpcClientInterface {
199
199
  }): Promise<VotingInfoResponse>;
200
200
  /**
201
201
  * @param options contains generic configuration for rpc calls to specified block (default to head)
202
- * @description All constants
202
+ * All constants
203
203
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-constants
204
204
  */
205
205
  getConstants({ block }?: RPCOptions): Promise<ConstantsResponse>;
206
206
  /**
207
207
  * @param options contains generic configuration for rpc calls to specified block (default to head) and version.
208
- * @description All the information about a block
208
+ * All the information about a block
209
209
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id
210
210
  * @example getBlock() will default to `/main/chains/block/head?version=1`
211
211
  * @example getBlock({ block: 'head~2' }) will return an offset of 2 from head blocks
@@ -214,119 +214,119 @@ export declare class RpcClient implements RpcClientInterface {
214
214
  getBlock({ block, version }?: RPCOptions): Promise<BlockResponse>;
215
215
  /**
216
216
  * @param options contains generic configuration for rpc calls to specified block (default to head)
217
- * @description The whole block header
217
+ * The whole block header
218
218
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-header
219
219
  */
220
220
  getBlockHeader({ block }?: RPCOptions): Promise<BlockHeaderResponse>;
221
221
  /**
222
222
  * @param options contains generic configuration for rpc calls to specified block (default to head) and version
223
- * @description All the metadata associated to the block
223
+ * All the metadata associated to the block
224
224
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-metadata
225
225
  */
226
226
  getBlockMetadata({ block, version, }?: RPCOptions): Promise<BlockMetadata>;
227
227
  /**
228
228
  * @param args contains optional query arguments (level, cycle, delegate, consensus_key, and max_round)
229
229
  * @param options contains generic configuration for rpc calls to specified block (default to head)
230
- * @description Retrieves the list of delegates allowed to bake a block.
230
+ * Retrieves the list of delegates allowed to bake a block.
231
231
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
232
232
  */
233
233
  getBakingRights(args?: BakingRightsQueryArguments, { block }?: RPCOptions): Promise<BakingRightsResponse>;
234
234
  /**
235
235
  * @param args contains optional query arguments (level, cycle, delegate, and consensus_key)
236
236
  * @param options contains generic configuration for rpc calls to specified block (default to head)
237
- * @description Retrieves the delegates allowed to attest a block
237
+ * Retrieves the delegates allowed to attest a block
238
238
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
239
239
  */
240
240
  getAttestationRights(args?: AttestationRightsQueryArguments, { block }?: RPCOptions): Promise<AttestationRightsResponse>;
241
241
  /**
242
242
  * @param options contains generic configuration for rpc calls to specified block (default to head)
243
- * @description Ballots casted so far during a voting period
243
+ * Ballots casted so far during a voting period
244
244
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-ballot-list
245
245
  */
246
246
  getBallotList({ block }?: RPCOptions): Promise<BallotListResponse>;
247
247
  /**
248
248
  * @param options contains generic configuration for rpc calls to specified block (default to head)
249
- * @description Sum of ballots casted so far during a voting period
249
+ * Sum of ballots casted so far during a voting period
250
250
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-ballots
251
251
  */
252
252
  getBallots({ block }?: RPCOptions): Promise<BallotsResponse>;
253
253
  /**
254
254
  * @param options contains generic configuration for rpc calls to specified block (default to head)
255
- * @description Current proposal under evaluation.
255
+ * Current proposal under evaluation.
256
256
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-proposal
257
257
  */
258
258
  getCurrentProposal({ block, }?: RPCOptions): Promise<CurrentProposalResponse>;
259
259
  /**
260
260
  * @param options contains generic configuration for rpc calls to specified block (default to head)
261
- * @description Current expected quorum.
261
+ * Current expected quorum.
262
262
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-quorum
263
263
  */
264
264
  getCurrentQuorum({ block, }?: RPCOptions): Promise<CurrentQuorumResponse>;
265
265
  /**
266
266
  * @param options contains generic configuration for rpc calls to specified block (default to head)
267
- * @description List of delegates with their voting power
267
+ * List of delegates with their voting power
268
268
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-listings
269
269
  */
270
270
  getVotesListings({ block, }?: RPCOptions): Promise<VotesListingsResponse>;
271
271
  /**
272
272
  * @param options contains generic configuration for rpc calls to specified block (default to head)
273
- * @description List of proposals with number of supporters
273
+ * List of proposals with number of supporters
274
274
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-proposals
275
275
  */
276
276
  getProposals({ block }?: RPCOptions): Promise<ProposalsResponse>;
277
277
  /**
278
278
  * @param data operation contents to forge
279
279
  * @param options contains generic configuration for rpc calls to specified block (default to head)
280
- * @description Forge an operation returning the unsigned bytes
280
+ * Forge an operation returning the unsigned bytes
281
281
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
282
282
  */
283
283
  forgeOperations(data: ForgeOperationsParams, { block }?: RPCOptions): Promise<string>;
284
284
  /**
285
285
  * @param signedOpBytes signed bytes to inject
286
- * @description Inject an operation in node and broadcast it and return the ID of the operation
286
+ * Inject an operation in node and broadcast it and return the ID of the operation
287
287
  * @see https://tezos.gitlab.io/shell/rpc.html#post-injection-operation
288
288
  */
289
289
  injectOperation(signedOpBytes: string): Promise<OperationHash>;
290
290
  /**
291
291
  * @param ops Operations to apply
292
292
  * @param options contains generic configuration for rpc calls to specified block and version
293
- * @description Simulate the application of the operations with the context of the given block and return the result of each operation application
293
+ * Simulate the application of the operations with the context of the given block and return the result of each operation application
294
294
  * @see https://tezos.gitlab.io/active/rpc.html#post-block-id-helpers-preapply-operations
295
295
  */
296
296
  preapplyOperations(ops: PreapplyParams, { block, version }?: RPCOptions): Promise<PreapplyResponse[]>;
297
297
  /**
298
298
  * @param contract address of the contract we want to get the entrypoints of
299
299
  * @param options contains generic configuration for rpc calls to specified block (default to head)
300
- * @description Return the list of entrypoints of the contract
300
+ * Return the list of entrypoints of the contract
301
301
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-entrypoints
302
- * @version 005_PsBABY5H
302
+ * @remarks version 005_PsBABY5H
303
303
  */
304
304
  getEntrypoints(contract: string, { block }?: RPCOptions): Promise<EntrypointsResponse>;
305
305
  /**
306
306
  * @param op Operation to simulate
307
307
  * @param options contains generic configuration for rpc calls to specified block and version
308
- * @description Simulate running an operation at some future moment (based on the number of blocks given in the `latency` argument), and return the operation application result.
308
+ * Simulate running an operation at some future moment (based on the number of blocks given in the `latency` argument), and return the operation application result.
309
309
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
310
310
  */
311
311
  simulateOperation(op: RPCSimulateOperationParam, { block, version }?: RPCOptions): Promise<PreapplyResponse>;
312
312
  /**
313
313
  * @param code Code to run
314
314
  * @param options contains generic configuration for rpc calls to specified block (default to head)
315
- * @description Run a Michelson script in the current context
315
+ * Run a Michelson script in the current context
316
316
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
317
317
  */
318
318
  runCode(code: RPCRunCodeParam, { block }?: RPCOptions): Promise<RunCodeResult>;
319
319
  /**
320
320
  * @param viewScriptParams Parameters of the script view to run
321
321
  * @param options contains generic configuration for rpc calls to specified block (default to head)
322
- * @description Simulate a call to a michelson view
322
+ * Simulate a call to a michelson view
323
323
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
324
324
  */
325
325
  runScriptView({ unparsing_mode, ...rest }: RPCRunScriptViewParam, { block }?: RPCOptions): Promise<RunScriptViewResult>;
326
326
  /**
327
327
  * @param viewParams Parameters of the view to run
328
328
  * @param options contains generic configuration for rpc calls to specified block (default to head)
329
- * @description Simulate a call to a view following the TZIP-4 standard.
329
+ * Simulate a call to a view following the TZIP-4 standard.
330
330
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
331
331
  */
332
332
  runView({ unparsing_mode, ...rest }: RPCRunViewParam, { block }?: RPCOptions): Promise<RunViewResult>;
@@ -334,7 +334,7 @@ export declare class RpcClient implements RpcClientInterface {
334
334
  /**
335
335
  * @param data Data to pack
336
336
  * @param options contains generic configuration for rpc calls to specified block (default to head)
337
- * @description Computes the serialized version of a data expression using the same algorithm as script instruction PACK
337
+ * Computes the serialized version of a data expression using the same algorithm as script instruction PACK
338
338
  * Note: You should always verify the packed bytes before signing or requesting that they be signed when using the RPC to pack.
339
339
  * This precaution helps protect you and your applications users from RPC nodes that have been compromised.
340
340
  * A node that is operated by a bad actor, or compromised by a bad actor could return a fully formed operation that does not correspond to the input provided to the RPC endpoint.
@@ -348,18 +348,18 @@ export declare class RpcClient implements RpcClientInterface {
348
348
  }>;
349
349
  /**
350
350
  *
351
- * @description Return rpc root url
351
+ * Return rpc root url
352
352
  */
353
353
  getRpcUrl(): string;
354
354
  /**
355
355
  * @param options contains generic configuration for rpc calls to specified block (default to head)
356
- * @description Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block
356
+ * Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block
357
357
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-period
358
358
  */
359
359
  getCurrentPeriod({ block, }?: RPCOptions): Promise<VotingPeriodBlockResult>;
360
360
  /**
361
361
  * @param options contains generic configuration for rpc calls to specified block (default to head)
362
- * @description Returns the voting period (index, kind, starting position) and related information (position, remaining) of the next block.Useful to craft operations that will be valid in the next block
362
+ * Returns the voting period (index, kind, starting position) and related information (position, remaining) of the next block.Useful to craft operations that will be valid in the next block
363
363
  * @example getSuccessorPeriod() will default to successor voting period for /main/chains/block/head.
364
364
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-successor-period
365
365
  */
@@ -367,7 +367,7 @@ export declare class RpcClient implements RpcClientInterface {
367
367
  /**
368
368
  * @param id Sapling state ID
369
369
  * @param options contains generic configuration for rpc calls to specified block (default to head)
370
- * @description Returns the root and a diff of a state starting from an optional offset which is zero by default
370
+ * Returns the root and a diff of a state starting from an optional offset which is zero by default
371
371
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-sapling-sapling-state-id-get-diff
372
372
  */
373
373
  getSaplingDiffById(id: string, { block }?: {
@@ -376,7 +376,7 @@ export declare class RpcClient implements RpcClientInterface {
376
376
  /**
377
377
  * @param contract address of the contract we want to get the sapling diff
378
378
  * @param options contains generic configuration for rpc calls to specified block (default to head)
379
- * @description Returns the root and a diff of a state starting from an optional offset which is zero by default
379
+ * Returns the root and a diff of a state starting from an optional offset which is zero by default
380
380
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-single-sapling-get-diff
381
381
  */
382
382
  getSaplingDiffByContract(contract: string, { block }?: {
@@ -384,22 +384,22 @@ export declare class RpcClient implements RpcClientInterface {
384
384
  }): Promise<SaplingDiffResponse>;
385
385
  /**
386
386
  * @param options contains generic configuration for rpc calls to specified block (default to head)
387
- * @description get current and next protocol
387
+ * get current and next protocol
388
388
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
389
389
  */
390
390
  getProtocols({ block }?: {
391
391
  block: string;
392
392
  }): Promise<ProtocolsResponse>;
393
393
  /**
394
- * @param options contains generic configuration for rpc calls to specified block (default to head)
395
- * @description get current and next protocol
394
+ * @param protocol the protocol hash to look up (default to empty string)
395
+ * get current and next protocol
396
396
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
397
397
  */
398
398
  getProtocolActivations(protocol?: string): Promise<ProtocolActivationsResponse>;
399
399
  /**
400
400
  * @param contract address of the contract we want to retrieve storage information of
401
401
  * @param options contains generic configuration for rpc calls to specified block (default to head)
402
- * @description Access the used storage space of the contract
402
+ * Access the used storage space of the contract
403
403
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
404
404
  */
405
405
  getStorageUsedSpace(contract: string, { block }?: {
@@ -408,7 +408,7 @@ export declare class RpcClient implements RpcClientInterface {
408
408
  /**
409
409
  * @param contract address of the contract we want to retrieve storage information of
410
410
  * @param options contains generic configuration for rpc calls to specified block (default to head)
411
- * @description Access the paid storage space of the contract
411
+ * Access the paid storage space of the contract
412
412
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
413
413
  */
414
414
  getStoragePaidSpace(contract: string, { block }?: {
@@ -418,7 +418,7 @@ export declare class RpcClient implements RpcClientInterface {
418
418
  * @param contract implicit or originated address we want to retrieve ticket balance of
419
419
  * @param ticket object to specify a ticket by ticketer, content type and content
420
420
  * @param options contains generic configuration for rpc calls to specified block (default to head)
421
- * @description Access the contract's balance of ticket with specified ticketer, content type, and content.
421
+ * Access the contract's balance of ticket with specified ticketer, content type, and content.
422
422
  * @example ticket { ticketer: 'address', content_type: { prim: "string" }, content: { string: 'ticket1' } }
423
423
  * @see https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
424
424
  */
@@ -428,14 +428,14 @@ export declare class RpcClient implements RpcClientInterface {
428
428
  /**
429
429
  * @param contract originated address we want to retrieve ticket balances of
430
430
  * @param options contains generic configuration for rpc calls to specified block (default to head)
431
- * @description Access the complete list of tickets owned by the given contract by scanning the contract's storage.
431
+ * Access the complete list of tickets owned by the given contract by scanning the contract's storage.
432
432
  * @see https://tezos.gitlab.io/protocols/016_mumbai.html#rpc-changes
433
433
  */
434
434
  getAllTicketBalances(contract: string, { block }?: {
435
435
  block: string;
436
436
  }): Promise<AllTicketBalances>;
437
437
  /**
438
- * @description Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of null means that the feature is not yet set to launch.
438
+ * Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of null means that the feature is not yet set to launch.
439
439
  * @param options contains generic configuration for rpc calls to specified block (default to head)
440
440
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-adaptive-issuance-launch-cycle
441
441
  */
@@ -443,30 +443,40 @@ export declare class RpcClient implements RpcClientInterface {
443
443
  block: string;
444
444
  }): Promise<AILaunchCycleResponse>;
445
445
  /**
446
- * @description List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
446
+ * List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
447
447
  * @param args has 5 optional properties
448
448
  * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined, source: undefined, operationHash: undefined }
449
449
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/tallinn-mempool-openapi-rc.json
450
450
  */
451
451
  getPendingOperations(args?: PendingOperationsQueryArguments): Promise<PendingOperationsV2>;
452
+ /**
453
+ * Returns the current mempool fee filter configuration.
454
+ *
455
+ * On Tezos L1 these values commonly resemble the historical fee defaults used by clients.
456
+ * On Tezos X / Tezlink, the same fields are used for estimation but may differ materially,
457
+ * especially the byte fee and the gas-price component.
458
+ *
459
+ * @param args optional query arguments for the mempool/filter endpoint
460
+ */
461
+ getMempoolFilter(args?: MempoolFilterQueryArguments): Promise<MempoolFilterResponse>;
452
462
  /**
453
463
  * @param delegate delegate address which we want to retrieve active staking parameters
454
464
  * @param options contains generic configuration for rpc calls to specified block (default to head)
455
- * @description Returns the currently active staking parameters for the given delegate
465
+ * Returns the currently active staking parameters for the given delegate
456
466
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-active-staking-parameters
457
467
  */
458
468
  getActiveStakingParameters(delegate: string, { block }?: RPCOptions): Promise<ActiveStakingParametersResponse>;
459
469
  /**
460
470
  * @param delegate delegate address which we want to retrieve pending staking parameters
461
471
  * @param options contains generic configuration for rpc calls to specified block (default to head)
462
- * @description Returns the pending values for the given delegate's staking parameters
472
+ * Returns the pending values for the given delegate's staking parameters
463
473
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-pending-staking-parameters
464
474
  */
465
475
  getPendingStakingParameters(delegate: string, { block }?: RPCOptions): Promise<PendingStakingParametersResponse>;
466
476
  /**
467
477
  * @param destination address to retrieve the index for
468
478
  * @param options contains generic configuration for rpc calls to specified block (default to head)
469
- * @description Returns the index assigned to the address if it was indexed by the opcode INDEX_ADDRESS, otherwise returns null
479
+ * Returns the index assigned to the address if it was indexed by the opcode INDEX_ADDRESS, otherwise returns null
470
480
  * @see https://octez.tezos.com/docs/alpha/rpc.html#get-block-id-context-destination-destination-id-index
471
481
  */
472
482
  getDestinationIndex(destination: string, { block }?: RPCOptions): Promise<DestinationIndexResponse>;
@@ -2217,6 +2217,16 @@ export interface PendingOperationsQueryArguments {
2217
2217
  source?: string;
2218
2218
  operationHash?: string;
2219
2219
  }
2220
+ export type MempoolFilterQueryArguments = {
2221
+ include_default?: boolean;
2222
+ };
2223
+ export type RpcRatio = [string | number, string | number];
2224
+ export interface MempoolFilterResponse {
2225
+ minimal_fees?: string | number;
2226
+ minimal_nanotez_per_gas_unit?: RpcRatio;
2227
+ minimal_nanotez_per_byte?: RpcRatio;
2228
+ [key: string]: unknown;
2229
+ }
2220
2230
  type FailedProcessedOperation = Pick<OperationEntry, 'hash' | 'protocol' | 'branch' | 'contents' | 'signature'> & {
2221
2231
  error: TezosGenericOperationError[];
2222
2232
  };
package/package.json CHANGED
@@ -1,11 +1,14 @@
1
1
  {
2
2
  "name": "@taquito/rpc",
3
- "version": "24.2.0",
4
- "description": "Provides low level methods, and types to invoke RPC calls from a Nomadic Tezos RPC node",
3
+ "version": "24.3.0-beta.0",
4
+ "description": "TypeScript client and types for the Tezos RPC used by Taquito.",
5
5
  "keywords": [
6
+ "taquito",
6
7
  "tezos",
8
+ "typescript",
7
9
  "blockchain",
8
- "rpc"
10
+ "rpc",
11
+ "client"
9
12
  ],
10
13
  "main": "dist/taquito-rpc.umd.js",
11
14
  "module": "dist/taquito-rpc.es6.js",
@@ -17,14 +20,24 @@
17
20
  "publishConfig": {
18
21
  "access": "public"
19
22
  },
20
- "author": "Simon Boissonneault-Robert <simon@ecadlabs.com>",
23
+ "author": "ECAD Labs Inc <info@ecadlabs.com>",
24
+ "contributors": [
25
+ "Jev Björsell (jevonearth)",
26
+ "Roxane Letourneau <roxane@ecadlabs.com>",
27
+ "Davis Sawali <davis.sawali@ecadlabs.com>",
28
+ "Simon Boissonneault-Robert <simon@ecadlabs.com>"
29
+ ],
30
+ "homepage": "https://taquito.io/",
21
31
  "repository": {
22
32
  "type": "git",
23
- "url": ""
33
+ "url": "git+https://github.com/ecadlabs/taquito.git"
34
+ },
35
+ "bugs": {
36
+ "url": "https://github.com/ecadlabs/taquito/issues"
24
37
  },
25
38
  "license": "Apache-2.0",
26
39
  "engines": {
27
- "node": ">=20"
40
+ "node": ">=22"
28
41
  },
29
42
  "scripts": {
30
43
  "test": "jest --coverage",
@@ -66,9 +79,9 @@
66
79
  ]
67
80
  },
68
81
  "dependencies": {
69
- "@taquito/core": "^24.2.0",
70
- "@taquito/http-utils": "^24.2.0",
71
- "@taquito/utils": "^24.2.0",
82
+ "@taquito/core": "^24.3.0-beta.0",
83
+ "@taquito/http-utils": "^24.3.0-beta.0",
84
+ "@taquito/utils": "^24.3.0-beta.0",
72
85
  "bignumber.js": "^9.1.2",
73
86
  "whatwg-url": "^15.1.0"
74
87
  },
@@ -98,7 +111,7 @@
98
111
  "ts-jest": "^29.2.3",
99
112
  "ts-node": "^10.9.2",
100
113
  "ts-toolbelt": "^9.6.0",
101
- "typescript": "~5.5.4"
114
+ "typescript": "^5.9.3"
102
115
  },
103
- "gitHead": "689f242c1780c9fe98c050819c55986912db3934"
116
+ "gitHead": "551e35aeff7d6dcde1c72284238c0ed3c3aae77e"
104
117
  }