@solana/program-client-core 0.0.0 → 6.1.0

package/dist/types/self-plan-and-send-functions.d.ts

@@ -0,0 +1,85 @@
+import type { InstructionPlan } from '@solana/instruction-plans';
+import type { Instruction } from '@solana/instructions';
+import type { ClientWithTransactionPlanning, ClientWithTransactionSending } from '@solana/plugin-interfaces';
+type PlanTransaction = ClientWithTransactionPlanning['planTransaction'];
+type PlanTransactions = ClientWithTransactionPlanning['planTransactions'];
+type SendTransaction = ClientWithTransactionSending['sendTransaction'];
+type SendTransactions = ClientWithTransactionSending['sendTransactions'];
+/**
+ * Methods that allow an instruction or instruction plan to plan and send itself.
+ *
+ * These methods are added to instruction or instruction plan objects via
+ * {@link addSelfPlanAndSendFunctions}, enabling a fluent API where you can call
+ * `.sendTransaction()` directly on an instruction without passing it to a separate function.
+ *
+ * @example
+ * Sending a transfer instruction directly.
+ * ```ts
+ * const result = await getTransferInstruction({ source, destination, amount }).sendTransaction();
+ * ```
+ *
+ * @example
+ * Planning multiple transactions from an instruction plan.
+ * ```ts
+ * const plan = await getComplexInstructionPlan(/* ... *\/).planTransactions();
+ * ```
+ *
+ * @see {@link addSelfPlanAndSendFunctions}
+ */
+export type SelfPlanAndSendFunctions = {
+    /** Plans a single transaction. */
+    planTransaction: (config?: Parameters<PlanTransaction>[1]) => ReturnType<PlanTransaction>;
+    /** Plans one or more transactions. */
+    planTransactions: (config?: Parameters<PlanTransactions>[1]) => ReturnType<PlanTransactions>;
+    /** Sends a single transaction. */
+    sendTransaction: (config?: Parameters<SendTransaction>[1]) => ReturnType<SendTransaction>;
+    /** Sends one or more transactions. */
+    sendTransactions: (config?: Parameters<SendTransactions>[1]) => ReturnType<SendTransactions>;
+};
+/**
+ * Adds self-planning and self-sending methods to an instruction or instruction plan.
+ *
+ * This function augments the provided instruction or instruction plan with methods
+ * that allow it to plan and send itself using the provided client. It enables a fluent API
+ * where you can call methods like `.sendTransaction()` directly on the instruction.
+ *
+ * The function supports both synchronous inputs (instructions, instruction plans) and
+ * promise-like inputs, making it suitable for use with async instruction builders.
+ *
+ * @typeParam TItem - The type of the instruction, instruction plan, or a promise resolving to one.
+ *
+ * @param client - A client that provides transaction planning and sending capabilities.
+ * @param input - The instruction, instruction plan, or promise to augment with self-plan/send methods.
+ * @returns The input augmented with {@link SelfPlanAndSendFunctions} methods.
+ *
+ * @example
+ * Adding self-plan and send to a transfer instruction.
+ * ```ts
+ * import { addSelfPlanAndSendFunctions } from '@solana/program-client-core';
+ *
+ * const transferInstruction = addSelfPlanAndSendFunctions(
+ *     client,
+ *     getTransferInstruction({ payer, source, destination, amount })
+ * );
+ *
+ * // Now you can send directly from the instruction.
+ * const result = await transferInstruction.sendTransaction();
+ * ```
+ *
+ * @example
+ * Using with an async instruction builder.
+ * ```ts
+ * const asyncInstruction = addSelfPlanAndSendFunctions(
+ *     client,
+ *     fetchAndBuildInstruction(/* ... *\/)
+ * );
+ *
+ * // The promise is augmented with self-plan/send methods.
+ * const result = await asyncInstruction.sendTransaction();
+ * ```
+ *
+ * @see {@link SelfPlanAndSendFunctions}
+ */
+export declare function addSelfPlanAndSendFunctions<TItem extends Instruction | InstructionPlan | PromiseLike<Instruction> | PromiseLike<InstructionPlan>>(client: ClientWithTransactionPlanning & ClientWithTransactionSending, input: TItem): SelfPlanAndSendFunctions & TItem;
+export {};
+//# sourceMappingURL=self-plan-and-send-functions.d.ts.map

