@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.
Files changed (14) hide show
  1. package/dist/lib/rpc-client-interface.js +1 -0
  2. package/dist/lib/rpc-client-modules/rpc-cache.js +703 -820
  3. package/dist/lib/taquito-rpc.js +517 -615
  4. package/dist/lib/version.js +2 -2
  5. package/dist/taquito-rpc.es6.js +1230 -1444
  6. package/dist/taquito-rpc.es6.js.map +1 -1
  7. package/dist/taquito-rpc.umd.js +2317 -2531
  8. package/dist/taquito-rpc.umd.js.map +1 -1
  9. package/dist/types/rpc-client-interface.d.ts +3 -1
  10. package/dist/types/rpc-client-modules/rpc-cache.d.ts +68 -63
  11. package/dist/types/taquito-rpc.d.ts +72 -62
  12. package/dist/types/types.d.ts +10 -0
  13. package/package.json +24 -11
  14. package/LICENSE +0 -202
package/dist/taquito-rpc.umd.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"taquito-rpc.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"taquito-rpc.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/dist/types/rpc-client-interface.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { BakingRightsQueryArguments, BakingRightsResponse, BalanceResponse, UnstakeRequestsResponse, BallotListResponse, BallotsResponse, BigMapResponse, BlockHeaderResponse, BlockMetadata, BlockResponse, ConstantsResponse, ContractResponse, CurrentProposalResponse, CurrentQuorumResponse, DelegateResponse, DelegatesResponse, AttestationRightsQueryArguments, AttestationRightsResponse, EntrypointsResponse, ForgeOperationsParams, ManagerKeyResponse, OperationHash, PackDataParams, PreapplyParams, PreapplyResponse, ProposalsResponse, ProtocolsResponse, RPCRunCodeParam, RPCRunScriptViewParam, RPCRunViewParam, RunCodeResult, RunScriptViewResult, RunViewResult, SaplingDiffResponse, ScriptResponse, StorageResponse, UnparsingMode, VotesListingsResponse, VotingInfoResponse, VotingPeriodBlockResult, TicketTokenParams, AllTicketBalances, PendingOperationsV2, PendingOperationsQueryArguments, RPCSimulateOperationParam, AILaunchCycleResponse, AllDelegatesQueryArguments, ProtocolActivationsResponse, ActiveStakingParametersResponse, PendingStakingParametersResponse, DestinationIndexResponse } from './types';
1
+ import { BakingRightsQueryArguments, BakingRightsResponse, BalanceResponse, UnstakeRequestsResponse, BallotListResponse, BallotsResponse, BigMapResponse, BlockHeaderResponse, BlockMetadata, BlockResponse, ConstantsResponse, ContractResponse, CurrentProposalResponse, CurrentQuorumResponse, DelegateResponse, DelegatesResponse, AttestationRightsQueryArguments, AttestationRightsResponse, EntrypointsResponse, ForgeOperationsParams, ManagerKeyResponse, OperationHash, PackDataParams, PreapplyParams, PreapplyResponse, ProposalsResponse, ProtocolsResponse, RPCRunCodeParam, RPCRunScriptViewParam, RPCRunViewParam, RunCodeResult, RunScriptViewResult, RunViewResult, SaplingDiffResponse, ScriptResponse, StorageResponse, UnparsingMode, VotesListingsResponse, VotingInfoResponse, VotingPeriodBlockResult, TicketTokenParams, AllTicketBalances, PendingOperationsV2, PendingOperationsQueryArguments, MempoolFilterQueryArguments, MempoolFilterResponse, RPCSimulateOperationParam, AILaunchCycleResponse, AllDelegatesQueryArguments, ProtocolActivationsResponse, ActiveStakingParametersResponse, PendingStakingParametersResponse, DestinationIndexResponse } from './types';
2
2
  export interface RPCOptions {
3
3
  block: string;
4
4
  version?: 1 | '1';
@@ -65,6 +65,7 @@ export interface RpcClientInterface {
65
65
  getAllTicketBalances(contract: string, options?: RPCOptions): Promise<AllTicketBalances>;
66
66
  getAdaptiveIssuanceLaunchCycle(options?: RPCOptions): Promise<AILaunchCycleResponse>;
67
67
  getPendingOperations(args: PendingOperationsQueryArguments): Promise<PendingOperationsV2>;
68
+ getMempoolFilter(args?: MempoolFilterQueryArguments): Promise<MempoolFilterResponse>;
68
69
  getActiveStakingParameters(delegate: string, options?: RPCOptions): Promise<ActiveStakingParametersResponse>;
69
70
  getPendingStakingParameters(delegate: string, options?: RPCOptions): Promise<PendingStakingParametersResponse>;
70
71
  getDestinationIndex(destination: string, options?: RPCOptions): Promise<DestinationIndexResponse>;
@@ -120,5 +121,6 @@ export declare enum RPCMethodName {
120
121
  GET_ALL_TICKET_BALANCES = "getAllTicketBalances",
121
122
  GET_ADAPTIVE_ISSUANCE_LAUNCH_CYCLE = "getAdaptiveIssuanceLaunchCycle",
122
123
  GET_PENDING_OPERATIONS = "getPendingOperations",
124
+ GET_MEMPOOL_FILTER = "getMempoolFilter",
123
125
  GET_DESTINATION_INDEX = "getDestinationIndex"
124
126
  }
package/dist/types/rpc-client-modules/rpc-cache.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import BigNumber from 'bignumber.js';
2
2
  import { RpcClientInterface, RPCOptions } from '../rpc-client-interface';
3
- 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, RPCRunScriptViewParam, RPCRunViewParam, RunCodeResult, RunScriptViewResult, RunViewResult, SaplingDiffResponse, ScriptResponse, StorageResponse, UnparsingMode, VotesListingsResponse, VotingPeriodBlockResult, TicketTokenParams, AllTicketBalances, PendingOperationsQueryArguments, PendingOperationsV2, RPCSimulateOperationParam, AILaunchCycleResponse, AllDelegatesQueryArguments, ProtocolActivationsResponse, DestinationIndexResponse, PendingStakingParametersResponse, ActiveStakingParametersResponse } from '../types';
3
+ 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, RPCRunScriptViewParam, RPCRunViewParam, RunCodeResult, RunScriptViewResult, RunViewResult, SaplingDiffResponse, ScriptResponse, StorageResponse, UnparsingMode, VotesListingsResponse, VotingPeriodBlockResult, TicketTokenParams, AllTicketBalances, PendingOperationsQueryArguments, PendingOperationsV2, MempoolFilterQueryArguments, MempoolFilterResponse, RPCSimulateOperationParam, AILaunchCycleResponse, AllDelegatesQueryArguments, ProtocolActivationsResponse, DestinationIndexResponse, PendingStakingParametersResponse, ActiveStakingParametersResponse } from '../types';
4
4
  interface CachedDataInterface {
5
5
  [key: string]: {
6
6
  handle: () => void;
@@ -8,7 +8,7 @@ interface CachedDataInterface {
8
8
  };
9
9
  }
10
10
  /***
11
- * @description RpcClientCache acts as a decorator over the RpcClient instance by caching responses for the period defined by the ttl.
11
+ * RpcClientCache acts as a decorator over the RpcClient instance by caching responses for the period defined by the ttl.
12
12
  */
13
13
  export declare class RpcClientCache implements RpcClientInterface {
14
14
  private rpcClient;
@@ -24,7 +24,7 @@ export declare class RpcClientCache implements RpcClientInterface {
24
24
  constructor(rpcClient: RpcClientInterface, ttl?: number);
25
25
  getAllCachedData(): CachedDataInterface;
26
26
  /**
27
- * @description Remove all the data in the cache.
27
+ * Remove all the data in the cache.
28
28
  *
29
29
  */
30
30
  deleteAllCachedData(): void;
@@ -37,80 +37,80 @@ export declare class RpcClientCache implements RpcClientInterface {
37
37
  private validateContract;
38
38
  /**
39
39
  * @param options contains generic configuration for rpc calls to specified block (default to head)
40
- * @description Get the block's hash, its unique identifier.
40
+ * Get the block's hash, its unique identifier.
41
41
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-hash
42
42
  */
43
43
  getBlockHash({ block }?: RPCOptions): Promise<string>;
44
44
  /**
45
45
  * @param options contains generic configuration for rpc calls to specified block (default to head)
46
- * @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.
46
+ * 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.
47
47
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-live-blocks
48
48
  */
49
49
  getLiveBlocks({ block }?: RPCOptions): Promise<string[]>;
50
50
  /**
51
51
  * @param address address from which we want to retrieve the spendable balance
52
52
  * @param options contains generic configuration for rpc calls to specified block (default to head)
53
- * @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.
53
+ * 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.
54
54
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-balance
55
55
  */
56
56
  getBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
57
57
  /**
58
58
  * @param address address from which we want to retrieve the balance
59
59
  * @param options contains generic configuration for rpc calls to specified block (default to head)
60
- * @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.
60
+ * 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.
61
61
  */
62
62
  getSpendable(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
63
63
  /**
64
64
  * @param address address from which we want to retrieve balance and frozen bonds
65
65
  * @param options contains generic configuration for rpc calls to specified block (default to head)
66
- * @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.
66
+ * 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.
67
67
  */
68
68
  getBalanceAndFrozenBonds(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
69
69
  /**
70
70
  * @param address address from which we want to retrieve spendable and frozen bonds
71
71
  * @param options contains generic configuration for rpc calls to specified block (default to head)
72
- * @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.
72
+ * 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.
73
73
  */
74
74
  getSpendableAndFrozenBonds(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
75
75
  /**
76
76
  * @param address address from which we want to retrieve the full balance
77
77
  * @param options contains generic configuration for rpc calls to specified block (default to head)
78
- * @description Access the full balance of a contract, including frozen bonds and stake.
78
+ * Access the full balance of a contract, including frozen bonds and stake.
79
79
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
80
80
  */
81
81
  getFullBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
82
82
  /**
83
83
  * @param address address from which we want to retrieve the staked balance
84
84
  * @param options contains generic configuration for rpc calls to specified block (default to head)
85
- * @description Access the staked balance of a contract. Returns None if the contract is originated, or neither delegated nor a delegate.
85
+ * Access the staked balance of a contract. Returns None if the contract is originated, or neither delegated nor a delegate.
86
86
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-staked-balance
87
87
  */
88
88
  getStakedBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
89
89
  /**
90
90
  * @param address address from which we want to retrieve the unstaked finalizable balance
91
91
  * @param options contains generic configuration for rpc calls to specified block (default to head)
92
- * @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.
92
+ * 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.
93
93
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstaked-finalizable-balance
94
94
  */
95
95
  getUnstakedFinalizableBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
96
96
  /**
97
97
  * @param address address from which we want to retrieve the unstaked frozen balance
98
98
  * @param options contains generic configuration for rpc calls to specified block (default to head)
99
- * @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.
99
+ * 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.
100
100
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstaked-frozen-balance
101
101
  */
102
102
  getUnstakedFrozenBalance(address: string, { block }?: RPCOptions): Promise<BalanceResponse>;
103
103
  /**
104
104
  * @param address address from which we want to retrieve the unstake requests
105
105
  * @param options contains generic configuration for rpc calls to specified block (default to head)
106
- * @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.
106
+ * 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.
107
107
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-unstake-requests
108
108
  */
109
109
  getUnstakeRequests(address: string, { block }?: RPCOptions): Promise<UnstakeRequestsResponse>;
110
110
  /**
111
111
  * @param address contract address from which we want to retrieve the storage
112
112
  * @param options contains generic configuration for rpc calls to specified block (default to head)
113
- * @description Access the data of the contract.
113
+ * Access the data of the contract.
114
114
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-storage
115
115
  */
116
116
  getStorage(address: string, { block }?: {
@@ -119,7 +119,7 @@ export declare class RpcClientCache implements RpcClientInterface {
119
119
  /**
120
120
  * @param address contract address from which we want to retrieve the script
121
121
  * @param options contains generic configuration for rpc calls to specified block (default to head)
122
- * @description Access the code and data of the contract.
122
+ * Access the code and data of the contract.
123
123
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-script
124
124
  */
125
125
  getScript(address: string, { block }?: {
@@ -129,7 +129,7 @@ export declare class RpcClientCache implements RpcClientInterface {
129
129
  * @param address contract address from which we want to retrieve the script
130
130
  * @param unparsingMode default is { unparsing_mode: "Readable" }
131
131
  * @param options contains generic configuration for rpc calls to specified block (default to head)
132
- * @description Access the script of the contract and normalize it using the requested unparsing mode.
132
+ * Access the script of the contract and normalize it using the requested unparsing mode.
133
133
  */
134
134
  getNormalizedScript(address: string, unparsingMode?: UnparsingMode, { block }?: {
135
135
  block: string;
@@ -137,7 +137,7 @@ export declare class RpcClientCache implements RpcClientInterface {
137
137
  /**
138
138
  * @param address contract address from which we want to retrieve
139
139
  * @param options contains generic configuration for rpc calls to specified block (default to head)
140
- * @description Access the complete status of a contract.
140
+ * Access the complete status of a contract.
141
141
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id
142
142
  */
143
143
  getContract(address: string, { block }?: {
@@ -146,7 +146,7 @@ export declare class RpcClientCache implements RpcClientInterface {
146
146
  /**
147
147
  * @param address contract address from which we want to retrieve the manager
148
148
  * @param options contains generic configuration for rpc calls to specified block (default to head)
149
- * @description Access the manager of an implicit contract
149
+ * Access the manager of an implicit contract
150
150
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-manager-key
151
151
  */
152
152
  getManagerKey(address: string, { block }?: {
@@ -155,7 +155,7 @@ export declare class RpcClientCache implements RpcClientInterface {
155
155
  /**
156
156
  * @param address contract address from which we want to retrieve the delegate (baker)
157
157
  * @param options contains generic configuration for rpc calls to specified block (default to head)
158
- * @description Access the delegate of a contract, if any
158
+ * Access the delegate of a contract, if any
159
159
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-delegate
160
160
  */
161
161
  getDelegate(address: string, { block }?: {
@@ -165,7 +165,7 @@ export declare class RpcClientCache implements RpcClientInterface {
165
165
  * @param id Big Map ID
166
166
  * @param expr Expression hash to query (A b58check encoded Blake2b hash of the expression (The expression can be packed using the pack_data method))
167
167
  * @param options contains generic configuration for rpc calls to specified block (default to head)
168
- * @description Access the value associated with a key in a big map.
168
+ * Access the value associated with a key in a big map.
169
169
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
170
170
  */
171
171
  getBigMapExpr(id: string, expr: string, { block }?: {
@@ -174,7 +174,7 @@ export declare class RpcClientCache implements RpcClientInterface {
174
174
  /**
175
175
  * @param args contains optional query arguments (active, inactive, with_minimal_stake, without_minimal_stake)
176
176
  * @param options contains generic configuration for rpc calls to specified block (default to head)
177
- * @description Lists all registered delegates by default with query arguments to filter unneeded values.
177
+ * Lists all registered delegates by default with query arguments to filter unneeded values.
178
178
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh
179
179
  */
180
180
  getAllDelegates(args?: AllDelegatesQueryArguments, { block }?: {
@@ -183,7 +183,7 @@ export declare class RpcClientCache implements RpcClientInterface {
183
183
  /**
184
184
  * @param address delegate address which we want to retrieve
185
185
  * @param options contains generic configuration for rpc calls to specified block (default to head)
186
- * @description Everything about a delegate
186
+ * Everything about a delegate
187
187
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh
188
188
  */
189
189
  getDelegates(address: string, { block }?: {
@@ -192,7 +192,7 @@ export declare class RpcClientCache implements RpcClientInterface {
192
192
  /**
193
193
  * @param address delegate address which we want to retrieve
194
194
  * @param options contains generic configuration for rpc calls to specified block (default to head)
195
- * @description Returns the delegate info (e.g. voting power) found in the listings of the current voting period
195
+ * Returns the delegate info (e.g. voting power) found in the listings of the current voting period
196
196
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-voting-info
197
197
  */
198
198
  getVotingInfo(address: string, { block }?: {
@@ -200,13 +200,13 @@ export declare class RpcClientCache implements RpcClientInterface {
200
200
  }): Promise<VotingInfoResponse>;
201
201
  /**
202
202
  * @param options contains generic configuration for rpc calls to specified block (default to head)
203
- * @description All constants
203
+ * All constants
204
204
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-constants
205
205
  */
206
206
  getConstants({ block }?: RPCOptions): Promise<ConstantsResponse>;
207
207
  /**
208
208
  * @param options contains generic configuration for rpc calls to specified block (default to head) and version.
209
- * @description All the information about a block
209
+ * All the information about a block
210
210
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id
211
211
  * @example getBlock() will default to `/main/chains/block/head?version=1`
212
212
  * @example getBlock({ block: 'head~2') will return an offset of 2 from head blocks
@@ -215,119 +215,119 @@ export declare class RpcClientCache implements RpcClientInterface {
215
215
  getBlock({ block }?: RPCOptions): Promise<BlockResponse>;
216
216
  /**
217
217
  * @param options contains generic configuration for rpc calls to specified block (default to head)
218
- * @description The whole block header
218
+ * The whole block header
219
219
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-header
220
220
  */
221
221
  getBlockHeader({ block }?: RPCOptions): Promise<BlockHeaderResponse>;
222
222
  /**
223
223
  * @param options contains generic configuration for rpc calls to specified block (default to head) and version
224
- * @description All the metadata associated to the block
224
+ * All the metadata associated to the block
225
225
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-metadata
226
226
  */
227
227
  getBlockMetadata({ block }?: RPCOptions): Promise<BlockMetadata>;
228
228
  /**
229
229
  * @param args contains optional query arguments (level, cycle, delegate, consensus_key, and max_round)
230
230
  * @param options contains generic configuration for rpc calls to specified block (default to head)
231
- * @description Retrieves the list of delegates allowed to bake a block.
231
+ * Retrieves the list of delegates allowed to bake a block.
232
232
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
233
233
  */
234
234
  getBakingRights(args?: BakingRightsQueryArguments, { block }?: RPCOptions): Promise<BakingRightsResponse>;
235
235
  /**
236
236
  * @param args contains optional query arguments (level, cycle, delegate, and consensus_key)
237
237
  * @param options contains generic configuration for rpc calls to specified block (default to head)
238
- * @description Retrieves the delegates allowed to attest a block
238
+ * Retrieves the delegates allowed to attest a block
239
239
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
240
240
  */
241
241
  getAttestationRights(args?: AttestationRightsQueryArguments, { block }?: RPCOptions): Promise<AttestationRightsResponse>;
242
242
  /**
243
243
  * @param options contains generic configuration for rpc calls to specified block (default to head)
244
- * @description Ballots casted so far during a voting period
244
+ * Ballots casted so far during a voting period
245
245
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-ballot-list
246
246
  */
247
247
  getBallotList({ block }?: RPCOptions): Promise<BallotListResponse>;
248
248
  /**
249
249
  * @param options contains generic configuration for rpc calls to specified block (default to head)
250
- * @description Sum of ballots casted so far during a voting period
250
+ * Sum of ballots casted so far during a voting period
251
251
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-ballots
252
252
  */
253
253
  getBallots({ block }?: RPCOptions): Promise<BallotsResponse>;
254
254
  /**
255
255
  * @param options contains generic configuration for rpc calls to specified block (default to head)
256
- * @description Current proposal under evaluation.
256
+ * Current proposal under evaluation.
257
257
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-proposal
258
258
  */
259
259
  getCurrentProposal({ block, }?: RPCOptions): Promise<CurrentProposalResponse>;
260
260
  /**
261
261
  * @param options contains generic configuration for rpc calls to specified block (default to head)
262
- * @description Current expected quorum.
262
+ * Current expected quorum.
263
263
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-quorum
264
264
  */
265
265
  getCurrentQuorum({ block, }?: RPCOptions): Promise<CurrentQuorumResponse>;
266
266
  /**
267
267
  * @param options contains generic configuration for rpc calls to specified block (default to head)
268
- * @description List of delegates with their voting power
268
+ * List of delegates with their voting power
269
269
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-listings
270
270
  */
271
271
  getVotesListings({ block, }?: RPCOptions): Promise<VotesListingsResponse>;
272
272
  /**
273
273
  * @param options contains generic configuration for rpc calls to specified block (default to head)
274
- * @description List of proposals with number of supporters
274
+ * List of proposals with number of supporters
275
275
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-proposals
276
276
  */
277
277
  getProposals({ block }?: RPCOptions): Promise<ProposalsResponse>;
278
278
  /**
279
279
  * @param data operation contents to forge
280
280
  * @param options contains generic configuration for rpc calls to specified block (default to head)
281
- * @description Forge an operation returning the unsigned bytes
281
+ * Forge an operation returning the unsigned bytes
282
282
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
283
283
  */
284
284
  forgeOperations(data: ForgeOperationsParams, { block }?: RPCOptions): Promise<string>;
285
285
  /**
286
286
  * @param signedOpBytes signed bytes to inject
287
- * @description Inject an operation in node and broadcast it and return the ID of the operation
287
+ * Inject an operation in node and broadcast it and return the ID of the operation
288
288
  * @see https://tezos.gitlab.io/shell/rpc.html#post-injection-operation
289
289
  */
290
290
  injectOperation(signedOpBytes: string): Promise<OperationHash>;
291
291
  /**
292
292
  * @param ops Operations to apply
293
293
  * @param options contains generic configuration for rpc calls to specified block and version
294
- * @description Simulate the application of the operations with the context of the given block and return the result of each operation application
294
+ * Simulate the application of the operations with the context of the given block and return the result of each operation application
295
295
  * @see https://tezos.gitlab.io/active/rpc.html#post-block-id-helpers-preapply-operations
296
296
  */
297
297
  preapplyOperations(ops: PreapplyParams, { block }?: RPCOptions): Promise<PreapplyResponse[]>;
298
298
  /**
299
299
  * @param contract address of the contract we want to get the entrypoints of
300
300
  * @param options contains generic configuration for rpc calls to specified block (default to head)
301
- * @description Return the list of entrypoints of the contract
301
+ * Return the list of entrypoints of the contract
302
302
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-entrypoints
303
- * @version 005_PsBABY5H
303
+ * @remarks version 005_PsBABY5H
304
304
  */
305
305
  getEntrypoints(contract: string, { block }?: RPCOptions): Promise<EntrypointsResponse>;
306
306
  /**
307
307
  * @param op Operation to simulate
308
308
  * @param options contains generic configuration for rpc calls to specified block and version
309
- * @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.
309
+ * 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.
310
310
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
311
311
  */
312
312
  simulateOperation(op: RPCSimulateOperationParam, { block }?: RPCOptions): Promise<PreapplyResponse>;
313
313
  /**
314
314
  * @param code Code to run
315
315
  * @param options contains generic configuration for rpc calls to specified block (default to head)
316
- * @description Run a Michelson script in the current context
316
+ * Run a Michelson script in the current context
317
317
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
318
318
  */
319
319
  runCode(code: RPCRunCodeParam, { block }?: RPCOptions): Promise<RunCodeResult>;
320
320
  /**
321
321
  * @param viewScriptParams Parameters of the script view to run
322
322
  * @param options contains generic configuration for rpc calls to specified block (default to head)
323
- * @description Simulate a call to a michelson view
323
+ * Simulate a call to a michelson view
324
324
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
325
325
  */
326
326
  runScriptView({ unparsing_mode, ...rest }: RPCRunScriptViewParam, { block }?: RPCOptions): Promise<RunScriptViewResult>;
327
327
  /**
328
328
  * @param viewParams Parameters of the view to run
329
329
  * @param options contains generic configuration for rpc calls to specified block (default to head)
330
- * @description Simulate a call to a view following the TZIP-4 standard.
330
+ * Simulate a call to a view following the TZIP-4 standard.
331
331
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
332
332
  */
333
333
  runView({ unparsing_mode, ...rest }: RPCRunViewParam, { block }?: RPCOptions): Promise<RunViewResult>;
@@ -335,7 +335,7 @@ export declare class RpcClientCache implements RpcClientInterface {
335
335
  /**
336
336
  * @param data Data to pack
337
337
  * @param options contains generic configuration for rpc calls to specified block (default to head)
338
- * @description Computes the serialized version of a data expression using the same algorithm as script instruction PACK
338
+ * Computes the serialized version of a data expression using the same algorithm as script instruction PACK
339
339
  * Note: You should always verify the packed bytes before signing or requesting that they be signed when using the RPC to pack.
340
340
  * This precaution helps protect you and your applications users from RPC nodes that have been compromised.
341
341
  * 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.
@@ -349,18 +349,18 @@ export declare class RpcClientCache implements RpcClientInterface {
349
349
  }>;
350
350
  /**
351
351
  *
352
- * @description Return rpc root url
352
+ * Return rpc root url
353
353
  */
354
354
  getRpcUrl(): string;
355
355
  /**
356
356
  * @param options contains generic configuration for rpc calls to specified block (default to head)
357
- * @description Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block
357
+ * Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block
358
358
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-current-period
359
359
  */
360
360
  getCurrentPeriod({ block, }?: RPCOptions): Promise<VotingPeriodBlockResult>;
361
361
  /**
362
362
  * @param options contains generic configuration for rpc calls to specified block (default to head)
363
- * @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
363
+ * 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
364
364
  * @example getSuccessorPeriod() will default to successor voting period for /main/chains/block/head.
365
365
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-votes-successor-period
366
366
  */
@@ -368,7 +368,7 @@ export declare class RpcClientCache implements RpcClientInterface {
368
368
  /**
369
369
  * @param id Sapling state ID
370
370
  * @param options contains generic configuration for rpc calls to specified block (default to head)
371
- * @description Returns the root and a diff of a state starting from an optional offset which is zero by default
371
+ * Returns the root and a diff of a state starting from an optional offset which is zero by default
372
372
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-sapling-sapling-state-id-get-diff
373
373
  */
374
374
  getSaplingDiffById(id: string, { block }?: {
@@ -377,7 +377,7 @@ export declare class RpcClientCache implements RpcClientInterface {
377
377
  /**
378
378
  * @param contract address of the contract we want to get the sapling diff
379
379
  * @param options contains generic configuration for rpc calls to specified block (default to head)
380
- * @description Returns the root and a diff of a state starting from an optional offset which is zero by default
380
+ * Returns the root and a diff of a state starting from an optional offset which is zero by default
381
381
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-single-sapling-get-diff
382
382
  */
383
383
  getSaplingDiffByContract(contract: string, { block }?: {
@@ -385,22 +385,22 @@ export declare class RpcClientCache implements RpcClientInterface {
385
385
  }): Promise<SaplingDiffResponse>;
386
386
  /**
387
387
  * @param options contains generic configuration for rpc calls to specified block (default to head)
388
- * @description get current and next protocol
388
+ * get current and next protocol
389
389
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
390
390
  */
391
391
  getProtocols({ block }?: {
392
392
  block: string;
393
393
  }): Promise<ProtocolsResponse>;
394
394
  /**
395
- * @param options contains generic configuration for rpc calls to specified block (default to head)
396
- * @description get current and next protocol
395
+ * @param protocol the protocol hash to look up (default to empty string)
396
+ * get current and next protocol
397
397
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-protocols
398
398
  */
399
399
  getProtocolActivations(protocol?: string): Promise<ProtocolActivationsResponse>;
400
400
  /**
401
401
  * @param contract address of the contract we want to retrieve storage information of
402
402
  * @param options contains generic configuration for rpc calls to specified block (default to head)
403
- * @description Access the used storage space of the contract
403
+ * Access the used storage space of the contract
404
404
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
405
405
  */
406
406
  getStorageUsedSpace(contract: string, { block }?: {
@@ -409,7 +409,7 @@ export declare class RpcClientCache implements RpcClientInterface {
409
409
  /**
410
410
  * @param contract address of the contract we want to retrieve storage information of
411
411
  * @param options contains generic configuration for rpc calls to specified block (default to head)
412
- = * @description Access the paid storage space of the contract
412
+ = * Access the paid storage space of the contract
413
413
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
414
414
  */
415
415
  getStoragePaidSpace(contract: string, { block }?: {
@@ -419,7 +419,7 @@ export declare class RpcClientCache implements RpcClientInterface {
419
419
  * @param contract implicit or originated address we want to retrieve ticket balance of
420
420
  * @param ticket object to specify a ticket by ticketer, content type and content
421
421
  * @param options contains generic configuration for rpc calls to specified block (default to head)
422
- * @description Access the contract's balance of ticket with specified ticketer, content type, and content.
422
+ * Access the contract's balance of ticket with specified ticketer, content type, and content.
423
423
  * @example ticket { ticketer: 'address', content_type: { prim: "string" }, content: { string: 'ticket1' } }
424
424
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
425
425
  */
@@ -427,40 +427,45 @@ export declare class RpcClientCache implements RpcClientInterface {
427
427
  /**
428
428
  * @param contract originated address we want to retrieve ticket balances of
429
429
  * @param options contains generic configuration for rpc calls to specified block (default to head)
430
- * @description Access the complete list of tickets owned by the given contract by scanning the contract's storage.
430
+ * Access the complete list of tickets owned by the given contract by scanning the contract's storage.
431
431
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
432
432
  */
433
433
  getAllTicketBalances(contract: string, { block }?: RPCOptions): Promise<AllTicketBalances>;
434
434
  /**
435
- * @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.
435
+ * 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.
436
436
  * @param options contains generic configuration for rpc calls to specified block (default to head)
437
437
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-adaptive-issuance-launch-cycle
438
438
  */
439
439
  getAdaptiveIssuanceLaunchCycle({ block, }?: RPCOptions): Promise<AILaunchCycleResponse>;
440
440
  /**
441
- * @description List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
441
+ * List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
442
442
  * @param args has 5 optional properties
443
443
  * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
444
444
  */
445
445
  getPendingOperations(args?: PendingOperationsQueryArguments): Promise<PendingOperationsV2>;
446
+ /**
447
+ * Returns the current mempool fee filter configuration.
448
+ * @param args optional query arguments for the mempool/filter endpoint
449
+ */
450
+ getMempoolFilter(args?: MempoolFilterQueryArguments): Promise<MempoolFilterResponse>;
446
451
  /**
447
452
  * @param delegate delegate address which we want to retrieve active staking parameters
448
453
  * @param options contains generic configuration for rpc calls to specified block (default to head)
449
- * @description Returns the currently active staking parameters for the given delegate
454
+ * Returns the currently active staking parameters for the given delegate
450
455
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-active-staking-parameters
451
456
  */
452
457
  getActiveStakingParameters(delegate: string, { block }?: RPCOptions): Promise<ActiveStakingParametersResponse>;
453
458
  /**
454
459
  * @param delegate delegate address which we want to retrieve pending staking parameters
455
460
  * @param options contains generic configuration for rpc calls to specified block (default to head)
456
- * @description Returns the pending values for the given delegate's staking parameters
461
+ * Returns the pending values for the given delegate's staking parameters
457
462
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-delegates-pkh-pending-staking-parameters
458
463
  */
459
464
  getPendingStakingParameters(delegate: string, { block }?: RPCOptions): Promise<PendingStakingParametersResponse>;
460
465
  /**
461
466
  * @param destination address to retrieve the index for
462
467
  * @param options contains generic configuration for rpc calls to specified block (default to head)
463
- * @description Returns the index assigned to the address if it was indexed by the opcode INDEX_ADDRESS, otherwise returns null
468
+ * Returns the index assigned to the address if it was indexed by the opcode INDEX_ADDRESS, otherwise returns null
464
469
  * @see https://octez.tezos.com/docs/alpha/rpc.html#get-block-id-context-destination-destination-id-index
465
470
  */
466
471
  getDestinationIndex(destination: string, { block }?: RPCOptions): Promise<DestinationIndexResponse>;