Skip to content

docs: Enhance README with message signing standards #1827

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

Open
jadonamite wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Enhance README with message signing standards #1827

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/transactions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This library supports the creation of the following Stacks transaction types:
2. Smart contract deploy
3. Smart contract function call


## Key Generation

```typescript
Expand All @@ -30,6 +31,15 @@ const publicKey = getPublicKey(privateKey);
const key = 'b244296d5907de9864c0b0d51f98a13c52890be0404e83f273144cd5b9960eed01';
const privateKey = createStacksPrivateKey(key);
```
## Message Signing Standards

When implementing message signing (e.g., for authentication), prefer SIP-018 over legacy methods.

| Standard | Prefix | Recommended For |
| :--- | :--- | :--- |
| **SIP-018 (Structured)** | `SIP018` | **New Apps** (Leather, Xverse compatible) |
| Legacy | `\x17Stacks Signed Message...` | Legacy support only |


## STX Token Transfer Transaction

Expand Down