package/dist/types/self-plan-and-send-functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-plan-and-send-functions.d.ts","sourceRoot":"","sources":["../../src/self-plan-and-send-functions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AAE7G,KAAK,eAAe,GAAG,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;AACxE,KAAK,gBAAgB,GAAG,6BAA6B,CAAC,kBAAkB,CAAC,CAAC;AAC1E,KAAK,eAAe,GAAG,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;AACvE,KAAK,gBAAgB,GAAG,4BAA4B,CAAC,kBAAkB,CAAC,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACnC,kCAAkC;IAClC,eAAe,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,eAAe,CAAC,CAAC;IAC1F,sCAAsC;IACtC,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAC7F,kCAAkC;IAClC,eAAe,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,eAAe,CAAC,CAAC;IAC1F,sCAAsC;IACtC,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,gBAAgB,CAAC,CAAC;CAChG,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,2BAA2B,CACvC,KAAK,SAAS,WAAW,GAAG,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,eAAe,CAAC,EAErG,MAAM,EAAE,6BAA6B,GAAG,4BAA4B,EACpE,KAAK,EAAE,KAAK,GACb,wBAAwB,GAAG,KAAK,CAiBlC"}

package/package.json

@@ -1,12 +1,96 @@
 {
   "name": "@solana/program-client-core",
-  "version": "0.0.0",
-  "description": "",
-  "license": "ISC",
-  "author": "",
+  "version": "6.1.0",
+  "description": "Core utilities for building Solana program clients",
+  "homepage": "https://www.solanakit.com/api#solanaprogram-client-core",
+  "exports": {
+    "edge-light": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "workerd": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "browser": {
+      "import": "./dist/index.browser.mjs",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "react-native": "./dist/index.native.mjs",
+    "types": "./dist/types/index.d.ts"
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.mjs": "./dist/index.browser.mjs"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.mjs",
+  "react-native": "./dist/index.native.mjs",
+  "types": "./dist/types/index.d.ts",
   "type": "commonjs",
-  "main": "index.js",
+  "files": [
+    "./dist/"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "blockchain",
+    "solana",
+    "web3"
+  ],
+  "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anza-xyz/kit"
+  },
+  "bugs": {
+    "url": "https://github.com/anza-xyz/kit/issues"
+  },
+  "browserslist": [
+    "supports bigint and not dead",
+    "maintained node versions"
+  ],
+  "dependencies": {
+    "@solana/accounts": "6.1.0",
+    "@solana/addresses": "6.1.0",
+    "@solana/errors": "6.1.0",
+    "@solana/codecs-core": "6.1.0",
+    "@solana/instruction-plans": "6.1.0",
+    "@solana/plugin-interfaces": "6.1.0",
+    "@solana/instructions": "6.1.0",
+    "@solana/rpc-api": "6.1.0",
+    "@solana/signers": "6.1.0"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20.18.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "compile:docs": "typedoc",
+    "compile:js": "tsup --config build-scripts/tsup.config.package.ts",
+    "compile:typedefs": "tsc -p ./tsconfig.declarations.json",
+    "dev": "NODE_OPTIONS=\"--no-experimental-webstorage\" jest -c ../../node_modules/@solana/test-config/jest-dev.config.js --rootDir . --watch",
+    "publish-impl": "npm view $npm_package_name@$npm_package_version > /dev/null 2>&1 || (pnpm publish --tag ${PUBLISH_TAG:-canary} --access public --no-git-checks && (([ -n \"${GITHUB_OUTPUT:-}\" ] && echo 'published=true' >> \"$GITHUB_OUTPUT\") || true) && (([ \"$PUBLISH_TAG\" != \"canary\" ] && ../build-scripts/maybe-tag-latest.ts --token \"$GITHUB_TOKEN\" $npm_package_name@$npm_package_version) || true))",
+    "publish-packages": "pnpm prepublishOnly && pnpm publish-impl",
+    "style:fix": "pnpm eslint --fix src && pnpm prettier --log-level warn --ignore-unknown --write ./*",
+    "test:lint": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-lint.config.js --rootDir . --silent",
+    "test:prettier": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-prettier.config.js --rootDir . --silent",
+    "test:treeshakability:browser": "agadoo dist/index.browser.mjs",
+    "test:treeshakability:native": "agadoo dist/index.native.mjs",
+    "test:treeshakability:node": "agadoo dist/index.node.mjs",
+    "test:typecheck": "tsc --noEmit",
+    "test:unit:browser": "NODE_OPTIONS=\"--no-experimental-webstorage\" TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-unit.config.browser.js --rootDir . --silent",
+    "test:unit:node": "NODE_OPTIONS=\"--no-experimental-webstorage\" TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-unit.config.node.js --rootDir . --silent"
   }
-}
+}