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

package/dist/types/blockhash.d.ts

@@ -1,15 +1,97 @@
 import { type Blockhash } from '@solana/rpc-types';
 import { TransactionMessageWithDurableNonceLifetime } from './durable-nonce';
 import { BaseTransactionMessage } from './transaction-message';
+/**
+ * A constraint which, when applied to a transaction message, makes that transaction message
+ * eligible to land on the network. The transaction message will continue to be eligible to land
+ * until the network considers the `blockhash` to be expired.
+ *
+ * This can happen when the network proceeds past the `lastValidBlockHeight` for which the blockhash
+ * is considered valid, or when the network switches to a fork where that blockhash is not present.
+ */
 type BlockhashLifetimeConstraint = Readonly<{
+    /**
+     * A recent blockhash observed by the transaction proposer.
+     *
+     * The transaction message will be considered eligible to land until the network determines this
+     * blockhash to be too old, or has switched to a fork where it is not present.
+     */
     blockhash: Blockhash;
+    /**
+     * This is the block height beyond which the network will consider the blockhash to be too old
+     * to make a transaction message eligible to land.
+     */
     lastValidBlockHeight: bigint;
 }>;
+/**
+ * Represents a transaction message whose lifetime is defined by the age of the blockhash it
+ * includes.
+ *
+ * Such a transaction can only be landed on the network if the current block height of the network
+ * is less than or equal to the value of
+ * `TransactionMessageWithBlockhashLifetime['lifetimeConstraint']['lastValidBlockHeight']`.
+ */
 export interface TransactionMessageWithBlockhashLifetime {
     readonly lifetimeConstraint: BlockhashLifetimeConstraint;
 }
+/**
+ * A type guard that returns `true` if the transaction message conforms to the
+ * {@link TransactionMessageWithBlockhashLifetime} type, and refines its type for use in your
+ * program.
+ *
+ * @example
+ * ```ts
+ * import { isTransactionMessageWithBlockhashLifetime } from '@solana/transaction-messages';
+ *
+ * if (isTransactionMessageWithBlockhashLifetime(message)) {
+ *     // At this point, `message` has been refined to a `TransactionMessageWithBlockhashLifetime`.
+ *     const { blockhash } = message.lifetimeConstraint;
+ *     const { value: blockhashIsValid } = await rpc.isBlockhashValid(blockhash).send();
+ *     setBlockhashIsValid(blockhashIsValid);
+ * } else {
+ *     setError(
+ *         `${getSignatureFromTransaction(transaction)} does not have a blockhash-based lifetime`,
+ *     );
+ * }
+ * ```
+ */
 export declare function isTransactionMessageWithBlockhashLifetime(transactionMessage: BaseTransactionMessage | (BaseTransactionMessage & TransactionMessageWithBlockhashLifetime)): transactionMessage is BaseTransactionMessage & TransactionMessageWithBlockhashLifetime;
+/**
+ * From time to time you might acquire a transaction message, that you expect to have a
+ * blockhash-based lifetime, from an untrusted network API or user input. Use this function to
+ * assert that such a transaction message actually has a blockhash-based lifetime.
+ *
+ * @example
+ * ```ts
+ * import { assertIsTransactionMessageWithBlockhashLifetime } from '@solana/transaction-messages';
+ *
+ * try {
+ *     // If this type assertion function doesn't throw, then
+ *     // Typescript will upcast `message` to `TransactionMessageWithBlockhashLifetime`.
+ *     assertIsTransactionMessageWithBlockhashLifetime(message);
+ *     // At this point, `message` is a `TransactionMessageWithBlockhashLifetime` that can be used
+ *     // with the RPC.
+ *     const { blockhash } = message.lifetimeConstraint;
+ *     const { value: blockhashIsValid } = await rpc.isBlockhashValid(blockhash).send();
+ * } catch (e) {
+ *     // `message` turned out not to have a blockhash-based lifetime
+ * }
+ * ```
+ */
 export declare function assertIsTransactionMessageWithBlockhashLifetime(transactionMessage: BaseTransactionMessage | (BaseTransactionMessage & TransactionMessageWithBlockhashLifetime)): asserts transactionMessage is BaseTransactionMessage & TransactionMessageWithBlockhashLifetime;
