Skip to content

Commit

Permalink
docs: adapting getPendingOperations version change in description (#2936
Browse files Browse the repository at this point in the history
)
  • Loading branch information
hui-an-yang authored Apr 25, 2024
1 parent 4e1b113 commit 90843ee
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
5 changes: 2 additions & 3 deletions packages/taquito-rpc/src/rpc-client-modules/rpc-cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {}
Expand Down
4 changes: 2 additions & 2 deletions packages/taquito-rpc/src/taquito-rpc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down

0 comments on commit 90843ee

Please sign in to comment.