Default to soft finality (#2252)

Author: jribbink

.changeset/thin-pants-walk.md

@@ -0,0 +1,12 @@
+---
+"@onflow/fcl-react-native": minor
+"@onflow/fcl-core": minor
+"@onflow/fcl": minor
+"@onflow/sdk": minor
+---
+
+Default to soft-finality for all queries (get account, get block, get block header, execute script).  Developers can manually override this setting on a per-query basis if required.
+
+Because developers can now query against un-sealed blocks, it is now recommended to switch to waiting for soft-finality ("executed" status) when awaiting for transaction results whenever possible for significant latency improvements (~2.5x faster).
+
+This can be done by switching from `fcl.tx(...).onceSealed()` to `fcl.tx(...).onceExecuted()` or updating listeners passed to `fcl.tx(...).subscribe()`.

packages/fcl-core/src/exec/query.js

@@ -41,7 +41,7 @@ export async function query(opts = {}) {
     .send([
       sdk.script(opts.cadence),
       sdk.args(normalizeArgs(opts.args || [])),
-      opts.isSealed != null && sdk.atLatestBlock(opts.isSealed),
+      sdk.atLatestBlock(opts.isSealed ?? false),
       opts.limit && typeof opts.limit === "number" && sdk.limit(opts.limit),
     ])
     .then(sdk.decode)

packages/sdk/src/account/account.ts

@@ -43,7 +43,7 @@ export async function account(
 
   // Get account by latest block
   return await send(
-    [getAccount(address), isSealed != null && atLatestBlock(isSealed)],
+    [getAccount(address), atLatestBlock(isSealed ?? false)],
     opts
   ).then(decode)
 }

packages/sdk/src/resolve/resolve-is-sealed.js

@@ -18,7 +18,6 @@ import {resolveValidators} from "./resolve-validators.js"
 import {resolveFinalNormalization} from "./resolve-final-normalization.js"
 import {resolveVoucherIntercept} from "./resolve-voucher-intercept.js"
 import {resolveComputeLimit} from "./resolve-compute-limit.js"
-import {resolveIsSealed} from "./resolve-is-sealed"
 
 const noop = v => v
 const debug =
@@ -50,7 +49,6 @@ const debug =
   }
 
 export const resolve = pipe([
-  resolveIsSealed,
   resolveCadence,
   debug("cadence", (ix, log) => log(ix.message.cadence)),
   resolveComputeLimit,

packages/sdk/src/resolve/resolve-is-sealed.test.js

@@ -27,7 +27,11 @@ describe("Send Execute Script", () => {
 
     let response = await sendExecuteScript(
       await resolve(
-        await build([script(cadence), args([arg(123, types.Int)])])
+        await build([
+          script(cadence),
+          args([arg(123, types.Int)]),
+          atLatestBlock(true),
+        ])
       ),
       {
         response: responseADT,
@@ -75,11 +79,7 @@ describe("Send Execute Script", () => {
 
     let response = await sendExecuteScript(
       await resolve(
-        await build([
-          script(cadence),
-          args([arg(123, types.Int)]),
-          atLatestBlock(false),
-        ])
+        await build([script(cadence), args([arg(123, types.Int)])])
       ),
       {
         response: responseADT,

packages/sdk/src/resolve/resolve.js

@@ -60,7 +60,7 @@ describe("Send Get Account", () => {
     })
   })
 
-  test("GetAccountAtLatestBlockRequest - sealed", async () => {
+  test("GetAccountAtLatestBlockRequest - final", async () => {
     const httpRequestMock = jest.fn()
 
     const returnedAccount = {
@@ -95,7 +95,7 @@ describe("Send Get Account", () => {
 
     expect(valueSent).toEqual({
       hostname: "localhost",
-      path: "/v1/accounts/1654653399040a61?block_height=sealed&expand=contracts,keys",
+      path: "/v1/accounts/1654653399040a61?block_height=final&expand=contracts,keys",
       method: "GET",
       body: null,
     })
@@ -108,7 +108,7 @@ describe("Send Get Account", () => {
     })
   })
 
-  test("GetAccountAtLatestBlockRequest - final", async () => {
+  test("GetAccountAtLatestBlockRequest - sealed", async () => {
     const httpRequestMock = jest.fn()
 
     const returnedAccount = {
@@ -123,7 +123,7 @@ describe("Send Get Account", () => {
 
     const response = await sendGetAccount(
       await resolve(
-        await build([getAccount("0x1654653399040a61"), atLatestBlock(false)])
+        await build([getAccount("0x1654653399040a61"), atLatestBlock(true)])
       ),
       {
         response: responseADT,
@@ -145,7 +145,7 @@ describe("Send Get Account", () => {
 
     expect(valueSent).toEqual({
       hostname: "localhost",
-      path: "/v1/accounts/1654653399040a61?block_height=final&expand=contracts,keys",
+      path: "/v1/accounts/1654653399040a61?block_height=sealed&expand=contracts,keys",
       method: "GET",
       body: null,
     })