diff --git a/package.json b/package.json index b4c65ae..e3c2ee7 100644 --- a/package.json +++ b/package.json @@ -1,21 +1,37 @@ { - "name": "solana-course-client", + "name": "solana-versioned-transaction", "version": "1.0.0", - "description": "Starter template for a Solana client script", - "main": "index.ts", + "description": "Solana versioned transaction example", + "main": "index.js", "scripts": { - "start": "ts-node src/index.ts" + "start": "ts-mocha --timeout 40000 test/**.ts", + "test": "ts-mocha --timeout 40000 test/**.ts" }, "keywords": [], "author": "test", "license": "ISC", "devDependencies": { - "ts-node": "^10.8.0", - "typescript": "^4.6.4" + "@types/bn.js": "^5.1.0", + "@types/mocha": "^10.0.6", + "@types/node": "^22.5.4", + "@typescript-eslint/eslint-plugin": "^6.20.0", + "assert": "^2.1.0", + "eslint-config-prettier": "^9.1.0", + "eslint-plugin-prettier": "^5.1.3", + "eslint-plugin-typescript": "^0.14.0", + "prettier": "^3.2.4", + "ts-mocha": "^10.0.0", + "ts-node": "^10.9.2", + "typescript": "^4.9.5" }, "dependencies": { - "@solana/spl-token": "^0.3.6", - "@solana/web3.js": "^1.73.0", - "dotenv": "^16.0.1" + "@solana-developers/helpers": "^2.1.0", + "@solana/spl-token": "^0.4.0", + "@solana/spl-token-metadata": "^0.1.2", + "@solana/web3.js": "^1.89.1", + "@typescript-eslint/parser": "^6.20.0", + "bs58": "^5.0.0", + "dotenv": "^16.0.0", + "eslint": "^8.56.0" } } diff --git a/src/index.ts b/src/index.ts index e5fc466..0ae1050 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,61 +1,43 @@ -import { initializeKeypair } from "./initializeKeypair" -import * as web3 from "@solana/web3.js" +import * as web3 from "@solana/web3.js"; +import { makeKeypairs, getExplorerLink } from "@solana-developers/helpers"; +import { initializeKeypair } from "./initializeKeypair"; +import dotenv from "dotenv"; +dotenv.config(); async function main() { - // Connect to the devnet cluster - const connection = new web3.Connection(web3.clusterApiUrl("devnet")) + // Connect to the local Solana cluster + const connection = new web3.Connection(web3.clusterApiUrl("devnet"), "confirmed"); - // Initialize the user's keypair - const user = await initializeKeypair(connection) - console.log("PublicKey:", user.publicKey.toBase58()) + // Initialize the keypair from the environment variable or create a new one + const payer = await initializeKeypair(connection); - // Generate 22 addresses - const recipients = [] - for (let i = 0; i < 22; i++) { - recipients.push(web3.Keypair.generate().publicKey) - } + // Generate 22 recipient keypairs using makeKeypairs + const recipients = makeKeypairs(22).map(keypair => keypair.publicKey); - // Create an array of transfer instructions - const transferInstructions = [] + // Create a legacy transaction + const transaction = new web3.Transaction(); - // Add a transfer instruction for each address - for (const address of recipients) { - transferInstructions.push( + // Add 22 transfer instructions to the transaction + recipients.forEach((recipient) => { + transaction.add( web3.SystemProgram.transfer({ - fromPubkey: user.publicKey, // The payer (i.e., the account that will pay for the transaction fees) - toPubkey: address, // The destination account for the transfer - lamports: web3.LAMPORTS_PER_SOL * 0.01, // The amount of lamports to transfer + fromPubkey: payer.publicKey, + toPubkey: recipient, + lamports: web3.LAMPORTS_PER_SOL * 0.01, // Transfer 0.01 SOL to each recipient }) - ) + ); + }); + + // Sign and send the transaction + try { + const signature = await web3.sendAndConfirmTransaction(connection, transaction, [payer]); + console.log(`Transaction successful with signature: ${getExplorerLink('tx', signature, 'devnet')}`); + } catch (error) { + console.error("Transaction failed:", error); } - - // Create a transaction and add the transfer instructions - const transaction = new web3.Transaction().add(...transferInstructions) - - // Send the transaction to the cluster (this will fail in this example if addresses > 21) - const txid = await connection.sendTransaction(transaction, [user]) - - // Get the latest blockhash and last valid block height - const { lastValidBlockHeight, blockhash } = - await connection.getLatestBlockhash() - - // Confirm the transaction - await connection.confirmTransaction({ - blockhash: blockhash, - lastValidBlockHeight: lastValidBlockHeight, - signature: txid, - }) - - // Log the transaction URL on the Solana Explorer - console.log(`https://explorer.solana.com/tx/${txid}?cluster=devnet`) } -main() - .then(() => { - console.log("Finished successfully") - process.exit(0) - }) - .catch((error) => { - console.log(error) - process.exit(1) - }) +main().catch((err) => { + console.error(err); + process.exit(1); +}); diff --git a/src/initializeKeypair.ts b/src/initializeKeypair.ts index f470e19..0a7a544 100644 --- a/src/initializeKeypair.ts +++ b/src/initializeKeypair.ts @@ -1,42 +1,45 @@ -import * as web3 from "@solana/web3.js" -import * as fs from "fs" -import dotenv from "dotenv" -dotenv.config() +import * as web3 from "@solana/web3.js"; +import * as fs from "fs/promises"; +import dotenv from "dotenv"; +dotenv.config(); export async function initializeKeypair( connection: web3.Connection ): Promise { if (!process.env.PRIVATE_KEY) { - console.log("Creating .env file") - const signer = web3.Keypair.generate() - fs.writeFileSync(".env", `PRIVATE_KEY=[${signer.secretKey.toString()}]`) - await airdropSolIfNeeded(signer, connection) + console.log("Creating .env file"); + const signer = web3.Keypair.generate(); + await fs.writeFile(".env", `PRIVATE_KEY=[${signer.secretKey.toString()}]`); + await airdropSolIfNeeded(signer, connection); - return signer + return signer; } - const secret = JSON.parse(process.env.PRIVATE_KEY ?? "") as number[] - const secretKey = Uint8Array.from(secret) - const keypairFromSecretKey = web3.Keypair.fromSecretKey(secretKey) - await airdropSolIfNeeded(keypairFromSecretKey, connection) - return keypairFromSecretKey + let secret: number[]; + try { + secret = JSON.parse(process.env.PRIVATE_KEY) as number[]; + } catch (error) { + throw new Error("Failed to parse PRIVATE_KEY from .env file"); + } + + const secretKey = Uint8Array.from(secret); + const keypairFromSecretKey = web3.Keypair.fromSecretKey(secretKey); + await airdropSolIfNeeded(keypairFromSecretKey, connection); + return keypairFromSecretKey; } -async function airdropSolIfNeeded( +export async function airdropSolIfNeeded( signer: web3.Keypair, connection: web3.Connection -) { - const balance = await connection.getBalance(signer.publicKey) - console.log("Current balance is", balance / web3.LAMPORTS_PER_SOL) +): Promise { + const balance = await connection.getBalance(signer.publicKey); + console.log("Current balance is", balance / web3.LAMPORTS_PER_SOL); if (balance < web3.LAMPORTS_PER_SOL) { - console.log("Airdropping 1 SOL...") - const airdropSignature = await connection.requestAirdrop( - signer.publicKey, - web3.LAMPORTS_PER_SOL - ) + console.log("Airdropping 1 SOL..."); + const airdropSignature = await connection.requestAirdrop(signer.publicKey, web3.LAMPORTS_PER_SOL); - const latestBlockHash = await connection.getLatestBlockhash() + const latestBlockHash = await connection.getLatestBlockhash(); await connection.confirmTransaction( { @@ -45,9 +48,9 @@ async function airdropSolIfNeeded( signature: airdropSignature, }, "finalized" - ) + ); - const newBalance = await connection.getBalance(signer.publicKey) - console.log("New balance is", newBalance / web3.LAMPORTS_PER_SOL) + const newBalance = await connection.getBalance(signer.publicKey); + console.log("New balance is", newBalance / web3.LAMPORTS_PER_SOL); } } diff --git a/tsconfig.json b/tsconfig.json index 5679481..6d359ab 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,101 +1,15 @@ { "compilerOptions": { - /* Visit https://aka.ms/tsconfig.json to read more about this file */ - - /* Projects */ - // "incremental": true, /* Enable incremental compilation */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ - // "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 TC39 stage 2 draft 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. */ - - /* Modules */ - "module": "commonjs", /* Specify what module code is generated. */ - // "rootDir": "./", /* Specify the root folder within your source files. */ - // "moduleResolution": "node", /* 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. */ - // "resolveJsonModule": true, /* Enable importing .json files */ - // "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. */ - // "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. */ - // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ - // "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. */ - // "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, /* Type catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when a 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, /* Include 'undefined' in index signature results */ - // "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. */ - } + "types": ["mocha", "chai"], + "lib": ["es2015"], + "typeRoots": ["./node_modules/@types"], + "target": "es6", + "module": "commonjs", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "outDir": "dist" + }, + "include": ["./src/**/*", "./test/**/*"] }