+/**
+ * Given a blockhash and the last block height at which that blockhash is considered usable to land
+ * transactions, this method will return a new transaction message having the same type as the one
+ * supplied plus the `TransactionMessageWithBlockhashLifetime` type.
+ *
+ * @example
+ * ```ts
+ * import { setTransactionMessageLifetimeUsingBlockhash } from '@solana/transaction-messages';
+ *
+ * const { value: latestBlockhash } = await rpc.getLatestBlockhash().send();
+ * const txMessageWithBlockhashLifetime = setTransactionMessageLifetimeUsingBlockhash(latestBlockhash, txMessage);
+ * ```
+ */
 export declare function setTransactionMessageLifetimeUsingBlockhash<TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithDurableNonceLifetime>(blockhashLifetimeConstraint: BlockhashLifetimeConstraint, transactionMessage: TTransactionMessage): Omit<TTransactionMessage, 'lifetimeConstraint'> & TransactionMessageWithBlockhashLifetime;
 export declare function setTransactionMessageLifetimeUsingBlockhash<TTransactionMessage extends BaseTransactionMessage | (BaseTransactionMessage & TransactionMessageWithBlockhashLifetime)>(blockhashLifetimeConstraint: BlockhashLifetimeConstraint, transactionMessage: TTransactionMessage): TransactionMessageWithBlockhashLifetime & TTransactionMessage;
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"blockhash.d.ts","sourceRoot":"","sources":["../../src/blockhash.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEtE,OAAO,EAAE,0CAA0C,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,KAAK,2BAA2B,GAAG,QAAQ,CAAC;IACxC,SAAS,EAAE,SAAS,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,WAAW,uCAAuC;IACpD,QAAQ,CAAC,kBAAkB,EAAE,2BAA2B,CAAC;CAC5D;AAED,wBAAgB,yCAAyC,CACrD,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,uCAAuC,CAAC,GAChH,kBAAkB,IAAI,sBAAsB,GAAG,uCAAuC,CAYxF;AAED,wBAAgB,+CAA+C,CAC3D,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,uCAAuC,CAAC,GAChH,OAAO,CAAC,kBAAkB,IAAI,sBAAsB,GAAG,uCAAuC,CAIhG;AAED,wBAAgB,2CAA2C,CACvD,mBAAmB,SAAS,sBAAsB,GAAG,0CAA0C,EAE/F,2BAA2B,EAAE,2BAA2B,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,GAAG,uCAAuC,CAAC;AAE7F,wBAAgB,2CAA2C,CACvD,mBAAmB,SACb,sBAAsB,GACtB,CAAC,sBAAsB,GAAG,uCAAuC,CAAC,EAExE,2BAA2B,EAAE,2BAA2B,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,uCAAuC,GAAG,mBAAmB,CAAC"}
+{"version":3,"file":"blockhash.d.ts","sourceRoot":"","sources":["../../src/blockhash.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEtE,OAAO,EAAE,0CAA0C,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D;;;;;;;GAOG;AACH,KAAK,2BAA2B,GAAG,QAAQ,CAAC;IACxC;;;;;OAKG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;CAChC,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,uCAAuC;IACpD,QAAQ,CAAC,kBAAkB,EAAE,2BAA2B,CAAC;CAC5D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,yCAAyC,CACrD,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,uCAAuC,CAAC,GAChH,kBAAkB,IAAI,sBAAsB,GAAG,uCAAuC,CAYxF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,+CAA+C,CAC3D,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,uCAAuC,CAAC,GAChH,OAAO,CAAC,kBAAkB,IAAI,sBAAsB,GAAG,uCAAuC,CAIhG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,2CAA2C,CACvD,mBAAmB,SAAS,sBAAsB,GAAG,0CAA0C,EAE/F,2BAA2B,EAAE,2BAA2B,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,IAAI,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,GAAG,uCAAuC,CAAC;AAE7F,wBAAgB,2CAA2C,CACvD,mBAAmB,SACb,sBAAsB,GACtB,CAAC,sBAAsB,GAAG,uCAAuC,CAAC,EAExE,2BAA2B,EAAE,2BAA2B,EACxD,kBAAkB,EAAE,mBAAmB,GACxC,uCAAuC,GAAG,mBAAmB,CAAC"}

package/dist/types/codecs/message.d.ts

@@ -1,6 +1,26 @@
 import { VariableSizeCodec, VariableSizeDecoder, VariableSizeEncoder } from '@solana/codecs-core';
 import { CompiledTransactionMessage } from '../compile/message';
+/**
+ * Returns an encoder that you can use to encode a {@link CompiledTransactionMessage} to a byte
+ * array.
+ *
+ * The wire format of a Solana transaction consists of signatures followed by a compiled transaction
+ * message. The byte array produced by this encoder is the message part.
+ */
 export declare function getCompiledTransactionMessageEncoder(): VariableSizeEncoder<CompiledTransactionMessage>;
+/**
+ * Returns a decoder that you can use to decode a byte array representing a
+ * {@link CompiledTransactionMessage}.
+ *
+ * The wire format of a Solana transaction consists of signatures followed by a compiled transaction
+ * message. You can use this decoder to decode the message part.
+ */
 export declare function getCompiledTransactionMessageDecoder(): VariableSizeDecoder<CompiledTransactionMessage>;
+/**
+ * Returns a codec that you can use to encode from or decode to {@link CompiledTransactionMessage}
+ *
+ * @see {@link getCompiledTransactionMessageDecoder}
+ * @see {@link getCompiledTransactionMessageEncoder}
+ */
 export declare function getCompiledTransactionMessageCodec(): VariableSizeCodec<CompiledTransactionMessage>;
 //# sourceMappingURL=message.d.ts.map

package/dist/types/codecs/message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../src/codecs/message.ts"],"names":[],"mappings":"AACA,OAAO,EAQH,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAyDhE,wBAAgB,oCAAoC,IAAI,mBAAmB,CAAC,0BAA0B,CAAC,CAiBtG;AAED,wBAAgB,oCAAoC,IAAI,mBAAmB,CAAC,0BAA0B,CAAC,CAetG;AAED,wBAAgB,kCAAkC,IAAI,iBAAiB,CAAC,0BAA0B,CAAC,CAElG"}
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../src/codecs/message.ts"],"names":[],"mappings":"AACA,OAAO,EAQH,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAyDhE;;;;;;GAMG;AACH,wBAAgB,oCAAoC,IAAI,mBAAmB,CAAC,0BAA0B,CAAC,CAiBtG;AAED;;;;;;GAMG;AACH,wBAAgB,oCAAoC,IAAI,mBAAmB,CAAC,0BAA0B,CAAC,CAetG;AAED;;;;;GAKG;AACH,wBAAgB,kCAAkC,IAAI,iBAAiB,CAAC,0BAA0B,CAAC,CAElG"}

package/dist/types/codecs/transaction-version.d.ts

@@ -1,6 +1,25 @@
 import { VariableSizeCodec, VariableSizeDecoder, VariableSizeEncoder } from '@solana/codecs-core';
 import { TransactionVersion } from '../transaction-message';
+/**
+ * Returns an encoder that you can use to encode a {@link TransactionVersion} to a byte array.
+ *
+ * Legacy messages will produce an empty array and will not advance the offset. Versioned messages
+ * will produce an array with a single byte.
+ */
 export declare function getTransactionVersionEncoder(): VariableSizeEncoder<TransactionVersion>;
+/**
+ * Returns a decoder that you can use to decode a byte array representing a
+ * {@link TransactionVersion}.
+ *
+ * When the byte at the current offset is determined to represent a legacy transaction, this decoder
+ * will return `'legacy'` and will not advance the offset.
+ */
 export declare function getTransactionVersionDecoder(): VariableSizeDecoder<TransactionVersion>;
+/**
+ * Returns a codec that you can use to encode from or decode to {@link TransactionVersion}
+ *
+ * @see {@link getTransactionVersionDecoder}
+ * @see {@link getTransactionVersionEncoder}
+ */
 export declare function getTransactionVersionCodec(): VariableSizeCodec<TransactionVersion>;
 //# sourceMappingURL=transaction-version.d.ts.map

package/dist/types/codecs/transaction-version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-version.d.ts","sourceRoot":"","sources":["../../../src/codecs/transaction-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAI5D,wBAAgB,4BAA4B,IAAI,mBAAmB,CAAC,kBAAkB,CAAC,CAiBtF;AAED,wBAAgB,4BAA4B,IAAI,mBAAmB,CAAC,kBAAkB,CAAC,CActF;AAED,wBAAgB,0BAA0B,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAElF"}
+{"version":3,"file":"transaction-version.d.ts","sourceRoot":"","sources":["../../../src/codecs/transaction-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAI5D;;;;;GAKG;AACH,wBAAgB,4BAA4B,IAAI,mBAAmB,CAAC,kBAAkB,CAAC,CAiBtF;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,IAAI,mBAAmB,CAAC,kBAAkB,CAAC,CActF;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAElF"}

package/dist/types/compilable-transaction-message.d.ts

@@ -3,5 +3,10 @@ import { TransactionMessageWithBlockhashLifetime } from './blockhash';
 import { TransactionMessageWithDurableNonceLifetime } from './durable-nonce';
 import { ITransactionMessageWithFeePayer } from './fee-payer';
 import { BaseTransactionMessage, TransactionVersion } from './transaction-message';
+/**
+ * A transaction message having sufficient detail to be compiled for execution on the network.
+ *
+ * In essence, this means that it has at minimum a version, a fee payer, and a lifetime constraint.
+ */
 export type CompilableTransactionMessage<TVersion extends TransactionVersion = TransactionVersion, TInstruction extends IInstruction = IInstruction> = BaseTransactionMessage<TVersion, TInstruction> & ITransactionMessageWithFeePayer & (TransactionMessageWithBlockhashLifetime | TransactionMessageWithDurableNonceLifetime);
 //# sourceMappingURL=compilable-transaction-message.d.ts.map

package/dist/types/compilable-transaction-message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compilable-transaction-message.d.ts","sourceRoot":"","sources":["../../src/compilable-transaction-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,uCAAuC,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,EAAE,0CAA0C,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEnF,MAAM,MAAM,4BAA4B,CACpC,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,EACxD,YAAY,SAAS,YAAY,GAAG,YAAY,IAChD,sBAAsB,CAAC,QAAQ,EAAE,YAAY,CAAC,GAC9C,+BAA+B,GAC/B,CAAC,uCAAuC,GAAG,0CAA0C,CAAC,CAAC"}
+{"version":3,"file":"compilable-transaction-message.d.ts","sourceRoot":"","sources":["../../src/compilable-transaction-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,uCAAuC,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,EAAE,0CAA0C,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEnF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,CACpC,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,EACxD,YAAY,SAAS,YAAY,GAAG,YAAY,IAChD,sBAAsB,CAAC,QAAQ,EAAE,YAAY,CAAC,GAC9C,+BAA+B,GAC/B,CAAC,uCAAuC,GAAG,0CAA0C,CAAC,CAAC"}

package/dist/types/compile/address-table-lookups.d.ts

@@ -1,8 +1,11 @@
 import { Address } from '@solana/addresses';
 import { OrderedAccounts } from '../compile/accounts';
 type AddressTableLookup = Readonly<{
+    /** The address of the address lookup table account. */
     lookupTableAddress: Address;
+    /** Indices of accounts in a lookup table to load as read-only. */
     readableIndices: readonly number[];
+    /** Indices of accounts in a lookup table to load as writable. */
     writableIndices: readonly number[];
 }>;
 export declare function getCompiledAddressTableLookups(orderedAccounts: OrderedAccounts): AddressTableLookup[];

package/dist/types/compile/address-table-lookups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"address-table-lookups.d.ts","sourceRoot":"","sources":["../../../src/compile/address-table-lookups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,mBAAmB,CAAC;AAGlE,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,KAAK,kBAAkB,GAAG,QAAQ,CAAC;IAC/B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH,wBAAgB,8BAA8B,CAAC,eAAe,EAAE,eAAe,GAAG,kBAAkB,EAAE,CAsBrG"}
+{"version":3,"file":"address-table-lookups.d.ts","sourceRoot":"","sources":["../../../src/compile/address-table-lookups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,MAAM,mBAAmB,CAAC;AAGlE,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,KAAK,kBAAkB,GAAG,QAAQ,CAAC;IAC/B,uDAAuD;IACvD,kBAAkB,EAAE,OAAO,CAAC;IAC5B,kEAAkE;IAClE,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,iEAAiE;IACjE,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH,wBAAgB,8BAA8B,CAAC,eAAe,EAAE,eAAe,GAAG,kBAAkB,EAAE,CAsBrG"}

package/dist/types/compile/header.d.ts

@@ -1,7 +1,31 @@
 import { OrderedAccounts } from '../compile/accounts';
 type MessageHeader = Readonly<{
+    /**
+     * The number of accounts in the static accounts list that are neither writable nor
+     * signers.
+     *
+     * Adding this number to `numSignerAccounts` yields the index of the first read-only non-signer
+     * account in the static accounts list.
+     */
     numReadonlyNonSignerAccounts: number;
+    /**
+     * The number of read-only accounts in the static accounts list that must sign this
+     * transaction.
+     *
+     * Subtracting this number from `numSignerAccounts` yields the index of the first read-only
+     * signer account in the static accounts list.
+     */
     numReadonlySignerAccounts: number;
+    /**
+     * The number of accounts in the static accounts list that must sign this transaction.
+     *
+     * Subtracting `numReadonlySignerAccounts` from this number yields the number of
+     * writable signer accounts in the static accounts list. Writable signer accounts always
+     * begin at index zero in the static accounts list.
+     *
+     * This number itself is the index of the first non-signer account in the static
+     * accounts list.
+     */
     numSignerAccounts: number;
 }>;
 export declare function getCompiledMessageHeader(orderedAccounts: OrderedAccounts): MessageHeader;

package/dist/types/compile/header.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../src/compile/header.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,KAAK,aAAa,GAAG,QAAQ,CAAC;IAC1B,4BAA4B,EAAE,MAAM,CAAC;IACrC,yBAAyB,EAAE,MAAM,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC;CAC7B,CAAC,CAAC;AAEH,wBAAgB,wBAAwB,CAAC,eAAe,EAAE,eAAe,GAAG,aAAa,CAuBxF"}
+{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../src/compile/header.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,KAAK,aAAa,GAAG,QAAQ,CAAC;IAC1B;;;;;;OAMG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;;;;OAMG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;;;;;;;OASG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC7B,CAAC,CAAC;AAEH,wBAAgB,wBAAwB,CAAC,eAAe,EAAE,eAAe,GAAG,aAAa,CAuBxF"}

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

@@ -2,8 +2,17 @@ import { ReadonlyUint8Array } from '@solana/codecs-core';
 import { IInstruction } from '@solana/instructions';
 import { OrderedAccounts } from './accounts';
 type CompiledInstruction = Readonly<{
+    /**
+     * An ordered list of indices that indicate which accounts in the transaction message's
+     * accounts list are loaded by this instruction.
+     */
     accountIndices?: number[];
+    /** The input to the invoked program */
     data?: ReadonlyUint8Array;
+    /**
+     * The index of the address in the transaction message's accounts list associated with the
+     * program to invoke.
+     */
     programAddressIndex: number;
 }>;
 export declare function getCompiledInstructions(instructions: readonly IInstruction[], orderedAccounts: OrderedAccounts): CompiledInstruction[];

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

@@ -1 +1 @@
-{"version":3,"file":"instructions.d.ts","sourceRoot":"","sources":["../../../src/compile/instructions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,KAAK,mBAAmB,GAAG,QAAQ,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC,CAAC;AAUH,wBAAgB,uBAAuB,CACnC,YAAY,EAAE,SAAS,YAAY,EAAE,EACrC,eAAe,EAAE,eAAe,GACjC,mBAAmB,EAAE,CASvB"}
+{"version":3,"file":"instructions.d.ts","sourceRoot":"","sources":["../../../src/compile/instructions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,KAAK,mBAAmB,GAAG,QAAQ,CAAC;IAChC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,uCAAuC;IACvC,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC,CAAC;AAUH,wBAAgB,uBAAuB,CACnC,YAAY,EAAE,SAAS,YAAY,EAAE,EACrC,eAAe,EAAE,eAAe,GACjC,mBAAmB,EAAE,CASvB"}

package/dist/types/compile/message.d.ts

@@ -5,19 +5,50 @@ import { getCompiledInstructions } from './instructions';
 import { getCompiledLifetimeToken } from './lifetime-token';
 import { getCompiledStaticAccounts } from './static-accounts';
 type BaseCompiledTransactionMessage = Readonly<{
+    /**
+     * Information about the version of the transaction message and the role of the accounts it
+     * loads.
+     */
     header: ReturnType<typeof getCompiledMessageHeader>;
     instructions: ReturnType<typeof getCompiledInstructions>;
+    /**
+     * 32 bytes of data observed by the transaction proposed that makes a transaction eligible to
+     * land on the network.
+     *
+     * In the case of a transaction message with a nonce lifetime constraint, this will be the value
+     * of the nonce itself. In all other cases this will be a recent blockhash.
+     */
     lifetimeToken: ReturnType<typeof getCompiledLifetimeToken>;
+    /** A list of addresses indicating which accounts to load */
     staticAccounts: ReturnType<typeof getCompiledStaticAccounts>;
 }>;
+/**
+ * A transaction message in a form suitable for encoding for execution on the network.
+ *
+ * You can not fully reconstruct a source message from a compiled message without extra information.
+ * In particular, supporting details about the lifetime constraint and the concrete addresses of
+ * accounts sourced from account lookup tables are lost to compilation.
+ */
 export type CompiledTransactionMessage = LegacyCompiledTransactionMessage | VersionedCompiledTransactionMessage;
 type LegacyCompiledTransactionMessage = BaseCompiledTransactionMessage & Readonly<{
     version: 'legacy';
 }>;
 type VersionedCompiledTransactionMessage = BaseCompiledTransactionMessage & Readonly<{
+    /** A list of address tables and the accounts that this transaction loads from them */
     addressTableLookups?: ReturnType<typeof getCompiledAddressTableLookups>;
     version: number;
 }>;
+/**
+ * Converts the type of transaction message data structure that you create in your application to
+ * the type of transaction message data structure that can be encoded for execution on the network.
+ *
+ * This is a lossy process; you can not fully reconstruct a source message from a compiled message
+ * without extra information. In particular, supporting details about the lifetime constraint and
+ * the concrete addresses of accounts sourced from account lookup tables will be lost to
+ * compilation.
+ *
+ * @see {@link decompileTransactionMessage}
+ */
 export declare function compileTransactionMessage(transactionMessage: CompilableTransactionMessage & Readonly<{
     version: 'legacy';
 }>): LegacyCompiledTransactionMessage;

package/dist/types/compile/message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../src/compile/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAEjF,OAAO,EAAE,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAE9D,KAAK,8BAA8B,GAAG,QAAQ,CAAC;IAC3C,MAAM,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC;IACpD,YAAY,EAAE,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC;IACzD,aAAa,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC;IAC3D,cAAc,EAAE,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC;CAChE,CAAC,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,gCAAgC,GAAG,mCAAmC,CAAC;AAEhH,KAAK,gCAAgC,GAAG,8BAA8B,GAClE,QAAQ,CAAC;IACL,OAAO,EAAE,QAAQ,CAAC;CACrB,CAAC,CAAC;AAEP,KAAK,mCAAmC,GAAG,8BAA8B,GACrE,QAAQ,CAAC;IACL,mBAAmB,CAAC,EAAE,UAAU,CAAC,OAAO,8BAA8B,CAAC,CAAC;IACxE,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC,CAAC;AAEP,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,4BAA4B,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnF,gCAAgC,CAAC;AACpC,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,4BAA4B,GACjD,mCAAmC,CAAC"}
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../src/compile/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAEjF,OAAO,EAAE,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAE9D,KAAK,8BAA8B,GAAG,QAAQ,CAAC;IAC3C;;;OAGG;IACH,MAAM,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC;IACpD,YAAY,EAAE,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC;IACzD;;;;;;OAMG;IACH,aAAa,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC;IAC3D,4DAA4D;IAC5D,cAAc,EAAE,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC;CAChE,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG,gCAAgC,GAAG,mCAAmC,CAAC;AAEhH,KAAK,gCAAgC,GAAG,8BAA8B,GAClE,QAAQ,CAAC;IACL,OAAO,EAAE,QAAQ,CAAC;CACrB,CAAC,CAAC;AAEP,KAAK,mCAAmC,GAAG,8BAA8B,GACrE,QAAQ,CAAC;IACL,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,UAAU,CAAC,OAAO,8BAA8B,CAAC,CAAC;IACxE,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC,CAAC;AAEP;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,4BAA4B,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,GACnF,gCAAgC,CAAC;AACpC,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,4BAA4B,GACjD,mCAAmC,CAAC"}

package/dist/types/compress-transaction-message.d.ts

@@ -9,6 +9,34 @@ type WidenInstructionAccounts<TInstruction extends IInstruction> = TInstruction
 }> : TInstruction;
 type ExtractAdditionalProps<T, U> = Omit<T, keyof U>;
 type WidenTransactionMessageInstructions<TTransactionMessage extends TransactionMessage> = TTransactionMessage extends BaseTransactionMessage<infer TVersion, infer TInstruction> ? BaseTransactionMessage<TVersion, WidenInstructionAccounts<TInstruction>> & ExtractAdditionalProps<TTransactionMessage, BaseTransactionMessage<TVersion, WidenInstructionAccounts<TInstruction>>> : TTransactionMessage;
+/**
+ * Given a transaction message and a mapping of lookup tables to the addresses stored in them, this
+ * function will return a new transaction message with the same instructions but with all non-signer
+ * accounts that are found in the given lookup tables represented by an {@link IAccountLookupMeta}
+ * instead of an {@link IAccountMeta}.
+ *
+ * This means that these accounts will take up less space in the compiled transaction message. This
+ * size reduction is most significant when the transaction includes many accounts from the same
+ * lookup table.
+ *
+ * @example
+ * ```ts
+ * import { address } from '@solana/addresses';
+ * import { compressTransactionMessageUsingAddressLookupTables } from '@solana/transaction-messages';
+ *
+ * const lookupTableAddress = address('4QwSwNriKPrz8DLW4ju5uxC2TN5cksJx6tPUPj7DGLAW');
+ * const accountAddress = address('5n2ADjHPsqB4EVUNEX48xRqtnmuLu5XSHDwkJRR98qpM');
+ * const lookupTableAddresses: AddressesByLookupTableAddress = {
+ *     [lookupTableAddress]: [accountAddress],
+ * };
+ *
+ * const compressedTransactionMessage = compressTransactionMessageUsingAddressLookupTables(
+ *     transactionMessage,
+ *     lookupTableAddresses,
+ * );
+ * ```
+ *
+ */
 export declare function compressTransactionMessageUsingAddressLookupTables<TTransactionMessage extends TransactionMessageNotLegacy = TransactionMessageNotLegacy>(transactionMessage: TTransactionMessage, addressesByLookupTableAddress: AddressesByLookupTableAddress): TTransactionMessage | WidenTransactionMessageInstructions<TTransactionMessage>;
 export {};
 //# sourceMappingURL=compress-transaction-message.d.ts.map

package/dist/types/compress-transaction-message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compress-transaction-message.d.ts","sourceRoot":"","sources":["../../src/compress-transaction-message.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,kBAAkB,EAAE,YAAY,EAAE,YAAY,EAAgB,MAAM,sBAAsB,CAAC;AAEjH,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AA0BnF,KAAK,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAGtF,KAAK,wBAAwB,CAAC,YAAY,SAAS,YAAY,IAC3D,YAAY,SAAS,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,SAAS,CAAC,GACnE,YAAY,CACR,eAAe,EACf;KACK,CAAC,IAAI,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,QAAQ,CAAC,GACnE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,GACrD,SAAS,CAAC,CAAC,CAAC;CACrB,CACJ,GACD,YAAY,CAAC;AAEvB,KAAK,sBAAsB,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAErD,KAAK,mCAAmC,CAAC,mBAAmB,SAAS,kBAAkB,IACnF,mBAAmB,SAAS,sBAAsB,CAAC,MAAM,QAAQ,EAAE,MAAM,YAAY,CAAC,GAChF,sBAAsB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,YAAY,CAAC,CAAC,GACpE,sBAAsB,CAClB,mBAAmB,EACnB,sBAAsB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,YAAY,CAAC,CAAC,CAC3E,GACL,mBAAmB,CAAC;AAE9B,wBAAgB,kDAAkD,CAC9D,mBAAmB,SAAS,2BAA2B,GAAG,2BAA2B,EAErF,kBAAkB,EAAE,mBAAmB,EACvC,6BAA6B,EAAE,6BAA6B,GAC7D,mBAAmB,GAAG,mCAAmC,CAAC,mBAAmB,CAAC,CA2ChF"}
+{"version":3,"file":"compress-transaction-message.d.ts","sourceRoot":"","sources":["../../src/compress-transaction-message.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,kBAAkB,EAAE,YAAY,EAAE,YAAY,EAAgB,MAAM,sBAAsB,CAAC;AAEjH,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AA0BnF,KAAK,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAGtF,KAAK,wBAAwB,CAAC,YAAY,SAAS,YAAY,IAC3D,YAAY,SAAS,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,SAAS,CAAC,GACnE,YAAY,CACR,eAAe,EACf;KACK,CAAC,IAAI,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,QAAQ,CAAC,GACnE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,GACrD,SAAS,CAAC,CAAC,CAAC;CACrB,CACJ,GACD,YAAY,CAAC;AAEvB,KAAK,sBAAsB,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAErD,KAAK,mCAAmC,CAAC,mBAAmB,SAAS,kBAAkB,IACnF,mBAAmB,SAAS,sBAAsB,CAAC,MAAM,QAAQ,EAAE,MAAM,YAAY,CAAC,GAChF,sBAAsB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,YAAY,CAAC,CAAC,GACpE,sBAAsB,CAClB,mBAAmB,EACnB,sBAAsB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,YAAY,CAAC,CAAC,CAC3E,GACL,mBAAmB,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,kDAAkD,CAC9D,mBAAmB,SAAS,2BAA2B,GAAG,2BAA2B,EAErF,kBAAkB,EAAE,mBAAmB,EACvC,6BAA6B,EAAE,6BAA6B,GAC7D,mBAAmB,GAAG,mCAAmC,CAAC,mBAAmB,CAAC,CA2ChF"}

package/dist/types/create-transaction-message.d.ts

@@ -2,6 +2,17 @@ import { TransactionMessage, TransactionVersion } from './transaction-message';
 type TransactionConfig<TVersion extends TransactionVersion> = Readonly<{
     version: TVersion;
 }>;
+/**
+ * Given a {@link TransactionVersion} this method will return an empty transaction having the
+ * capabilities of that version.
+ *
+ * @example
+ * ```ts
+ * import { createTransactionMessage } from '@solana/transaction-messages';
+ *
+ * const message = createTransactionMessage({ version: 0 });
+ * ```
+ */
 export declare function createTransactionMessage<TVersion extends TransactionVersion>(config: TransactionConfig<TVersion>): Extract<TransactionMessage, {
     version: TVersion;
 }>;

package/dist/types/create-transaction-message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-transaction-message.d.ts","sourceRoot":"","sources":["../../src/create-transaction-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE/E,KAAK,iBAAiB,CAAC,QAAQ,SAAS,kBAAkB,IAAI,QAAQ,CAAC;IACnE,OAAO,EAAE,QAAQ,CAAC;CACrB,CAAC,CAAC;AAEH,wBAAgB,wBAAwB,CAAC,QAAQ,SAAS,kBAAkB,EACxE,MAAM,EAAE,iBAAiB,CAAC,QAAQ,CAAC,GACpC,OAAO,CAAC,kBAAkB,EAAE;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC"}
+{"version":3,"file":"create-transaction-message.d.ts","sourceRoot":"","sources":["../../src/create-transaction-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE/E,KAAK,iBAAiB,CAAC,QAAQ,SAAS,kBAAkB,IAAI,QAAQ,CAAC;IACnE,OAAO,EAAE,QAAQ,CAAC;CACrB,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,QAAQ,SAAS,kBAAkB,EACxE,MAAM,EAAE,iBAAiB,CAAC,QAAQ,CAAC,GACpC,OAAO,CAAC,kBAAkB,EAAE;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC"}

package/dist/types/decompile-message.d.ts

@@ -2,8 +2,31 @@ import { AddressesByLookupTableAddress } from './addresses-by-lookup-table-addre
 import { CompilableTransactionMessage } from './compilable-transaction-message';
 import { CompiledTransactionMessage } from './compile';
 export type DecompileTransactionMessageConfig = {
+    /**
+     * If the compiled message loads addresses from one or more address lookup tables, you will have
+     * to supply a map of those tables to an array of the addresses they contained at the time that
+     * the transaction message was constructed.
+     *
+     * @see {@link decompileTransactionMessageFetchingLookupTables} if you do not already have this.
+     */
     addressesByLookupTableAddress?: AddressesByLookupTableAddress;
+    /**
+     * If the compiled message has a blockhash-based lifetime constraint, you will have to supply
+     * the block height after which that blockhash is no longer valid for use as a lifetime
+     * constraint.
+     */
     lastValidBlockHeight?: bigint;
 };
+/**
+ * Converts the type of transaction message data structure appropriate for execution on the network
+ * to the type of transaction message data structure designed for use in your application.
+ *
+ * Because compilation is a lossy process, you can not fully reconstruct a source message from a
+ * compiled message without extra information. In order to faithfully reconstruct the original
+ * source message you will need to supply supporting details about the lifetime constraint and the
+ * concrete addresses of any accounts sourced from account lookup tables.
+ *
+ * @see {@link compileTransactionMessage}
+ */
 export declare function decompileTransactionMessage(compiledTransactionMessage: CompiledTransactionMessage, config?: DecompileTransactionMessageConfig): CompilableTransactionMessage;
 //# sourceMappingURL=decompile-message.d.ts.map

package/dist/types/decompile-message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decompile-message.d.ts","sourceRoot":"","sources":["../../src/decompile-message.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAEpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAuKvD,MAAM,MAAM,iCAAiC,GAAG;IAC5C,6BAA6B,CAAC,EAAE,6BAA6B,CAAC;IAC9D,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,wBAAgB,2BAA2B,CACvC,0BAA0B,EAAE,0BAA0B,EACtD,MAAM,CAAC,EAAE,iCAAiC,GAC3C,4BAA4B,CAyC9B"}
+{"version":3,"file":"decompile-message.d.ts","sourceRoot":"","sources":["../../src/decompile-message.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAEpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAuKvD,MAAM,MAAM,iCAAiC,GAAG;IAC5C;;;;;;OAMG;IACH,6BAA6B,CAAC,EAAE,6BAA6B,CAAC;IAC9D;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CACvC,0BAA0B,EAAE,0BAA0B,EACtD,MAAM,CAAC,EAAE,iCAAiC,GAC3C,4BAA4B,CAyC9B"}

package/dist/types/durable-nonce.d.ts

@@ -14,12 +14,33 @@ type DurableNonceConfig<TNonceAccountAddress extends string = string, TNonceAuth
     readonly nonceAccountAddress: Address<TNonceAccountAddress>;
     readonly nonceAuthorityAddress: Address<TNonceAuthorityAddress>;
 }>;
+/** Represents a string that is particularly known to be the base58-encoded value of a nonce. */
 export type Nonce<TNonceValue extends string = string> = TNonceValue & {
     readonly __brand: unique symbol;
 };
+/**
+ * A constraint which, when applied to a transaction message, makes that transaction message
+ * eligible to land on the network.
+ *
+ * The transaction message will continue to be eligible to land until the network considers the
+ * `nonce` to have advanced. This can happen when the nonce account in which this nonce is found is
+ * destroyed, or the nonce value within changes.
+ */
 type NonceLifetimeConstraint<TNonceValue extends string = string> = Readonly<{
+    /**
+     * A value contained in the related nonce account at the time the transaction was prepared.
+     *
+     * The transaction will be considered eligible to land until the nonce account ceases to exist
+     * or contain this value.
+     */
     nonce: Nonce<TNonceValue>;
 }>;
+/**
+ * Represents a transaction message whose lifetime is defined by the value of a nonce it includes.
+ *
+ * Such a transaction can only be landed on the network if the nonce is known to the network and has
+ * not already been used to land a different transaction.
+ */
 export interface TransactionMessageWithDurableNonceLifetime<TNonceAccountAddress extends string = string, TNonceAuthorityAddress extends string = string, TNonceValue extends string = string> {
     readonly instructions: readonly [
         AdvanceNonceAccountInstruction<TNonceAccountAddress, TNonceAuthorityAddress>,
@@ -27,9 +48,110 @@ export interface TransactionMessageWithDurableNonceLifetime<TNonceAccountAddress
     ];
     readonly lifetimeConstraint: NonceLifetimeConstraint<TNonceValue>;
 }
+/**
+ * From time to time you might acquire a transaction message, that you expect to have a
+ * nonce-based lifetime, from an untrusted network API or user input. Use this function to assert
+ * that such a transaction message actually has a nonce-based lifetime.
+ *
+ * @example
+ * ```ts
+ * import { assertIsDurableNonceTransactionMessage } from '@solana/transaction-messages';
+ *
+ * try {
+ *     // If this type assertion function doesn't throw, then
+ *     // Typescript will upcast `message` to `TransactionMessageWithDurableNonceLifetime`.
+ *     assertIsDurableNonceTransactionMessage(message);
+ *     // At this point, `message` is a `TransactionMessageWithDurableNonceLifetime` that can be used
+ *     // with the RPC.
+ *     const { nonce, nonceAccountAddress } = message.lifetimeConstraint;
+ *     const { data: { blockhash: actualNonce } } = await fetchNonce(nonceAccountAddress);
+ * } catch (e) {
+ *     // `message` turned out not to have a nonce-based lifetime
+ * }
+ * ```
+ */
 export declare function assertIsDurableNonceTransactionMessage(transactionMessage: BaseTransactionMessage | (BaseTransactionMessage & TransactionMessageWithDurableNonceLifetime)): asserts transactionMessage is BaseTransactionMessage & TransactionMessageWithDurableNonceLifetime;
+/**
+ * A type guard that returns `true` if the instruction conforms to the
+ * {@link AdvanceNonceAccountInstruction} type, and refines its type for use in your program.
+ *
+ * @example
+ * ```ts
+ * import { isAdvanceNonceAccountInstruction } from '@solana/transaction-messages';
+ *
+ * if (isAdvanceNonceAccountInstruction(message.instructions[0])) {
+ *     // At this point, the first instruction in the message has been refined to a
+ *     // `AdvanceNonceAccountInstruction`.
+ *     setNonceAccountAddress(message.instructions[0].accounts[0].address);
+ * } else {
+ *     setError('The first instruction is not an `AdvanceNonce` instruction');
+ * }
+ * ```
+ */
 export declare function isAdvanceNonceAccountInstruction(instruction: IInstruction): instruction is AdvanceNonceAccountInstruction;
+/**
+ * A type guard that returns `true` if the transaction message conforms to the
+ * {@link TransactionMessageWithDurableNonceLifetime} type, and refines its type for use in your
+ * program.
+ *
+ * @example
+ * ```ts
+ * import { isTransactionMessageWithDurableNonceLifetime } from '@solana/transaction-messages';
+ * import { fetchNonce } from "@solana-program/system";
+ *
+ * if (isTransactionMessageWithDurableNonceLifetime(message)) {
+ *     // At this point, `message` has been refined to a
+ *     // `TransactionMessageWithDurableNonceLifetime`.
+ *     const { nonce, nonceAccountAddress } = message.lifetimeConstraint;
+ *     const { data: { blockhash: actualNonce } } = await fetchNonce(nonceAccountAddress);
+ *     setNonceIsValid(nonce === actualNonce);
+ * } else {
+ *     setError(
+ *         `${getSignatureFromTransaction(transaction)} does not have a nonce-based lifetime`,
+ *     );
+ * }
+ * ```
+ */
 export declare function isDurableNonceTransaction(transactionMessage: BaseTransactionMessage | (BaseTransactionMessage & TransactionMessageWithDurableNonceLifetime)): transactionMessage is BaseTransactionMessage & TransactionMessageWithDurableNonceLifetime;
+/**
+ * Given a nonce, the account where the value of the nonce is stored, and the address of the account
+ * authorized to consume that nonce, this method will return a new transaction having the same type
+ * as the one supplied plus the {@link TransactionMessageWithDurableNonceLifetime} type.
+ *
+ * In particular, this method _prepends_ an instruction to the transaction message designed to
+ * consume (or 'advance') the nonce in the same transaction whose lifetime is defined by it.
+ *
+ * @param config
+ *
+ * @example
+ * ```ts
+ * import { setTransactionMessageLifetimeUsingDurableNonce } from '@solana/transactions';
+ *
+ * const NONCE_VALUE_OFFSET =
+ *     4 + // version(u32)
+ *     4 + // state(u32)
+ *     32; // nonce authority(pubkey)
+ * // Then comes the nonce value.
+ *
+ * const nonceAccountAddress = address('EGtMh4yvXswwHhwVhyPxGrVV2TkLTgUqGodbATEPvojZ');
+ * const nonceAuthorityAddress = address('4KD1Rdrd89NG7XbzW3xsX9Aqnx2EExJvExiNme6g9iAT');
+ * const { value: nonceAccount } = await rpc
+ *     .getAccountInfo(nonceAccountAddress, {
+ *         dataSlice: { length: 32, offset: NONCE_VALUE_OFFSET },
+ *         encoding: 'base58',
+ *     })
+ *     .send();
+ * const nonce =
+ *     // This works because we asked for the exact slice of data representing the nonce
+ *     // value, and furthermore asked for it in `base58` encoding.
+ *     nonceAccount!.data[0] as unknown as Nonce;
+ *
+ * const durableNonceTransactionMessage = setTransactionMessageLifetimeUsingDurableNonce(
+ *     { nonce, nonceAccountAddress, nonceAuthorityAddress },
+ *     tx,
+ * );
+ * ```
+ */
 export declare function setTransactionMessageLifetimeUsingDurableNonce<TTransactionMessage extends BaseTransactionMessage, TNonceAccountAddress extends string = string, TNonceAuthorityAddress extends string = string, TNonceValue extends string = string>({ nonce, nonceAccountAddress, nonceAuthorityAddress, }: DurableNonceConfig<TNonceAccountAddress, TNonceAuthorityAddress, TNonceValue>, transactionMessage: TTransactionMessage | (TransactionMessageWithDurableNonceLifetime & TTransactionMessage)): TransactionMessageWithDurableNonceLifetime<TNonceAccountAddress, TNonceAuthorityAddress, TNonceValue> & TTransactionMessage;
 export {};
 //# sourceMappingURL=durable-nonce.d.ts.map

package/dist/types/durable-nonce.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"durable-nonce.d.ts","sourceRoot":"","sources":["../../src/durable-nonce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,OAAO,EAEH,YAAY,EACZ,wBAAwB,EACxB,oBAAoB,EAEpB,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACxB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,KAAK,8BAA8B,CAC/B,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,IAC9C,YAAY,CAAC,kCAAkC,CAAC,GAChD,wBAAwB,CACpB,SAAS;IACL,eAAe,CAAC,oBAAoB,CAAC;IACrC,eAAe,CAAC,6CAA6C,CAAC;IAC9D,qBAAqB,CAAC,sBAAsB,CAAC,GAAG,qBAAqB,CAAC,sBAAsB,CAAC;CAChG,CACJ,GACD,oBAAoB,CAAC,kCAAkC,CAAC,CAAC;AAC7D,KAAK,kCAAkC,GAAG,UAAU,GAAG;IACnD,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAC;CACnC,CAAC;AACF,KAAK,kBAAkB,CACnB,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,EAC9C,WAAW,SAAS,MAAM,GAAG,MAAM,IACnC,QAAQ,CAAC;IACT,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IACnC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC5D,QAAQ,CAAC,qBAAqB,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACnE,CAAC,CAAC;AACH,MAAM,MAAM,KAAK,CAAC,WAAW,SAAS,MAAM,GAAG,MAAM,IAAI,WAAW,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAC3G,KAAK,uBAAuB,CAAC,WAAW,SAAS,MAAM,GAAG,MAAM,IAAI,QAAQ,CAAC;IACzE,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC7B,CAAC,CAAC;AAMH,MAAM,WAAW,0CAA0C,CACvD,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,EAC9C,WAAW,SAAS,MAAM,GAAG,MAAM;IAEnC,QAAQ,CAAC,YAAY,EAAE,SAAS;QAE5B,8BAA8B,CAAC,oBAAoB,EAAE,sBAAsB,CAAC;QAC5E,GAAG,YAAY,EAAE;KACpB,CAAC;IACF,QAAQ,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CACrE;AAED,wBAAgB,sCAAsC,CAClD,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,0CAA0C,CAAC,GACnH,OAAO,CAAC,kBAAkB,IAAI,sBAAsB,GAAG,0CAA0C,CAInG;AAuBD,wBAAgB,gCAAgC,CAC5C,WAAW,EAAE,YAAY,GAC1B,WAAW,IAAI,8BAA8B,CAkB/C;AAOD,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,0CAA0C,CAAC,GACnH,kBAAkB,IAAI,sBAAsB,GAAG,0CAA0C,CAO3F;AAgBD,wBAAgB,8CAA8C,CAC1D,mBAAmB,SAAS,sBAAsB,EAClD,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,EAC9C,WAAW,SAAS,MAAM,GAAG,MAAM,EAEnC,EACI,KAAK,EACL,mBAAmB,EACnB,qBAAqB,GACxB,EAAE,kBAAkB,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,WAAW,CAAC,EAChF,kBAAkB,EAAE,mBAAmB,GAAG,CAAC,0CAA0C,GAAG,mBAAmB,CAAC,GAC7G,0CAA0C,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,WAAW,CAAC,GACpG,mBAAmB,CA8CtB"}
+{"version":3,"file":"durable-nonce.d.ts","sourceRoot":"","sources":["../../src/durable-nonce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,OAAO,EAEH,YAAY,EACZ,wBAAwB,EACxB,oBAAoB,EAEpB,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACxB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,KAAK,8BAA8B,CAC/B,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,IAC9C,YAAY,CAAC,kCAAkC,CAAC,GAChD,wBAAwB,CACpB,SAAS;IACL,eAAe,CAAC,oBAAoB,CAAC;IACrC,eAAe,CAAC,6CAA6C,CAAC;IAC9D,qBAAqB,CAAC,sBAAsB,CAAC,GAAG,qBAAqB,CAAC,sBAAsB,CAAC;CAChG,CACJ,GACD,oBAAoB,CAAC,kCAAkC,CAAC,CAAC;AAC7D,KAAK,kCAAkC,GAAG,UAAU,GAAG;IACnD,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAC;CACnC,CAAC;AACF,KAAK,kBAAkB,CACnB,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,EAC9C,WAAW,SAAS,MAAM,GAAG,MAAM,IACnC,QAAQ,CAAC;IACT,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IACnC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC5D,QAAQ,CAAC,qBAAqB,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACnE,CAAC,CAAC;AACH,gGAAgG;AAChG,MAAM,MAAM,KAAK,CAAC,WAAW,SAAS,MAAM,GAAG,MAAM,IAAI,WAAW,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAC3G;;;;;;;GAOG;AACH,KAAK,uBAAuB,CAAC,WAAW,SAAS,MAAM,GAAG,MAAM,IAAI,QAAQ,CAAC;IACzE;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC7B,CAAC,CAAC;AAMH;;;;;GAKG;AACH,MAAM,WAAW,0CAA0C,CACvD,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,EAC9C,WAAW,SAAS,MAAM,GAAG,MAAM;IAEnC,QAAQ,CAAC,YAAY,EAAE,SAAS;QAE5B,8BAA8B,CAAC,oBAAoB,EAAE,sBAAsB,CAAC;QAC5E,GAAG,YAAY,EAAE;KACpB,CAAC;IACF,QAAQ,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CACrE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,sCAAsC,CAClD,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,0CAA0C,CAAC,GACnH,OAAO,CAAC,kBAAkB,IAAI,sBAAsB,GAAG,0CAA0C,CAInG;AAoCD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gCAAgC,CAC5C,WAAW,EAAE,YAAY,GAC1B,WAAW,IAAI,8BAA8B,CAkB/C;AAOD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,sBAAsB,GAAG,CAAC,sBAAsB,GAAG,0CAA0C,CAAC,GACnH,kBAAkB,IAAI,sBAAsB,GAAG,0CAA0C,CAO3F;AAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,8CAA8C,CAC1D,mBAAmB,SAAS,sBAAsB,EAClD,oBAAoB,SAAS,MAAM,GAAG,MAAM,EAC5C,sBAAsB,SAAS,MAAM,GAAG,MAAM,EAC9C,WAAW,SAAS,MAAM,GAAG,MAAM,EAEnC,EACI,KAAK,EACL,mBAAmB,EACnB,qBAAqB,GACxB,EAAE,kBAAkB,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,WAAW,CAAC,EAChF,kBAAkB,EAAE,mBAAmB,GAAG,CAAC,0CAA0C,GAAG,mBAAmB,CAAC,GAC7G,0CAA0C,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,WAAW,CAAC,GACpG,mBAAmB,CA8CtB"}

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

@@ -1,9 +1,27 @@
 import { Address } from '@solana/addresses';
 import { BaseTransactionMessage } from './transaction-message';
+/**
+ * Represents a transaction message for which a fee payer has been declared. A transaction must
+ * conform to this type to be compiled and landed on the network.
+ */
 export interface ITransactionMessageWithFeePayer<TAddress extends string = string> {
     readonly feePayer: Readonly<{
         address: Address<TAddress>;
     }>;
 }
+/**
+ * Given a base58-encoded address of a system account, this method will return a new transaction
+ * message having the same type as the one supplied plus the {@link ITransactionMessageWithFeePayer}
+ * type.
+ *
+ * @example
+ * ```ts
+ * import { address } from '@solana/addresses';
+ * import { setTransactionMessageFeePayer } from '@solana/transaction-messages';
+ *
+ * const myAddress = address('mpngsFd4tmbUfzDYJayjKZwZcaR7aWb2793J6grLsGu');
+ * const txPaidByMe = setTransactionMessageFeePayer(myAddress, tx);
+ * ```
+ */
 export declare function setTransactionMessageFeePayer<TFeePayerAddress extends string, TTransactionMessage extends BaseTransactionMessage & Partial<ITransactionMessageWithFeePayer>>(feePayer: Address<TFeePayerAddress>, transactionMessage: TTransactionMessage): ITransactionMessageWithFeePayer<TFeePayerAddress> & Omit<TTransactionMessage, 'feePayer'>;
 //# sourceMappingURL=fee-payer.d.ts.map