Skip to content

chore: add docs on Key Provider API Spec#209

Merged
pranishnepal merged 1 commit into
masterfrom
WCN-399
May 29, 2026
Merged

chore: add docs on Key Provider API Spec#209
pranishnepal merged 1 commit into
masterfrom
WCN-399

Conversation

@pranishnepal
Copy link
Copy Markdown
Contributor

What

This PR adds documentation for the Key Provider API Spec, including details on the endpoints, request/response formats.

Additionally, updates the README.md to document how the SIGNING_MODE environment variable works.

Ticket: WCN-399

Testing

npx @apidevtools/swagger-cli validate

@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 26, 2026

WCN-399

@pranishnepal pranishnepal marked this pull request as ready for review May 26, 2026 21:12
@pranishnepal pranishnepal requested a review from a team as a code owner May 26, 2026 21:12
Comment thread key-provider-api-spec.yaml Outdated
Comment on lines +249 to +254
solUserKey:
summary: Generate SOL user key (EdDSA)
value:
coin: 'sol'
source: 'user'
type: 'independent'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this doesnt support mpc

Comment thread key-provider-api-spec.yaml Outdated
- Key Management
summary: Generate a key pair
description: |
Generate a new key pair in your KMS/HSM provider.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

imp to clarify this is for multisig keys only

Comment thread key-provider-api-spec.yaml Outdated
- Key Management
summary: Sign a transaction or message
description: |
Sign data using a private key stored in your KMS/HSM provider.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lets clarify only applicable for multisig wallets

This commit adds documentation for the Key
Provider API Spec, including details on the
endpoints, request/response formats,
and error handling.

Additionally, updates the README.md to document
how the SIGNING_MODE environment variable works.

Ticket: WCN-399
@pranishnepal
Copy link
Copy Markdown
Contributor Author

@pranavjain97 -- updated!

@pranishnepal pranishnepal requested a review from pranavjain97 May 28, 2026 14:04
@pranishnepal pranishnepal merged commit 0d3930d into master May 29, 2026
20 checks passed
@pranishnepal pranishnepal deleted the WCN-399 branch May 29, 2026 18:53
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