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.

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

feat!: Switch to SIP-030 #403

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat!: Switch to SIP-030 #403

wants to merge 4 commits into from

Conversation

janniks
Copy link
Collaborator

@janniks janniks commented Jan 14, 2025

🚧 WIP

  • Add new JSON RPC APIs and types (e.g. stx_signMessage)
    • These consist of: method, params, and response types.
  • Deprecate but keep most legacy methods, to avoid breaking as much as possible for dApps
  • Add TypeBox and Zod schemas for wallets and apps to validate.

Apologies for the large diff. The gist of this pull request is switching away from the JWT token-based API to the new JSON RPC-based API. However, we want to stay largely backwards compatible with the previous connect version, even though this will be a breaking change. And thus many no-op functions and types are still included. Sometimes even slightly broken behaviors kept for ease of dApp developer experience.

Copy link

changeset-bot bot commented Jan 14, 2025

⚠️ No Changeset found

Latest commit: 98173fa

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

Copy link

vercel bot commented Jan 14, 2025

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

Name Status Preview Comments Updated (UTC)
connect ❌ Failed (Inspect) Jan 16, 2025 7:26pm
connect-docs ❌ Failed (Inspect) Jan 16, 2025 7:26pm


// TYPES

export type NetworkString = 'mainnet' | 'testnet' | 'regtest' | 'devnet' | string;
Copy link
Contributor

Choose a reason for hiding this comment

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

afaik typescript will not autocomplete this unless you use a LiteralUnion

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'll try that. Thx
I did try the string literal union, but with string being a union member didn't work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants