From c906d968df29d570c2922016d80fc1d539d91004 Mon Sep 17 00:00:00 2001 From: "amilz.sol" <85324096+amilz@users.noreply.github.com> Date: Wed, 8 Jan 2025 13:20:36 -0800 Subject: [PATCH] add pump-fun-api guide example code --- solana/web3.js-2.0/pump-fun-api/.env.example | 4 + solana/web3.js-2.0/pump-fun-api/index.ts | 243 ++++++++++++++++++ solana/web3.js-2.0/pump-fun-api/package.json | 21 ++ solana/web3.js-2.0/pump-fun-api/tsconfig.json | 109 ++++++++ 4 files changed, 377 insertions(+) create mode 100644 solana/web3.js-2.0/pump-fun-api/.env.example create mode 100644 solana/web3.js-2.0/pump-fun-api/index.ts create mode 100644 solana/web3.js-2.0/pump-fun-api/package.json create mode 100644 solana/web3.js-2.0/pump-fun-api/tsconfig.json diff --git a/solana/web3.js-2.0/pump-fun-api/.env.example b/solana/web3.js-2.0/pump-fun-api/.env.example new file mode 100644 index 0000000..42cc2eb --- /dev/null +++ b/solana/web3.js-2.0/pump-fun-api/.env.example @@ -0,0 +1,4 @@ +WALLET_SECRET_KEY=[1, 2, 3, 4, 5] +METIS_URL='https://jupiter-swap-api.quiknode.pro/REPLACE_ME' +HTTP_ENDPOINT='https://REPLACE_ME.solana-mainnet.quiknode.pro/012345/' +WSS_ENDPOINT='wss://REPLACE_ME.solana-mainnet.quiknode.pro/012345/' \ No newline at end of file diff --git a/solana/web3.js-2.0/pump-fun-api/index.ts b/solana/web3.js-2.0/pump-fun-api/index.ts new file mode 100644 index 0000000..b5bfd71 --- /dev/null +++ b/solana/web3.js-2.0/pump-fun-api/index.ts @@ -0,0 +1,243 @@ +import { + Rpc, + createRpc, + RpcTransport, + createJsonRpcApi, + address, + getBase64Encoder, + FullySignedTransaction, + TransactionMessageBytes, + getTransactionDecoder, + signTransaction, + createKeyPairFromBytes, + TransactionWithBlockhashLifetime, + getSignatureFromTransaction, + createSolanaRpcSubscriptions, + sendAndConfirmTransactionFactory, + createSolanaRpc, + SolanaRpcApi, + RpcSubscriptions, + SolanaRpcSubscriptionsApi, + getAddressDecoder, + getAddressFromPublicKey +} from "@solana/web3.js"; +import { + HttpRequestMethod, + PumpFunEndpoint, + PumpFunQuoteParams, + PumpFunQuoteResponse, + PumpFunRequest, + PumpFunSwapInstructionsResponse, + PumpFunSwapParams, + PumpFunSwapResponse, + SignAndSendTransactionParams +} from "./types"; +import dotenv from 'dotenv'; + +dotenv.config(); + +type MetisPumpFunApi = { + pumpfun_quote(params: PumpFunQuoteParams): Promise; + pumpfun_swap(params: PumpFunSwapParams): Promise; + pumpfun_swap_instructions(params: PumpFunSwapParams): Promise; +} + +const METHOD_TO_ENDPOINT: Record = { + pumpfun_quote: { + path: 'pump-fun/quote', + method: 'GET' + }, + pumpfun_swap: { + path: 'pump-fun/swap', + method: 'POST' + }, + pumpfun_swap_instructions: { + path: 'pump-fun/swap-instructions', + method: 'POST' + } +}; + +function createPumpFunUrl(metisEndpoint: string, method: string): URL { + const baseUrl = metisEndpoint.replace(/\/$/, ''); // Remove trailing slash if present + const endpointPath = METHOD_TO_ENDPOINT[method].path; + return new URL(`${baseUrl}/${endpointPath}`); +} + +function createPumpFunTransport(metisEndpoint: string): RpcTransport { + return async (...args: Parameters): Promise => { + const { method, params } = args[0].payload as { method: string; params: PumpFunRequest }; + const url = createPumpFunUrl(metisEndpoint, method); + const normalizedParams = Array.isArray(params) ? params[0] : params; + switch (METHOD_TO_ENDPOINT[method].method) { + case 'GET': + return handlePumpFunGET(url, normalizedParams); + case 'POST': + return handlePumpFunPOST(url, normalizedParams); + default: + throw new Error(`Unknown HTTP method for PumpFun method: ${method}`); + } + }; +} + +function createPumpFunApi(metisEndpoint: string): Rpc { + const api = createJsonRpcApi(); + const transport = createPumpFunTransport(metisEndpoint); + return createRpc({ api, transport }); +} + +async function handlePumpFunGET( + url: URL, + params: TParams +): Promise { + if (typeof params === 'object' && params !== null) { + Object.entries(params as Record).forEach(([key, value]) => { + url.searchParams.append(key, String(value)); + }); + } + + const response = await fetch(url.toString(), { + method: 'GET', + redirect: 'follow', + headers: { + 'Content-Type': 'application/json', + } + }); + + if (!response.ok) { + throw new Error(`Error making GET request to ${url}: ${response.statusText}`); + } + + return await response.json() as TResponse; +} + +async function handlePumpFunPOST( + url: URL, + params: TParams +): Promise { + try { + const response = await fetch(url.toString(), { + method: 'POST', + redirect: 'follow', + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify(params), + }); + + if (!response.ok) { + throw new Error(`Error making POST request to ${url}: ${response.statusText}`); + } + + return await response.json() as TResponse; + } catch (error) { + console.error('Error making POST request:', error); + throw error; + } +} + +async function signAndSendTransaction({ + transactionBase64, + signerSecretKey, + solanaRpc, + solanaRpcSubscriptions, + commitment = 'confirmed' +}: SignAndSendTransactionParams): Promise { + // Create signer keypair from secret + const signerKeypair = await createKeyPairFromBytes( + new Uint8Array(signerSecretKey) + ); + + // Decode the base64 transaction + const transactionBytes = getBase64Encoder().encode(transactionBase64) as TransactionMessageBytes; + const transactionDecoder = getTransactionDecoder(); + const decodedTransaction = transactionDecoder.decode(transactionBytes); + + // Sign the transaction + const signedTransaction = await signTransaction( + [signerKeypair], + decodedTransaction + ); + + // Get latest blockhash and prepare transaction with lifetime + const { value: { lastValidBlockHeight, blockhash } } = await solanaRpc.getLatestBlockhash().send(); + const signedTransactionWithLifetime: FullySignedTransaction & TransactionWithBlockhashLifetime = { + ...signedTransaction, + lifetimeConstraint: { + blockhash, + lastValidBlockHeight, + }, + }; + + // Get transaction signature + const transactionSignature = getSignatureFromTransaction(signedTransactionWithLifetime); + + // Create sendAndConfirm function + const sendAndConfirmTransaction = sendAndConfirmTransactionFactory({ + rpc: solanaRpc, + rpcSubscriptions: solanaRpcSubscriptions, + }); + + // Send and confirm transaction + await sendAndConfirmTransaction(signedTransactionWithLifetime, { + commitment, + }); + + return transactionSignature; +} + +function validateEnv() { + const envVars = ['WALLET_SECRET_KEY','METIS_URL','HTTP_ENDPOINT','WSS_ENDPOINT']; + envVars.forEach((envVar) => { + if (!process.env[envVar]) { + throw new Error(`${envVar} environment variable is required`); + } + }); +} + +async function main() { + validateEnv(); + const metisUrl = process.env.METIS_URL as string; + const rpcUrl = process.env.HTTP_ENDPOINT as string; + const rpcSubscriptionsUrl = process.env.WSS_ENDPOINT as string; + const signerSecretKey = JSON.parse(process.env.WALLET_SECRET_KEY as string) as number[]; + const signerKeypair = await createKeyPairFromBytes(new Uint8Array(signerSecretKey)); + const wallet = await getAddressFromPublicKey(signerKeypair.publicKey); + + const targetMint = address("8gXN67Nmw9FZQjunJZzRoi2Qf1ykZtN9Q3BqxhCypump"); + const pumpFunApi = createPumpFunApi(metisUrl); + const solanaRpc: Rpc = createSolanaRpc(rpcUrl); + const solanaRpcSubscriptions: RpcSubscriptions + = createSolanaRpcSubscriptions(rpcSubscriptionsUrl); + + try { + const pumpFunQuote = await pumpFunApi.pumpfun_quote({ + type: 'BUY', + mint: targetMint, + amount: 1_000_000, + }).send(); + console.log(`PumpFun Quote:\n ${JSON.stringify(pumpFunQuote.quote, null, 2)}`); + } catch (error) { + console.error('Error getting PumpFun quote:', error); + } + try { + const pumpFunQuote = await pumpFunApi.pumpfun_swap({ + wallet, + type: 'BUY', + mint: targetMint, + inAmount: 1_000_000, + // priorityFeeLevel: 'high', // optionally set priority fee level + }).send(); + + const sig = await signAndSendTransaction({ + transactionBase64: pumpFunQuote.tx, + signerSecretKey: JSON.parse(process.env.WALLET_SECRET_KEY as string) as number[], + solanaRpc, + solanaRpcSubscriptions, + }); + + console.log(`Transaction Signature: ${sig}`); + } catch (error) { + console.error('Error getting PumpFun quote:', error); + } + +} diff --git a/solana/web3.js-2.0/pump-fun-api/package.json b/solana/web3.js-2.0/pump-fun-api/package.json new file mode 100644 index 0000000..ae86778 --- /dev/null +++ b/solana/web3.js-2.0/pump-fun-api/package.json @@ -0,0 +1,21 @@ +{ + "name": "pump-fun-api", + "version": "1.0.0", + "main": "index.js", + "scripts": { + "start": "ts-node app.ts" + }, + "keywords": [], + "author": "", + "license": "ISC", + "description": "", + "dependencies": { + "@solana/web3.js": "^2.0.0", + "dotenv": "^16.4.7" + }, + "devDependencies": { + "@types/node": "^22.10.5", + "ts-node": "^10.9.2", + "typescript": "^5.7.2" + } +} diff --git a/solana/web3.js-2.0/pump-fun-api/tsconfig.json b/solana/web3.js-2.0/pump-fun-api/tsconfig.json new file mode 100644 index 0000000..e075f97 --- /dev/null +++ b/solana/web3.js-2.0/pump-fun-api/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}