refactor: move types

hirosystems · Jun 6, 2024 · 3c6bc99 · 3c6bc99
1 parent 969af6a
commit 3c6bc99
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 28 deletions.
diff --git a/packages/transactions/src/builders.ts b/packages/transactions/src/builders.ts
@@ -41,7 +41,6 @@ import {
 } from './postcondition';
 import {
   Asset,
-  AssetString,
   FungiblePostCondition,
   NonFungiblePostCondition,
   PostCondition,
@@ -51,7 +50,7 @@ import {
 } from './postcondition-types';
 import { TransactionSigner } from './signer';
 import { StacksTransaction } from './transaction';
-import { createLPList } from './types';
+import { AssetString, createLPList } from './types';
 import { defaultApiFromNetwork, omit } from './utils';
 
 export interface MultiSigOptions {

diff --git a/packages/transactions/src/cl.ts b/packages/transactions/src/cl.ts
@@ -114,7 +114,6 @@ export const contractPrincipal = contractPrincipalCV;
  * @see {@link serialize}, {@link deserialize}
  */
 export const standardPrincipal = standardPrincipalCV;
-// todo: add .principal method that detects `.` inside string for both standard and contract principals
 
 // Sequences ///////////////////////////////////////////////////////////////////
 /**

diff --git a/packages/transactions/src/keys.ts b/packages/transactions/src/keys.ts
@@ -192,8 +192,8 @@ export function signWithKey(privateKey: PrivateKey, messageHash: string): Messag
 }
 
 /**
- * Signs a message using a private key. The resulting signature along with the
- * original message can be verified using {@link verifyMessageSignatureRsv}
+ * Signs a message hash using a private key. The resulting signature along with
+ * the original message can be verified using {@link verifyMessageSignatureRsv}
  * @returns A recoverable signature (in RSV order)
  */
 export function signMessageHashRsv({

diff --git a/packages/transactions/src/pc.ts b/packages/transactions/src/pc.ts
@@ -9,13 +9,8 @@ import {
 } from './builders';
 import { ClarityValue } from './clarity';
 import { FungibleConditionCode, NonFungibleConditionCode } from './constants';
-import {
-  AddressString,
-  AssetString,
-  ContractIdString,
-  createAsset,
-  NonFungiblePostCondition,
-} from './postcondition-types';
+import { createAsset, NonFungiblePostCondition } from './postcondition-types';
+import { AddressString, AssetString, ContractIdString } from './types';
 
 /// `Pc.` Post Condition Builder
 //

diff --git a/packages/transactions/src/postcondition-types.ts b/packages/transactions/src/postcondition-types.ts
@@ -10,21 +10,7 @@ import { c32addressDecode } from 'c32check';
 import { Address } from './common';
 import { ClarityValue } from './clarity';
 import { exceedsMaxLengthBytes } from './utils';
-
-/**
- * An address string encoded as c32check
- */
-export type AddressString = string;
-
-/**
- * A contract identifier string given as `<address>.<contract-name>`
- */
-export type ContractIdString = `${string}.${string}`;
-
-/**
- * An asset name string given as `<contract-id>::<token-name>` aka `<contract-address>.<contract-name>::<token-name>`
- */
-export type AssetString = `${ContractIdString}::${string}`;
+import { AssetString } from './types';
 
 export interface StandardPrincipal {
   readonly type: StacksMessageType.Principal;

diff --git a/packages/transactions/src/postcondition.ts b/packages/transactions/src/postcondition.ts
@@ -8,14 +8,14 @@ import {
 } from './constants';
 import {
   Asset,
-  AssetString,
   FungiblePostCondition,
   NonFungiblePostCondition,
   PostConditionPrincipal,
   STXPostCondition,
   parseAssetString,
   parsePrincipalString,
 } from './postcondition-types';
+import { AssetString } from './types';
 
 export function createSTXPostCondition(
   principal: string | PostConditionPrincipal,

diff --git a/packages/transactions/src/types.ts b/packages/transactions/src/types.ts
@@ -61,6 +61,21 @@ import {
   rightPadHexToLength,
 } from './utils';
 
+/**
+ * An address string encoded as c32check
+ */
+export type AddressString = string;
+
+/**
+ * A contract identifier string given as `<address>.<contract-name>`
+ */
+export type ContractIdString = `${string}.${string}`;
+
+/**
+ * An asset name string given as `<contract-id>::<token-name>` aka `<contract-address>.<contract-name>::<token-name>`
+ */
+export type AssetString = `${ContractIdString}::${string}`;
+
 export type StacksMessage =
   | Address
   | PostConditionPrincipal