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

Update the README for @solana/rpc #2993

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Update the README for @solana/rpc #2993

merged 1 commit into from
Jul 30, 2024

Conversation

steveluscher
Copy link
Collaborator

Addresses solana-labs/web3.js-issue-conveyer#10.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 26, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: bfbba70

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@steveluscher Graphite App
Copy link
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @steveluscher and the rest of your teammates on Graphite Graphite

steveluscher
steveluscher commented Jul 26, 2024
View reviewed changes
packages/rpc/src/rpc-clusters.ts
@@ -5,7 +5,6 @@ import type { ClusterUrl, DevnetUrl, MainnetUrl, TestnetUrl } from '@solana/rpc-
export type RpcTransportDevnet = RpcTransport & { '~cluster': 'devnet' };
export type RpcTransportTestnet = RpcTransport & { '~cluster': 'testnet' };
export type RpcTransportMainnet = RpcTransport & { '~cluster': 'mainnet' };
export type RpcTransportWithCluster = RpcTransportDevnet | RpcTransportMainnet | RpcTransportTestnet;
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I couldn't find or think of a use for this. In particular, the Rpc* types below have no such thing.

packages/rpc/src/rpc-default-config.ts Outdated
defaultCommitment: 'confirmed',
onIntegerOverflow(methodName, keyPath, value) {
throw createSolanaJsonRpcIntegerOverflowError(methodName, keyPath, value);
},
};
} as const;
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This prevents us from adding properties here that are not part of the config type.

packages/rpc/src/rpc-transport.ts
@@ -7,7 +7,7 @@ import { getRpcTransportWithRequestCoalescing } from './rpc-request-coalescer';
import { getSolanaRpcPayloadDeduplicationKey } from './rpc-request-deduplication';

type RpcTransportConfig = Parameters<typeof createHttpTransport>[0];
export interface DefaultRpcTransportConfig<TClusterUrl extends ClusterUrl> extends RpcTransportConfig {
interface DefaultRpcTransportConfig<TClusterUrl extends ClusterUrl> extends RpcTransportConfig {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is in use nowhere, so I made it private.

@steveluscher steveluscher requested a review from lorisleiva July 26, 2024 19:33
lorisleiva
lorisleiva approved these changes Jul 27, 2024
View reviewed changes
Copy link
Contributor

@lorisleiva lorisleiva left a comment

Choose a reason for hiding this comment

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

Thanks for that! I'll gradually make my way to your other documentation/example PRs.

packages/rpc/README.md Outdated Show resolved Hide resolved
packages/rpc/README.md Outdated Show resolved Hide resolved
packages/rpc/README.md Show resolved Hide resolved
@steveluscher steveluscher force-pushed the 07-26-update_the_readme_for_solana_rpc_ branch from 21761b9 to f71c133 Compare July 29, 2024 17:01
@steveluscher steveluscher force-pushed the 07-26-update_the_readme_for_solana_rpc_ branch from f71c133 to bfbba70 Compare July 29, 2024 17:26
@steveluscher steveluscher requested a review from lorisleiva July 29, 2024 18:04
lorisleiva
lorisleiva approved these changes Jul 30, 2024
View reviewed changes
Copy link
Contributor

@lorisleiva lorisleiva left a comment

Choose a reason for hiding this comment

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

Thanks for the adjustments!

@steveluscher steveluscher merged commit 62c3666 into master Jul 30, 2024
8 checks passed
@steveluscher steveluscher deleted the 07-26-update_the_readme_for_solana_rpc_ branch July 30, 2024 15:43
@github-actions GitHub Actions
Copy link
Contributor

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@lorisleiva lorisleiva lorisleiva approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@steveluscher @lorisleiva