@solana/transaction-messages 2.1.1-canary-20250425210025 → 2.1.1-canary-20250428190618

package/dist/types/fee-payer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fee-payer.d.ts","sourceRoot":"","sources":["../../src/fee-payer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,+BAA+B,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM;IAC7E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAC,CAAC;CAC/D;AAED,wBAAgB,6BAA6B,CACzC,gBAAgB,SAAS,MAAM,EAC/B,mBAAmB,SAAS,sBAAsB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAE7F,QAAQ,EAAE,OAAO,CAAC,gBAAgB,CAAC,EACnC,kBAAkB,EAAE,mBAAmB,GACxC,+BAA+B,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAe3F"}
+{"version":3,"file":"fee-payer.d.ts","sourceRoot":"","sources":["../../src/fee-payer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,+BAA+B,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM;IAC7E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAC,CAAC;CAC/D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,6BAA6B,CACzC,gBAAgB,SAAS,MAAM,EAC/B,mBAAmB,SAAS,sBAAsB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAE7F,QAAQ,EAAE,OAAO,CAAC,gBAAgB,CAAC,EACnC,kBAAkB,EAAE,mBAAmB,GACxC,+BAA+B,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAe3F"}

package/dist/types/index.d.ts

@@ -1,3 +1,32 @@
+/**
+ * This package contains types and functions for creating transaction messages.
+ * It can be used standalone, but it is also exported as part of Kit
+ * [`@solana/kit`](https://github.com/anza-xyz/kit/tree/main/packages/kit).
+ *
+ * @example
+ * Transaction messages are built one step at a time using the transform functions offered by this
+ * package. To make it more ergonomic to apply consecutive transforms to your transaction messages,
+ * consider using a pipelining helper like the one in `@solana/functional`.
+ *
+ * ```ts
+ * import { pipe } from '@solana/functional';
+ * import {
+ *     appendTransactionMessageInstruction,
+ *     createTransactionMessage,
+ *     setTransactionMessageFeePayer,
+ *     setTransactionMessageLifetimeUsingBlockhash,
+ * } from '@solana/transaction-messages';
+ *
+ * const transferTransactionMessage = pipe(
+ *     createTransactionMessage({ version: 0 }),
+ *     m => setTransactionMessageFeePayer(myAddress, m),
+ *     m => setTransactionMessageLifetimeUsingBlockhash(latestBlockhash, m),
+ *     m => appendTransactionMessageInstruction(getTransferSolInstruction({ source, destination, amount }), m),
+ * );
+ * ```
+ *
+ * @packageDocumentation
+ */
 export * from './addresses-by-lookup-table-address';
 export * from './blockhash';
 export * from './codecs';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AACpD,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,kCAAkC,CAAC;AACjD,cAAc,WAAW,CAAC;AAC1B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,cAAc,qCAAqC,CAAC;AACpD,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,kCAAkC,CAAC;AACjD,cAAc,WAAW,CAAC;AAC1B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC"}

package/dist/types/instructions.d.ts

@@ -1,9 +1,105 @@
 import { TransactionMessageWithDurableNonceLifetime } from './durable-nonce';
 import { BaseTransactionMessage } from './transaction-message';
+/**
+ * Given an instruction, this method will return a new transaction message with that instruction
+ * having been added to the end of the list of existing instructions.
+ *
+ * @see {@link appendTransactionInstructions} if you need to append multiple instructions to a
+ * transaction message.
+ *
+ * @example
+ * ```ts
+ * import { address } from '@solana/addresses';
+ * import { appendTransactionMessageInstruction } from '@solana/transaction-messages';
+ *
+ * const memoTransaction = appendTransactionMessageInstruction(
+ *     {
+ *         data: new TextEncoder().encode('Hello world!'),
+ *         programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
+ *     },
+ *     tx,
+ * );
+ * ```
+ */
 export declare function appendTransactionMessageInstruction<TTransactionMessage extends BaseTransactionMessage>(instruction: TTransactionMessage['instructions'][number], transactionMessage: TTransactionMessage): TTransactionMessage;
+/**
+ * Given an array of instructions, this method will return a new transaction message with those
+ * instructions having been added to the end of the list of existing instructions.
+ *
+ * @see {@link appendTransactionInstruction} if you only need to append one instruction to a
+ * transaction message.
+ *
+ * @example
+ * ```ts
+ * import { address } from '@solana/addresses';
+ * import { appendTransactionMessageInstructions } from '@solana/transaction-messages';
+ *
+ * const memoTransaction = appendTransactionMessageInstructions(
+ *     [
+ *         {
+ *             data: new TextEncoder().encode('Hello world!'),
+ *             programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
+ *         },
+ *         {
+ *             data: new TextEncoder().encode('How are you?'),
+ *             programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
+ *         },
+ *     ],
+ *     tx,
+ * );
+ * ```
+ */
 export declare function appendTransactionMessageInstructions<TTransactionMessage extends BaseTransactionMessage>(instructions: ReadonlyArray<TTransactionMessage['instructions'][number]>, transactionMessage: TTransactionMessage): TTransactionMessage;
 type ExcludeDurableNonce<T> = T extends TransactionMessageWithDurableNonceLifetime ? BaseTransactionMessage & Omit<T, keyof TransactionMessageWithDurableNonceLifetime> : T;
+/**
+ * Given an instruction, this method will return a new transaction message with that instruction
+ * having been added to the beginning of the list of existing instructions.
+ *
+ * @see {@link prependTransactionInstructions} if you need to prepend multiple instructions to a
+ * transaction message.
+ *
+ * @example
+ * ```ts
+ * import { address } from '@solana/addresses';
+ * import { prependTransactionMessageInstruction } from '@solana/transaction-messages';
+ *
+ * const memoTransaction = prependTransactionMessageInstruction(
+ *     {
+ *         data: new TextEncoder().encode('Hello world!'),
+ *         programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
+ *     },
+ *     tx,
+ * );
+ * ```
+ */
 export declare function prependTransactionMessageInstruction<TTransactionMessage extends BaseTransactionMessage>(instruction: TTransactionMessage['instructions'][number], transactionMessage: TTransactionMessage): ExcludeDurableNonce<TTransactionMessage>;
+/**
+ * Given an array of instructions, this method will return a new transaction message with those
+ * instructions having been added to the beginning of the list of existing instructions.
+ *
+ * @see {@link prependTransactionInstruction} if you only need to prepend one instruction to a
+ * transaction message.
+ *
+ * @example
+ * ```ts
+ * import { address } from '@solana/addresses';
+ * import { prependTransactionMessageInstructions } from '@solana/transaction-messages';
+ *
+ * const memoTransaction = prependTransactionMessageInstructions(
+ *     [
+ *         {
+ *             data: new TextEncoder().encode('Hello world!'),
+ *             programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
+ *         },
+ *         {
+ *             data: new TextEncoder().encode('How are you?'),
+ *             programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
+ *         },
+ *     ],
+ *     tx,
+ * );
+ * ```
+ */
 export declare function prependTransactionMessageInstructions<TTransactionMessage extends BaseTransactionMessage>(instructions: ReadonlyArray<TTransactionMessage['instructions'][number]>, transactionMessage: TTransactionMessage): ExcludeDurableNonce<TTransactionMessage>;
 export {};
 //# sourceMappingURL=instructions.d.ts.map

package/dist/types/instructions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"instructions.d.ts","sourceRoot":"","sources":["../../src/instructions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0CAA0C,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,wBAAgB,mCAAmC,CAAC,mBAAmB,SAAS,sBAAsB,EAClG,WAAW,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAErB;AAED,wBAAgB,oCAAoC,CAAC,mBAAmB,SAAS,sBAAsB,EACnG,YAAY,EAAE,aAAa,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,EACxE,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAKrB;AAID,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,0CAA0C,GAC5E,sBAAsB,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,0CAA0C,CAAC,GAClF,CAAC,CAAC;AAER,wBAAgB,oCAAoC,CAAC,mBAAmB,SAAS,sBAAsB,EACnG,WAAW,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAAC,mBAAmB,CAAC,CAE1C;AAED,wBAAgB,qCAAqC,CAAC,mBAAmB,SAAS,sBAAsB,EACpG,YAAY,EAAE,aAAa,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,EACxE,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAAC,mBAAmB,CAAC,CAK1C"}
+{"version":3,"file":"instructions.d.ts","sourceRoot":"","sources":["../../src/instructions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0CAA0C,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,mCAAmC,CAAC,mBAAmB,SAAS,sBAAsB,EAClG,WAAW,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAErB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oCAAoC,CAAC,mBAAmB,SAAS,sBAAsB,EACnG,YAAY,EAAE,aAAa,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,EACxE,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAKrB;AAID,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,0CAA0C,GAC5E,sBAAsB,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,0CAA0C,CAAC,GAClF,CAAC,CAAC;AAER;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,oCAAoC,CAAC,mBAAmB,SAAS,sBAAsB,EACnG,WAAW,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAAC,mBAAmB,CAAC,CAE1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,qCAAqC,CAAC,mBAAmB,SAAS,sBAAsB,EACpG,YAAY,EAAE,aAAa,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,EACxE,kBAAkB,EAAE,mBAAmB,GACxC,mBAAmB,CAAC,mBAAmB,CAAC,CAK1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/transaction-messages",
-  "version": "2.1.1-canary-20250425210025",
+  "version": "2.1.1-canary-20250428190618",
   "description": "Helpers for creating transaction messages",
   "exports": {
     "edge-light": {
@@ -54,14 +54,14 @@
     "maintained node versions"
   ],
   "dependencies": {
-    "@solana/addresses": "2.1.1-canary-20250425210025",
-    "@solana/codecs-data-structures": "2.1.1-canary-20250425210025",
-    "@solana/codecs-numbers": "2.1.1-canary-20250425210025",
-    "@solana/errors": "2.1.1-canary-20250425210025",
-    "@solana/codecs-core": "2.1.1-canary-20250425210025",
-    "@solana/functional": "2.1.1-canary-20250425210025",
-    "@solana/instructions": "2.1.1-canary-20250425210025",
-    "@solana/rpc-types": "2.1.1-canary-20250425210025"
+    "@solana/errors": "2.1.1-canary-20250428190618",
+    "@solana/codecs-core": "2.1.1-canary-20250428190618",
+    "@solana/codecs-data-structures": "2.1.1-canary-20250428190618",
+    "@solana/addresses": "2.1.1-canary-20250428190618",
+    "@solana/codecs-numbers": "2.1.1-canary-20250428190618",
+    "@solana/functional": "2.1.1-canary-20250428190618",
+    "@solana/rpc-types": "2.1.1-canary-20250428190618",
+    "@solana/instructions": "2.1.1-canary-20250428190618"
   },
   "peerDependencies": {
     "typescript": ">=5.3.3"