add stablecoin issuance template

gitteri · gitteri · commit 5901f044d249 · 2025-07-28T17:15:52.000-06:00
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -0,0 +1 @@
+export { Token } from './issuance'; 
diff --git a/packages/core/src/issuance/index.ts b/packages/core/src/issuance/index.ts
@@ -25,10 +25,6 @@ import {
 export class Token {
   private extensions: Extension[] = [];
 
-  getExtensions(): Extension[] {
-    return this.extensions;
-  }
-
   withMetadata({
     mintAddress,
     authority,
@@ -124,19 +120,15 @@ export class Token {
 
     // TODO: Add other post-initialize instructions as needed like for transfer hooks
     const postInitializeInstructions = this.extensions.flatMap(ext =>
-      ext.__kind === 'TokenMetadata'
-        ? [
-            getInitializeTokenMetadataInstruction({
-              metadata: mint.address,
-              mint: mint.address,
-              mintAuthority: feePayer,
-              name: ext.name,
-              symbol: ext.symbol,
-              uri: ext.uri,
-              updateAuthority: authority,
-            }),
-          ]
-        : []
+      ext.__kind === 'TokenMetadata' ? [getInitializeTokenMetadataInstruction({
+        metadata: mint.address,
+        mint: mint.address,
+        mintAuthority: feePayer,
+        name: ext.name,
+        symbol: ext.symbol,
+        uri: ext.uri,
+        updateAuthority: authority,
+      })] : []
     );
 
     return [
@@ -159,9 +151,7 @@ export class Token {
     authority: Address;
     mint: TransactionSigner<string>;
     feePayer: TransactionSigner<string>;
-  }): Promise<
-    FullTransaction<TransactionVersion, TransactionMessageWithFeePayer>
-  > {
+  }): Promise<FullTransaction<TransactionVersion, TransactionMessageWithFeePayer>> {
     const instructions = await this.buildInstructions({
       rpc,
       decimals,
@@ -211,9 +201,7 @@ export const getCreateMintInstructions = async (input: {
 
   // Get minimum rent-exempt balance
   const rent = await input.rpc
-    .getMinimumBalanceForRentExemption(
-      BigInt(spaceWithoutPostInitializeExtensions)
-    )
+    .getMinimumBalanceForRentExemption(BigInt(space))
     .send();
 
   // Return create account and initialize mint instructions
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -1,8 +1,7 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
+    "outDir": "./dist"
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules", "dist"],
diff --git a/packages/sdk/jest.config.js b/packages/sdk/jest.config.js
@@ -0,0 +1,29 @@
+/** @type {import('jest').Config} */
+export default {
+  preset: 'ts-jest/presets/default-esm',
+  extensionsToTreatAsEsm: ['.ts'],
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  testMatch: ['**/__tests__/**/*.test.ts', '**/?(*.)+(spec|test).ts'],
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/**/__tests__/**/*.test.ts',
+    '!src/**/*.test.ts',
+    '!src/**/__tests__/setup.ts',
+    '!src/**/__tests__/test-utils.ts',
+  ],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+  },
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  setupFilesAfterEnv: ['<rootDir>/src/__tests__/setup.ts'],
+};
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -0,0 +1,50 @@
+{
+  "name": "@mosaic/sdk",
+  "version": "0.1.0",
+  "description": "SDK for Mosaic with helper functions for issuance and management of any token",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "echo 'Build will be implemented'",
+    "dev": "echo 'Dev will be implemented'",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@mosaic/core": "workspace:*",
+    "gill": "^0.10.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.34.0",
+    "@typescript-eslint/parser": "^8.34.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "keywords": [
+    "solana",
+    "token-2022",
+    "extensions",
+    "core",
+    "hooks"
+  ]
+}
diff --git a/packages/sdk/src/administration/.gitkeep b/packages/sdk/src/administration/.gitkeep
diff --git a/packages/sdk/src/factories/.gitkeep b/packages/sdk/src/factories/.gitkeep
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -0,0 +1 @@
+export * from './issuanceTemplates';
diff --git a/packages/sdk/src/issuanceTemplates/.gitkeep b/packages/sdk/src/issuanceTemplates/.gitkeep
diff --git a/packages/sdk/src/issuanceTemplates/index.ts b/packages/sdk/src/issuanceTemplates/index.ts
@@ -0,0 +1 @@
+export * from './stablecoin';
diff --git a/packages/sdk/src/issuanceTemplates/stablecoin.ts b/packages/sdk/src/issuanceTemplates/stablecoin.ts
@@ -0,0 +1,65 @@
+import { Token } from '@mosaic/core';
+import {
+  Rpc,
+  Address,
+  SolanaRpcApi,
+  FullTransaction,
+  TransactionMessageWithFeePayer,
+  TransactionVersion,
+  createNoopSigner,
+} from 'gill';
+
+/**
+ * Creates a transaction to initialize a new stablecoin mint on Solana with common stablecoin features.
+ *
+ * This function configures the mint with metadata, pausable functionality, default account state,
+ * confidential balances, and a permanent delegate. It returns a transaction ready to be signed and sent to the network.
+ *
+ * @param rpc - The Solana RPC client instance.
+ * @param name - The name of the stablecoin.
+ * @param symbol - The symbol of the stablecoin.
+ * @param decimals - The number of decimals for the stablecoin.
+ * @param uri - The URI pointing to the stablecoin's metadata.
+ * @param authority - The address with authority over the mint.
+ * @param mint - The address of the mint account to initialize.
+ * @param feePayer - The address that will pay the transaction fees.
+ * @returns A promise that resolves to a FullTransaction object for initializing the stablecoin mint.
+ */
+export const createStablecoinInitTransaction = async (
+  rpc: Rpc<SolanaRpcApi>,
+  name: string,
+  symbol: string,
+  decimals: number,
+  uri: string,
+  authority: Address,
+  mint: Address,
+  feePayer: Address
+): Promise<
+  FullTransaction<TransactionVersion, TransactionMessageWithFeePayer>
+> => {
+  const tx = await new Token()
+    .withMetadata({
+      mintAddress: mint,
+      authority: authority,
+      metadata: {
+        name,
+        symbol,
+        uri,
+      },
+      // TODO: add additional metadata
+      additionalMetadata: new Map(),
+    })
+    .withPausable(authority)
+    .withDefaultAccountState(true)
+    .withConfidentialBalances(authority)
+    .withPermanentDelegate(authority)
+    .buildTransaction({
+      rpc,
+      decimals,
+      authority,
+      mint: createNoopSigner(mint),
+      feePayer: createNoopSigner(feePayer),
+    });
+
+  return tx;
+};
diff --git a/packages/sdk/tsconfig.json b/packages/sdk/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"],
+  "types": ["jest", "node"]
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
