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!: making provider initialization sync again #3514

Merged
merged 36 commits into from
Jan 6, 2025
Merged

feat!: making provider initialization sync again #3514

merged 36 commits into from
Jan 6, 2025

Conversation

arboleya
Copy link
Member

@arboleya arboleya commented Jan 1, 2025 •
edited
Loading

Release notes

In this release, we:

  • Made Provider constructor public and sync again

Summary

The first implementation got it backward, but now things are back in place:

  • Constructor is sync and public again
  • Methods that need remote data are async (like they should)

Oneliners help to show why async initialization isn't good — look at the awkward parenthesis we must use to isolate the call before other methods (the actual async ones) can be chained.

// before
(await Provider.create(NETWORK_URL)).getChainId();

// after
await new Provider(NETWORK_URL).getChainId();

Breaking Changes

1. Provider Instantiation

  • Going from async to sync
// before
const provider = await Provider.create(NETWORK_URL);
// after
const provider = new Provider(NETWORK_URL);

2. Provider methods

  • The following methods are now async
// before
provider.getNode();
provider.getChain();
provider.getChainId();
provider.getBaseAssetId();
provider.getGasConfig();
provider.validateTransaction();
// after
await provider.getNode();
await provider.getChain();
await provider.getChainId();
await provider.getBaseAssetId();
await provider.getGasConfig();
await provider.validateTransaction();

3. TransferParams and ContractTransferParams

export type TransferParams = {
  destination: string | AbstractAddress;
  amount: BigNumberish;
-  assetId?: BytesLike;
+  assetId: BytesLike;
};

export type ContractTransferParams = {
  contractId: string | AbstractAddress;
  amount: BigNumberish;
-  assetId?: BytesLike;
+  assetId: BytesLike;
};

4. Transaction Response

  • The constructor now requires a chainId
// before
new TransactionResponse('0x..', provider);
// after
new TransactionResponse('0x..', provider, chainId);

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)

@arboleya arboleya added the feat Issue is a feature label Jan 1, 2025
@arboleya arboleya self-assigned this Jan 1, 2025
@vercel Vercel
Copy link

vercel bot commented Jan 1, 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 Jan 6, 2025 1:52pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 1:52pm
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 1:52pm

@arboleya arboleya marked this pull request as ready for review January 1, 2025 11:06
@arboleya arboleya marked this pull request as draft January 1, 2025 11:48
nedsalk
nedsalk previously approved these changes Jan 2, 2025
View reviewed changes
danielbate
danielbate previously approved these changes Jan 3, 2025
View reviewed changes
@arboleya arboleya enabled auto-merge (squash) January 6, 2025 12:59
@petertonysmith94 petertonysmith94 dismissed stale reviews from nedsalk, danielbate, and themself via 1cf6aa5 January 6, 2025 13:24
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 6, 2025

Coverage Report:

Lines Branches Functions Statements
77.82%(+0.01%) 70.58%(+0.11%) 75.38%(-0.04%) 77.78%(+0.01%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 packages/account/src/account.ts 78.23%
(-0.59%)		 63.88%
(+0.37%)		 80%
(+0%)		 78.03%
(-0.58%)
🔴 packages/account/src/providers/provider.ts 68.55%
(-0.47%)		 56.56%
(-0.58%)		 70.21%
(-0.75%)		 68.28%
(-0.45%)
🔴 packages/account/src/providers/transaction-response/transaction-response.ts 76.4%
(-0.87%)		 65.45%
(+0%)		 93.75%
(+0%)		 76.4%
(-0.87%)
🔴 packages/fuels/src/cli/commands/deploy/createWallet.ts 92.3%
(+0.64%)		 75%
(+0%)		 100%
(+0%)		 92.3%
(+0.64%)

@arboleya arboleya merged commit 458b7cf into master Jan 6, 2025
30 of 32 checks passed
@arboleya arboleya deleted the aa/feat/sync-provider-init branch January 6, 2025 15:14
@fuel-service-user fuel-service-user mentioned this pull request Jan 6, 2025
Open
This was referenced Jan 7, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Torres-ssf Torres-ssf Torres-ssf approved these changes

@petertonysmith94 petertonysmith94 petertonysmith94 approved these changes

@danielbate danielbate danielbate approved these changes

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

@Dhaiwat10 Dhaiwat10 Awaiting requested review from Dhaiwat10

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

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

Assignees

@arboleya arboleya

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

Successfully merging this pull request may close these issues.

Make Provider initialization sync again
5 participants
@arboleya @danielbate @petertonysmith94 @nedsalk @Torres-ssf