From fe1347b441d5c9c5d6ad9115c09e002a4c51a8ac Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 2 Feb 2021 18:48:19 +0000 Subject: [PATCH] Clean up some old commitment names (#14994) (#15003) (cherry picked from commit 2780214e71d310e332bf49e152cd72743da08222) Co-authored-by: Tyera Eulberg --- docs/src/developing/clients/jsonrpc-api.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/src/developing/clients/jsonrpc-api.md b/docs/src/developing/clients/jsonrpc-api.md index 32274b4801..80692fb87d 100644 --- a/docs/src/developing/clients/jsonrpc-api.md +++ b/docs/src/developing/clients/jsonrpc-api.md @@ -162,7 +162,7 @@ curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d ' "params": [ "83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri", { - "commitment": "max" + "commitment": "finalized" } ] } @@ -171,7 +171,7 @@ curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d ' #### Default: -If commitment configuration is not provided, the node will default to `"max"` commitment +If commitment configuration is not provided, the node will default to `"finalized"` commitment Only methods that query bank state accept the commitment parameter. They are indicated in the API Reference below. @@ -2826,7 +2826,7 @@ submission. - `` - fully-signed Transaction, as encoded string - `` - (optional) Configuration object containing the following field: - `skipPreflight: ` - if true, skip the preflight transaction checks (default: false) - - `preflightCommitment: ` - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) level to use for preflight (default: `"max"`). + - `preflightCommitment: ` - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) level to use for preflight (default: `"finalized"`). - `encoding: ` - (optional) Encoding used for the transaction data. Either `"base58"` (*slow*, **DEPRECATED**), or `"base64"`. (default: `"base58"`). #### Results: @@ -2863,7 +2863,7 @@ Simulate sending a transaction - `` - Transaction, as an encoded string. The transaction must have a valid blockhash, but is not required to be signed. - `` - (optional) Configuration object containing the following field: - `sigVerify: ` - if true the transaction signatures will be verified (default: false) - - `commitment: ` - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) level to simulate the transaction at (default: `"max"`). + - `commitment: ` - (optional) [Commitment](jsonrpc-api.md#configuring-state-commitment) level to simulate the transaction at (default: `"finalized"`). - `encoding: ` - (optional) Encoding used for the transaction data. Either `"base58"` (*slow*, **DEPRECATED**), or `"base64"`. (default: `"base58"`). #### Results: @@ -2995,7 +2995,7 @@ Request: "CM78CPUeXjn8o3yroDHxUtKsZZgoy4GPkPPXfouKNH12", { "encoding": "base64", - "commitment": "root" + "commitment": "finalized" } ] } @@ -3132,7 +3132,7 @@ Request: "mentions": [ "11111111111111111111111111111111" ] }, { - "commitment": "max" + "commitment": "finalized" } ] } @@ -3228,7 +3228,7 @@ Request: "11111111111111111111111111111111", { "encoding": "base64", - "commitment": "max" + "commitment": "finalized" } ] } @@ -3390,7 +3390,7 @@ Request: "params": [ "2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b", { - "commitment": "max" + "commitment": "finalized" } ] }