Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: improved connector JSON RPC interface #3735

Open
wants to merge 31 commits into
base: master
Choose a base branch
from
Open

feat: improved connector JSON RPC interface #3735

wants to merge 31 commits into from

Conversation

petertonysmith94
Copy link
Contributor

@petertonysmith94 petertonysmith94 commented Feb 24, 2025 •
edited
Loading

Release notes

In this release, we:

  • Enhanced the SDK to pass additional information through to the underlying connectors to reduce HTTP requests.

Summary

  • In this change, we have added the following to the SendTransactionJsonRpc specification:
interface SendTransactionJsonRpc extends ExistingSendTransactionJsonRpc {
  // ...
  provider: {
    url: string,
    cache?: {
      consensusParameterTimestamp?: string,
      chain: ChainInfoJson,
      nodeInfo: NodeInfoJson,
    }
  },
  data?: {
    transactionSummary?: TransactionSummaryJson;
  },
  transactionState: undefined | 'funded',
}
  • Definitions of the transaction request state:
State Description
undefined The transaction has not been estimated or funded.
funded The transaction is estimated and funded, the underlying wallet can skip this process.
  • We can now re-instantiate a Provider using the serialised cache:
function sendTransaction(request: TransactionRequest, { provider: { url, cache } }) {
  // This will then not perform a request to the node for chain + node info
  const provider = new Provider(url, { cache });
  
  // ...
}
  • We can now construct a transaction summary from it's serialized form:
const transactionSummary: TransactionSummaryJson = {
  id: request.getTransactionId(chainId),
  transactionBytes: request.toTransactionBytes(),
  gasPrice: txCost.gasPrice.toString(),
  receipts: txCost.rawReceipts,
};
const assembledSummary = await assembleTransactionSummaryFromJson({
  provider,
  transactionSummary,
});

Other related reviews

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

@petertonysmith94
feat: added the state to the transaction request (#3709)
f75c4ce 
* feat: implement flags for the transaction request

* chore: combine flags for `isEstimated` and `isFunded`

* chore: remove `isSigned` from witness updates

* changeset

* revert experimental changes

* Aligned to the new re-spec

* update to state

* Update state

* chore: fix connector test

* lintfix

* Apply suggestions from code review
@petertonysmith94 petertonysmith94 added the feat Issue is a feature label Feb 24, 2025
@petertonysmith94 petertonysmith94 self-assigned this Feb 24, 2025
@vercel Vercel
Copy link

vercel bot commented Feb 24, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 10, 2025 5:49pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 10, 2025 5:49pm
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 10, 2025 5:49pm

@petertonysmith94 petertonysmith94 changed the title feat: added the state to the transaction request (#3709) feat: enhanced the SDK and wallet communication Feb 24, 2025
@petertonysmith94 petertonysmith94 changed the title feat: enhanced the SDK and wallet communication feat: enhance the communication between SDK and wallet Feb 24, 2025
@petertonysmith94
feat: allow provider re-instantiation from chain + node info (#3726)
04b0fed 
* chore: moved chainInfo serialization

* chore: added serialize chain info

* move chain info helper

* add deprecation notice

* chore: added deserialize of nodeInfo

* Added the ability to restore the provider chain + node info cache

* consolidate serialization

* serialize provider cache

* pass serialized chain to connector

* lintfix

* lintfix

* changeset

* changeset

* lintfix
@petertonysmith94
Delete .changeset/metal-trains-argue.md
a239b56
@danielbate danielbate mentioned this pull request Mar 7, 2025
Open
@petertonysmith94 petertonysmith94 changed the title feat: enhance the communication between SDK and wallet feat: improved Connector JSON RPC Interface Mar 10, 2025
@petertonysmith94 petertonysmith94 force-pushed the ps/feat/improved-sdk-wallet-communication branch from 51d5f77 to 5dc3f06 Compare March 10, 2025 10:03
@petertonysmith94 petertonysmith94 changed the base branch from ns/chore/fuel-core-0.42.0 to master March 10, 2025 10:04
@petertonysmith94 petertonysmith94 changed the title feat: improved Connector JSON RPC Interface feat: improved connector JSON RPC interface Mar 10, 2025
arboleya
arboleya previously approved these changes Mar 10, 2025
View reviewed changes
@petertonysmith94 petertonysmith94 mentioned this pull request Mar 10, 2025
Draft
7 tasks
petertonysmith94
petertonysmith94 commented Mar 10, 2025
View reviewed changes
packages/account/src/account.ts Outdated
cache: await serializeProviderCache(this.provider),
},
data,
state: transactionRequest.flag.state,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
state: transactionRequest.flag.state,
transactionState: transactionRequest.flag.state,

I think this makes more sense

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this makes more sense once it's passed through the connector as well.

This was referenced Mar 10, 2025
Draft
Open
@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
77.31%(+0.13%) 71.07%(+0.13%) 75.42%(+0.12%) 77.31%(+0.14%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 packages/account/src/account.ts 82.06%
(+1.48%)		 72.15%
(+0.92%)		 82.92%
(+0.42%)		 81.81%
(+1.47%)
🔴 packages/account/src/providers/provider.ts 67.77%
(+0.27%)		 62.26%
(+0.36%)		 69%
(-0.3%)		 67.61%
(+0.27%)
🔴 packages/account/src/providers/resource-cache.ts 97.95%
(+0%)		 95%
(+5%)		 100%
(+0%)		 97.95%
(+0%)
🔴 packages/account/src/providers/generated/operations.ts 93.16%
(+0.62%)		 100%
(+0%)		 79.62%
(+1.85%)		 93.67%
(+0.57%)
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 87.91%
(+0.41%)		 75.9%
(+0.6%)		 84.31%
(+0.31%)		 88.15%
(+0.4%)
✅ ✨ packages/account/src/providers/transaction-summary/assemble-transaction-summary-from-serialized.ts 100%
(+100%)		 100%
(+100%)		 100%
(+100%)		 100%
(+100%)
🔴 packages/account/src/providers/transaction-summary/receipt.ts 92.85%
(-7.15%)		 100%
(+0%)		 80%
(-20%)		 92.85%
(-7.15%)
✅ packages/account/src/providers/transaction-summary/status.ts 100%
(+0%)		 100%
(+6.67%)		 100%
(+0%)		 100%
(+0%)
🔴 packages/account/src/providers/utils/receipts.ts 84.61%
(-10.7%)		 50%
(-22%)		 100%
(+0%)		 84.61%
(-10.77%)
🔴 ✨ packages/account/src/providers/utils/serialization.ts 98.57%
(+98.57%)		 76.19%
(+76.19%)		 100%
(+100%)		 98.63%
(+98.63%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arboleya arboleya arboleya left review comments

@digorithm digorithm Awaiting requested review from digorithm digorithm is a code owner

@danielbate danielbate Awaiting requested review from danielbate danielbate is a code owner

@LuizAsFight LuizAsFight Awaiting requested review from LuizAsFight

@nedsalk nedsalk Awaiting requested review from nedsalk nedsalk is a code owner

@Torres-ssf Torres-ssf Awaiting requested review from Torres-ssf Torres-ssf is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

@petertonysmith94 petertonysmith94

Labels
feat Issue is a feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve SDK and Wallet Communication
5 participants
@petertonysmith94 @arboleya @danielbate @nedsalk @Torres-ssf