@solana/transactions 2.0.0-experimental.ffeddf6 → 2.0.0-preview.1

package/README.md

@@ -30,7 +30,7 @@ const transferTransaction = pipe(
     createTransaction({ version: 0 }),
     tx => setTransactionFeePayer(myAddress, tx),
     tx => setTransactionLifetimeUsingBlockhash(latestBlockhash, tx),
-    tx => appendTransactionInstruction(createTransferInstruction(myAddress, toAddress, amountInLamports), tx)
+    tx => appendTransactionInstruction(createTransferInstruction(myAddress, toAddress, amountInLamports), tx),
 );
 ```
 
@@ -144,7 +144,7 @@ const nonce =
 
 const durableNonceTransaction = setTransactionLifetimeUsingDurableNonce(
     { nonce, nonceAccountAddress, nonceAuthorityAddress },
-    tx
+    tx,
 );
 ```
 
@@ -210,14 +210,18 @@ const memoTransaction = appendTransactionInstruction(
         data: new TextEncoder().encode('Hello world!'),
         programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
     },
-    tx
+    tx,
 );
 ```
 
+If you'd like to add multiple instructions to a transaction at once, you may use the `appendTransactionInstructions` function instead which accepts an array of instructions.
+
 #### `prependTransactionInstruction()`
 
 Given an instruction, this method will return a new transaction with that instruction having been added to the beginning of the list of existing instructions.
 
+If you'd like to prepend multiple instructions to a transaction at once, you may use the `prependTransactionInstructions` function instead which accepts an array of instructions.
+
 See [`appendTransactionInstruction()`](#appendtransactioninstruction) for an example of how to use this function.
 
 ## Signing transactions
@@ -244,21 +248,11 @@ This type represents a transaction that is signed by all of its required signers
 
 Expect any function that modifies a transaction (eg. `setTransactionFeePayer`, `appendTransactionInstruction`, et cetera) to delete a transaction's `signatures` property and unset this type.
 
-#### `TransactionSignature`
-
-This type represents the base58-encoded signature of a transactions fee payer. This value uniquely identifies the transaction on the network.
-
 ### Functions
 
-#### `assertIsTransactionSignature()`
-
-From time to time you might acquire a string that you expect to be the base58-encoded signature of a transaction, from an untrusted network API or user input. To assert that such an arbitrary string is in fact a transaction signature, use the `assertIsTransactionSignature` function.
-
-See [`assertIsBlockhash()`](#assertisblockhash) for an example of how to use an assertion function.
-
 #### `getSignatureFromTransaction()`
 
-Given a transaction signed by its fee payer, this method will return the `TransactionSignature` that uniquely identifies it. This string can be used to look up transactions at a later date, for example on a Solana block explorer.
+Given a transaction signed by its fee payer, this method will return the `Signature` that uniquely identifies it. This string can be used to look up transactions at a later date, for example on a Solana block explorer.
 
 ```ts
 import { getSignatureFromTransaction } from '@solana/transactions';
@@ -267,25 +261,6 @@ const signature = getSignatureFromTransaction(tx);
 console.debug(`Inspect this transaction at https://explorer.solana.com/tx/${signature}`);
 ```
 
-#### `isTransactionSignature()`
-
-This is a type guard that accepts a string as input. It will both return `true` if the string conforms to the `TransactionSignature` type and will refine the type for use in your program.
-
-```ts
-import { isTransactionSignature } from '@solana/transactions';
-
-if (isTransactionSignature(signature)) {
-    // At this point, `signature` has been refined to a
-    // `TransactionSignature` that can be used with the RPC.
-    const {
-        value: [status],
-    } = await rpc.getSignatureStatuses([signature]).send();
-    setSignatureStatus(status);
-} else {
-    setError(`${signature} is not a transaction signature`);
-}
-```
-
 #### `signTransaction()`
 
 Given an array of `CryptoKey` objects which are private keys pertaining to addresses that are required to sign a transaction, this method will return a new signed transaction having the same type as the one supplied plus the `ITransactionWithSignatures` type.
@@ -297,19 +272,6 @@ import { signTransaction } from '@solana/transactions';
 const signedTransaction = await signTransaction([myPrivateKey], tx);
 ```
 
-#### `transactionSignature()`
-
-This helper combines _asserting_ that a string is a transaction signature with _coercing_ it to the `TransactionSignature` type. It's best used with untrusted input.
-
-```ts
-import { transactionSignature } from '@solana/transactions';
-
-const signature = transactionSignature(userSuppliedSignature);
-const {
-    value: [status],
-} = await rpc.getSignatureStatuses([signature]).send();
-```
-
 ## Serializing transactions
 
 Before sending a transaction to be landed on the network, you must serialize it in a particular way. You can use these types and functions to serialize a signed transaction into a binary format suitable for transit over the wire.