docs: adapting getPendingOperations version change in description (#2936

)
ecadlabs · May 2, 2024 · c142475 · c142475
1 parent 20b3ba9
commit c142475
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/packages/taquito-rpc/src/rpc-client-modules/rpc-cache.ts b/packages/taquito-rpc/src/rpc-client-modules/rpc-cache.ts
@@ -1247,9 +1247,8 @@ export class RpcClientCache implements RpcClientInterface {
 
  /**
  * @description List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
- * @param args has 5 optional properties. We support version 1 as default will output { applied: { kind: endorsement} } version 2 will output { validated: { kind: attestation} }. The rest of the properties is to filter pending operations response
- * @default args { version: '1', applied: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-mempool-openapi-rc.json
+ * @param args has 5 optional properties. We support version 1 & 2
+ * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
  */
  async getPendingOperations(
  args: PendingOperationsQueryArguments = {}

diff --git a/packages/taquito-rpc/src/taquito-rpc.ts b/packages/taquito-rpc/src/taquito-rpc.ts
@@ -1197,8 +1197,8 @@ export class RpcClient implements RpcClientInterface {
 
  /**
  * @description List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
- * @param args has 5 optional properties. We support version 1 as default will output { applied: { kind: endorsement} } version 2 will output { validated: { kind: attestation} }. The rest of the properties is to filter pending operations response
- * @default args { version: '1', applied: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
+ * @param args has 5 optional properties. We support version 1 & 2
+ * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-mempool-openapi-rc.json
  */
  async getPendingOperations(