Refactor stx methods

secretkeylabs · Oct 4, 2024 · 4bfb016 · 4bfb016
1 parent 2c15589
commit 4bfb016
Show file tree

Hide file tree

Showing 12 changed files with 428 additions and 346 deletions.
diff --git a/src/request/types/index.ts b/src/request/types/index.ts
@@ -9,7 +9,7 @@ export interface StxRequests {
   stx_deployContract: StxMethods.StxDeployContract;
   stx_getAccounts: StxMethods.StxGetAccounts;
   stx_getAddresses: StxMethods.StxGetAddresses;
-  stx_signMessage: StxMethods.StxSignStxMessage;
+  stx_signMessage: StxMethods.StxSignMessage;
   stx_signStructuredMessage: StxMethods.StxSignStructuredMessage;
   stx_signTransaction: StxMethods.StxSignTransaction;
   stx_transferStx: StxMethods.StxTransferStx;

diff --git a/src/request/types/stxMethods.ts b/src/request/types/stxMethods.ts
diff --git a/src/request/types/stxMethods/README.md b/src/request/types/stxMethods/README.md
@@ -0,0 +1,10 @@
+# Stacks Methods
+
+- All values and types are prefixed with `stx*` / `Stx*` to avoid name name clashes with similar methods from other chains or operations.
+- Files have the same name as the method name, without the prefix.
+- For consistency, each method file should export
+  - method name
+  - params: schema & type
+  - response: schema & type
+  - request message: schema & type
+  - helper type built with `MethodParamsAndResult`