@pump-fun/pump-sdk 1.0.0

package/README.md

@@ -0,0 +1,211 @@
+# Test Common Utilities
+
+A template package demonstrating GitHub Actions workflow for npm package deployment. Use this as a base for creating new private npm packages.
+
+## Features
+
+- Automated versioning and deployment
+- Branch-based deployment (main/devnet)
+- Semantic versioning support
+- GitHub Actions workflow template
+
+## Installation
+
+Since this is a private package, you'll need to be authenticated to install it:
+
+```bash
+# Install the main version
+npm install @pump-fun/test-common-util@main
+
+# Or install the devnet version
+npm install @pump-fun/test-common-util@devnet
+```
+
+## Usage
+
+```typescript
+import { helloWorld } from "@pump-fun/test-common-util";
+
+console.log(helloWorld()); // Output: Hello, World!
+console.log(helloWorld("Alice")); // Output: Hello, Alice!
+```
+
+## Development
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Build the package:
+
+```bash
+npm run build
+```
+
+## Deployment Process
+
+### Prerequisites
+
+- `NPM_TOKEN`: Required for publishing to npm (add to GitHub Secrets)
+
+### Branch Strategy
+
+- `devnet`: Development branch
+  - Auto-increments patch version on push
+  - Publishes with `devnet` tag
+- `main`: Production branch
+  - Promotes latest devnet version to `latest` tag
+  - No version increment
+
+### Commit Message Format
+
+```
+type(scope): description
+
+[optional body]
+
+[optional footer]
+```
+
+Types:
+
+- `feat`: New feature (minor version bump)
+- `fix`: Bug fix (patch version bump)
+- `BREAKING CHANGE` (in footer): Major version bump
+- Other types: No version bump
+
+Breaking Change Example:
+
+```
+feat(utils): add new helper function
+
+This adds a new utility function for string manipulation.
+
+BREAKING CHANGE: Removes deprecated API
+```
+
+Push changes using: https://github.com/pump-fun/github-rules-test
+
+## Using as Template
+
+1. Fork this repository
+
+```
+git clone https://github.com/pump-fun/test-common-util.git
+cd test-common-util
+git remote remove origin
+git remote add origin https://github.com/pump-fun/YOUR_REPO_NAME.git
+```
+
+2. Update package name and repo in `package.json`
+
+```
+  "name": "@pump-fun/YOUR_PACKAGE_NAME",
+  "version": "1.0.0",
+  "description": "Test common utilities package",
+  "keywords": [],
+  "homepage": "https://github.com/pump-fun/YOUR_REPO_NAME#readme",
+  "bugs": {
+    "url": "https://github.com/pump-fun/YOUR_REPO_NAME/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pump-fun/YOUR_REPO_NAME.git"
+  }
+```
+
+3. Add required secrets:
+   - ~~`NPM_TOKEN`: For npm publishing~~ (already done via org secrets)
+4. Test local build
+
+```
+npm i
+npm run build
+```
+
+5. Create `devnet` branch and push to your repository
+
+```
+git checkout -b devnet
+git add .
+git commit -m "chore: initial commit"
+git push origin devnet
+```
+
+6. Once `devnet` is deployed, merge to `main` via a PR
+
+```
+git checkout main
+git merge origin/devnet
+git push
+```
+
+The workflow will handle versioning and deployment automatically based on your commit messages and branch.
+
+Your package should now be deployed to our NPM org with v1.0.0.
+
+## Consuming Package In Another Repo
+
+### Local Testing
+
+1. In your NPM package, run `npm link`
+2. In the consuming repo `package.json`, add the dependency:
+
+```
+"dependencies": {
+    ...
+    "@pump-fun/YOUR_PACKAGE_NAME": "file:<path_to_your_local_package>",
+    ...
+},
+```
+
+3. In the consuming repo run `npm i`
+4. You should be able to import and test package
+
+### Deploying Your Repo Consuming the Private Package
+
+1. Authenticate with NPM token in your build step. Github eg.:
+
+```
+- name: NPM Auth
+  run: |
+    echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> ~/.npmrc
+```
+
+2. If built in AWS via docker, update docker build to consume NPM_TOKEN
+
+```
+- name: Build and push Docker image
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          ECR_REPOSITORY: ${{ env.ECR_REPOSITORY }}
+          IMAGE_TAG: ${{ github.sha }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }} <--------
+        run: |
+          docker build . --build-arg NPM_TOKEN=$NPM_TOKEN \ <--------
+            -t $ECR_REGISTRY/$ECR_REPOSITORY:latest \
+            -t $ECR_REGISTRY/$ECR_REPOSITORY:${{ env.IMAGE_TAG }}
+          docker push --all-tags $ECR_REGISTRY/$ECR_REPOSITORY
+```
+
+3. Update Dockerfile to authenticate with NPM as well
+   Top of file
+
+```
+WORKDIR /app
+
+# Accept NPM token as a build argument
+ARG NPM_TOKEN
+```
+
+Before npm i or npm ci
+
+```
+RUN echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc
+
+4. For Frontend Repos, just add NPM_TOKEN to env var in Vercel
+```
+
+Reach out to @aakash-baton with any questions.

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@pump-fun/pump-sdk",
+  "version": "1.0.0",
+  "description": "Pump Bonding Curve SDK",
+  "keywords": [],
+  "homepage": "https://github.com/pump-fun/pump-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/pump-fun/pump-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pump-fun/pump-sdk.git"
+  },
+  "license": "MIT",
+  "author": "pump-fun",
+  "main": "./dist/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/esm/index.js"
+    },
+    "./*": {
+      "types": "./dist/*/index.d.ts",
+      "require": "./dist/*/index.js",
+      "import": "./dist/*/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsup --clean --dts",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "test": "echo \"No tests specified\""
+  },
+  "dependencies": {
+    "undici-types": "^6.20.0"
+  },
+  "devDependencies": {
+    "@semantic-release/git": "^10.0.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "semantic-release": "^24.2.3",
+    "@types/node": "^20.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm"
+    ],
+    "branches": [
+      {
+        "name": "main"
+      },
+      {
+        "name": "devnet",
+        "prerelease": true
+      }
+    ]
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+/**
+ * A simple hello world function
+ * @param name - The name to greet
+ * @returns A greeting message
+ */
+export function helloWorld(name: string = "World"): string {
+  return `Hello World and ${name}!!`;
+}

package/src/sampleDir/index.ts

@@ -0,0 +1,2 @@
+export * from "./math";
+export * from "./types";

package/src/sampleDir/math.ts

@@ -0,0 +1,20 @@
+import { MathOperation } from "./types";
+
+export function calculate(
+  a: number,
+  b: number,
+  operation: MathOperation
+): number {
+  switch (operation) {
+    case "add":
+      return a + b;
+    case "subtract":
+      return a - b;
+    case "multiply":
+      return a * b;
+    case "divide":
+      return a / b;
+    default:
+      throw new Error(`Invalid operation: ${operation}`);
+  }
+}

package/src/sampleDir/types.ts

@@ -0,0 +1 @@
+export type MathOperation = "add" | "subtract" | "multiply" | "divide";