Skip to content

feat: add support for sip018 #236

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

Merged
merged 1 commit into from
Jun 21, 2022
Merged

feat: add support for sip018 #236

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .changeset/cuddly-rabbits-reply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@stacks/connect': patch
---

Add better support for SIP-018 signing structured data
2 changes: 1 addition & 1 deletion packages/connect/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"@stacks/connect-ui": "5.5.1",
"@stacks/network": "4.2.1",
"@stacks/prettier-config": "0.0.8",
"@stacks/transactions": "4.2.1",
"@stacks/transactions": "4.3.0",
"bn.js": "^5.2.0",
"buffer": "6.0.3",
"jsontokens": "^3.0.0",
Expand Down
2 changes: 2 additions & 0 deletions packages/connect/src/signature/structuredData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ async function generateTokenAndOpenPopup<T extends StructuredDataSignatureOption

async function signPayload(payload: StructuredDataSignaturePayload, privateKey: string) {
const tokenSigner = new TokenSigner('ES256k', privateKey);

// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
return tokenSigner.signAsync({
...payload,
message: serializeCV(payload.message).toString('hex'),
domain: serializeCV(payload.domain).toString('hex'),
} as any);
}

Expand Down
1 change: 1 addition & 0 deletions packages/connect/src/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ export * from './provider';
export * from './auth';
export * from './transactions';
export * from './signature';
export * from './structuredDataSignature';
5 changes: 4 additions & 1 deletion packages/connect/src/types/structuredDataSignature.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ClarityValue } from '@stacks/transactions';
import { ClarityValue, TupleCV } from '@stacks/transactions';
import {
CommonSignaturePayload,
CommonSignatureRequestOptions,
Expand All @@ -8,10 +8,12 @@ import {

export interface StructuredDataSignatureRequestOptions extends CommonSignatureRequestOptions {
message: ClarityValue;
domain: TupleCV;
}

export interface StructuredDataSignatureOptions {
message: ClarityValue;
domain: TupleCV;
onFinish?: SignatureFinished;
onCancel?: SignatureCanceled;
}
Expand All @@ -23,4 +25,5 @@ export type StructuredDataSignaturePopup = {

export interface StructuredDataSignaturePayload extends CommonSignaturePayload {
message: ClarityValue;
domain: TupleCV;
}
48 changes: 41 additions & 7 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2643,6 +2643,15 @@
"@types/node" "^14.14.43"
buffer "^6.0.3"

"@stacks/common@^4.3.0":
version "4.3.0"
resolved "https://registry.yarnpkg.com/@stacks/common/-/common-4.3.0.tgz#add68aa8ab09da20c7ed7e3aad0c88cc4374de81"
integrity sha512-3/n3E9VGoE/cTPfdBUmFHNer33UZtCiugV0uodXfdUfNbHfILLgk0acTVMI04FufFkglhS3seiOD+R5Z2pBUYA==
dependencies:
"@types/bn.js" "^5.1.0"
"@types/node" "^14.14.43"
buffer "^6.0.3"

"@stacks/encryption@^4.2.2":
version "4.2.2"
resolved "https://registry.yarnpkg.com/@stacks/encryption/-/encryption-4.2.2.tgz#3f8f485cfa2765b5c0ca39b9b37facbfd2911d76"
Expand Down Expand Up @@ -2679,6 +2688,14 @@
"@stacks/common" "^4.2.1"
cross-fetch "^3.1.5"

"@stacks/network@^4.3.0":
version "4.3.0"
resolved "https://registry.yarnpkg.com/@stacks/network/-/network-4.3.0.tgz#5d2815078d2baea7cccc45117b26a675de5d5908"
integrity sha512-X97IFfhJe5aZu8F1tOvYCzoIxPD5PH/NB24/WDZ+JH5Loho1D7zk1zZ6bOtQknaSfezDyi6wsZwKC/7Mxg959A==
dependencies:
"@stacks/common" "^4.3.0"
cross-fetch "^3.1.5"

"@stacks/[email protected]", "@stacks/prettier-config@^0.0.8":
version "0.0.8"
resolved "https://registry.yarnpkg.com/@stacks/prettier-config/-/prettier-config-0.0.8.tgz#4db04dbca3982f74f4554ca522f37570125516e3"
Expand All @@ -2703,7 +2720,24 @@
schema-inspector "^2.0.1"
zone-file "^2.0.0-beta.3"

"@stacks/[email protected]", "@stacks/transactions@^4.2.1":
"@stacks/[email protected]":
version "4.3.0"
resolved "https://registry.yarnpkg.com/@stacks/transactions/-/transactions-4.3.0.tgz#54a01bd4ce201fe262680aca310f72186fa42766"
integrity sha512-TUf9fZHokZ66qMPoVGtpLPmwAc/v0O2HYWl7e1fym2kz17DKhG8JISfPKCUssaVdRyQ+xp40sozRSO0fEK+jZA==
dependencies:
"@noble/hashes" "^1.0.0"
"@noble/secp256k1" "^1.5.5"
"@stacks/common" "^4.3.0"
"@stacks/network" "^4.3.0"
"@types/node" "^14.14.43"
"@types/sha.js" "^2.4.0"
c32check "^1.1.3"
lodash.clonedeep "^4.5.0"
ripemd160-min "^0.0.6"
sha.js "^2.4.11"
smart-buffer "^4.1.0"

"@stacks/transactions@^4.2.1":
version "4.2.1"
resolved "https://registry.yarnpkg.com/@stacks/transactions/-/transactions-4.2.1.tgz#ac5f62bc09f7c0b15df13512eb28ab5887a49167"
integrity sha512-sqAwPLM2TjUEozDXQQdm+B3jk0Dl8IcbmkrUcyiyJuZUO6Ea9u21IbyntQb/OjtBxxg9Qx/8uCUUarlbicTSVQ==
Expand Down Expand Up @@ -6321,7 +6355,7 @@ flush-write-stream@^1.0.0:
follow-redirects@^1.10.0, follow-redirects@^1.14.0:
version "1.14.8"
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.8.tgz#016996fb9a11a100566398b1c6839337d7bfa8fc"
integrity sha512-1x0S9UVJHsQprFcEC/qnNzBLcIxsjAV905f/UkQxbclCsoTWlacCNOpQa/anodLl2uaEKFhfWOvM2Qg77+15zA==
integrity "sha1-AWmW+5oRoQBWY5ixxoOTN9e/qPw= sha512-1x0S9UVJHsQprFcEC/qnNzBLcIxsjAV905f/UkQxbclCsoTWlacCNOpQa/anodLl2uaEKFhfWOvM2Qg77+15zA=="

for-in@^1.0.2:
version "1.0.2"
Expand Down Expand Up @@ -6632,7 +6666,7 @@ glob-to-regexp@^0.4.1:
glob@^7.0.0, glob@^7.1.1, glob@^7.1.2, glob@^7.1.3, glob@^7.1.4, glob@^7.1.6:
version "7.2.0"
resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.0.tgz#d15535af7732e02e948f4c41628bd910293f6023"
integrity sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==
integrity "sha1-0VU1r3cy4C6Uj0xBYovZECk/YCM= sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q=="
dependencies:
fs.realpath "^1.0.0"
inflight "^1.0.4"
Expand Down Expand Up @@ -7248,7 +7282,7 @@ is-core-module@^2.2.0, is-core-module@^2.5.0, is-core-module@^2.6.0:
is-core-module@^2.8.0:
version "2.8.1"
resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.8.1.tgz#f59fdfca701d5879d0a6b100a40aa1560ce27211"
integrity sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA==
integrity "sha1-9Z/fynAdWHnQprEApAqhVgzichE= sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA=="
dependencies:
has "^1.0.3"

Expand Down Expand Up @@ -8822,7 +8856,7 @@ mixin-deep@^1.2.0:
mixme@^0.5.1:
version "0.5.2"
resolved "https://registry.yarnpkg.com/mixme/-/mixme-0.5.2.tgz#33c7e21d8e9b73abc2711c5197ae6c93f65fe0e4"
integrity sha512-fzzuzXSqp14Mk2eZK15yqcJHwNlLtg+EliQBO/ihYfZed9WUuDHR9ZuEUqQDD8FcW/742y0JGq8xBfL9fNsWZw==
integrity "sha1-M8fiHY6bc6vCcRxRl65sk/Zf4OQ= sha512-fzzuzXSqp14Mk2eZK15yqcJHwNlLtg+EliQBO/ihYfZed9WUuDHR9ZuEUqQDD8FcW/742y0JGq8xBfL9fNsWZw=="

mkdirp-classic@^0.5.2, mkdirp-classic@^0.5.3:
version "0.5.3"
Expand Down Expand Up @@ -10508,7 +10542,7 @@ [email protected]:
resolve@^1.1.6:
version "1.21.0"
resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.21.0.tgz#b51adc97f3472e6a5cf4444d34bc9d6b9037591f"
integrity sha512-3wCbTpk5WJlyE4mSOtDLhqQmGFi0/TD9VPwmiolnk8U0wRgMEktqCXd3vy5buTO3tljvalNvKrjHEfrd2WpEKA==
integrity "sha1-tRrcl/NHLmpc9ERNNLyda5A3WR8= sha512-3wCbTpk5WJlyE4mSOtDLhqQmGFi0/TD9VPwmiolnk8U0wRgMEktqCXd3vy5buTO3tljvalNvKrjHEfrd2WpEKA=="
dependencies:
is-core-module "^2.8.0"
path-parse "^1.0.7"
Expand Down Expand Up @@ -11778,7 +11812,7 @@ trim-newlines@^3.0.0:
trim-off-newlines@^1.0.0:
version "1.0.3"
resolved "https://registry.yarnpkg.com/trim-off-newlines/-/trim-off-newlines-1.0.3.tgz#8df24847fcb821b0ab27d58ab6efec9f2fe961a1"
integrity sha512-kh6Tu6GbeSNMGfrrZh6Bb/4ZEHV1QlB4xNDBeog8Y9/QwFlKTRyWvY3Fs9tRDAMZliVUwieMgEdIeL/FtqjkJg==
integrity "sha1-jfJIR/y4IbCrJ9WKtu/sny/pYaE= sha512-kh6Tu6GbeSNMGfrrZh6Bb/4ZEHV1QlB4xNDBeog8Y9/QwFlKTRyWvY3Fs9tRDAMZliVUwieMgEdIeL/FtqjkJg=="

ts-jest@^25.3.1:
version "25.5.1"
Expand Down