@solana/transactions 2.0.0-experimental.762ff13 → 2.0.0-experimental.76cf6b4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -43
- package/dist/index.browser.cjs +260 -429
- package/dist/index.browser.cjs.map +1 -1
- package/dist/index.browser.js +256 -430
- package/dist/index.browser.js.map +1 -1
- package/dist/index.development.js +679 -829
- package/dist/index.development.js.map +1 -1
- package/dist/index.native.js +256 -432
- package/dist/index.native.js.map +1 -1
- package/dist/index.node.cjs +260 -429
- package/dist/index.node.cjs.map +1 -1
- package/dist/index.node.js +256 -432
- package/dist/index.node.js.map +1 -1
- package/dist/index.production.min.js +23 -20
- package/dist/types/accounts.d.ts +2 -2
- package/dist/types/accounts.d.ts.map +1 -0
- package/dist/types/blockhash.d.ts +4 -3
- package/dist/types/blockhash.d.ts.map +1 -0
- package/dist/types/compilable-transaction.d.ts +7 -0
- package/dist/types/compilable-transaction.d.ts.map +1 -0
- package/dist/types/compile-address-table-lookups.d.ts +3 -3
- package/dist/types/compile-address-table-lookups.d.ts.map +1 -0
- package/dist/types/compile-header.d.ts +1 -1
- package/dist/types/compile-header.d.ts.map +1 -0
- package/dist/types/compile-instructions.d.ts +1 -1
- package/dist/types/compile-instructions.d.ts.map +1 -0
- package/dist/types/compile-lifetime-token.d.ts +1 -1
- package/dist/types/compile-lifetime-token.d.ts.map +1 -0
- package/dist/types/compile-static-accounts.d.ts +3 -3
- package/dist/types/compile-static-accounts.d.ts.map +1 -0
- package/dist/types/compile-transaction.d.ts +6 -7
- package/dist/types/compile-transaction.d.ts.map +1 -0
- package/dist/types/create-transaction.d.ts +1 -1
- package/dist/types/create-transaction.d.ts.map +1 -0
- package/dist/types/decompile-transaction.d.ts +3 -5
- package/dist/types/decompile-transaction.d.ts.map +1 -0
- package/dist/types/durable-nonce.d.ts +5 -5
- package/dist/types/durable-nonce.d.ts.map +1 -0
- package/dist/types/fee-payer.d.ts +6 -6
- package/dist/types/fee-payer.d.ts.map +1 -0
- package/dist/types/index.d.ts +11 -9
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/instructions.d.ts +2 -2
- package/dist/types/instructions.d.ts.map +1 -0
- package/dist/types/message.d.ts +6 -10
- package/dist/types/message.d.ts.map +1 -0
- package/dist/types/serializers/address-table-lookup.d.ts +5 -5
- package/dist/types/serializers/address-table-lookup.d.ts.map +1 -0
- package/dist/types/serializers/header.d.ts +5 -5
- package/dist/types/serializers/header.d.ts.map +1 -0
- package/dist/types/serializers/index.d.ts +2 -1
- package/dist/types/serializers/index.d.ts.map +1 -0
- package/dist/types/serializers/instruction.d.ts +5 -5
- package/dist/types/serializers/instruction.d.ts.map +1 -0
- package/dist/types/serializers/message.d.ts +5 -5
- package/dist/types/serializers/message.d.ts.map +1 -0
- package/dist/types/serializers/transaction-version.d.ts +5 -5
- package/dist/types/serializers/transaction-version.d.ts.map +1 -0
- package/dist/types/serializers/transaction.d.ts +6 -8
- package/dist/types/serializers/transaction.d.ts.map +1 -0
- package/dist/types/signatures.d.ts +9 -14
- package/dist/types/signatures.d.ts.map +1 -0
- package/dist/types/types.d.ts +6 -13
- package/dist/types/types.d.ts.map +1 -0
- package/dist/types/unsigned-transaction.d.ts +1 -1
- package/dist/types/unsigned-transaction.d.ts.map +1 -0
- package/dist/types/wire-transaction.d.ts +1 -1
- package/dist/types/wire-transaction.d.ts.map +1 -0
- package/package.json +15 -15
package/README.md
CHANGED
|
@@ -244,21 +244,11 @@ This type represents a transaction that is signed by all of its required signers
|
|
|
244
244
|
|
|
245
245
|
Expect any function that modifies a transaction (eg. `setTransactionFeePayer`, `appendTransactionInstruction`, et cetera) to delete a transaction's `signatures` property and unset this type.
|
|
246
246
|
|
|
247
|
-
#### `TransactionSignature`
|
|
248
|
-
|
|
249
|
-
This type represents the base58-encoded signature of a transactions fee payer. This value uniquely identifies the transaction on the network.
|
|
250
|
-
|
|
251
247
|
### Functions
|
|
252
248
|
|
|
253
|
-
#### `assertIsTransactionSignature()`
|
|
254
|
-
|
|
255
|
-
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.
|
|
256
|
-
|
|
257
|
-
See [`assertIsBlockhash()`](#assertisblockhash) for an example of how to use an assertion function.
|
|
258
|
-
|
|
259
249
|
#### `getSignatureFromTransaction()`
|
|
260
250
|
|
|
261
|
-
Given a transaction signed by its fee payer, this method will return the `
|
|
251
|
+
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.
|
|
262
252
|
|
|
263
253
|
```ts
|
|
264
254
|
import { getSignatureFromTransaction } from '@solana/transactions';
|
|
@@ -267,25 +257,6 @@ const signature = getSignatureFromTransaction(tx);
|
|
|
267
257
|
console.debug(`Inspect this transaction at https://explorer.solana.com/tx/${signature}`);
|
|
268
258
|
```
|
|
269
259
|
|
|
270
|
-
#### `isTransactionSignature()`
|
|
271
|
-
|
|
272
|
-
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.
|
|
273
|
-
|
|
274
|
-
```ts
|
|
275
|
-
import { isTransactionSignature } from '@solana/transactions';
|
|
276
|
-
|
|
277
|
-
if (isTransactionSignature(signature)) {
|
|
278
|
-
// At this point, `signature` has been refined to a
|
|
279
|
-
// `TransactionSignature` that can be used with the RPC.
|
|
280
|
-
const {
|
|
281
|
-
value: [status],
|
|
282
|
-
} = await rpc.getSignatureStatuses([signature]).send();
|
|
283
|
-
setSignatureStatus(status);
|
|
284
|
-
} else {
|
|
285
|
-
setError(`${signature} is not a transaction signature`);
|
|
286
|
-
}
|
|
287
|
-
```
|
|
288
|
-
|
|
289
260
|
#### `signTransaction()`
|
|
290
261
|
|
|
291
262
|
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 +268,6 @@ import { signTransaction } from '@solana/transactions';
|
|
|
297
268
|
const signedTransaction = await signTransaction([myPrivateKey], tx);
|
|
298
269
|
```
|
|
299
270
|
|
|
300
|
-
#### `transactionSignature()`
|
|
301
|
-
|
|
302
|
-
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.
|
|
303
|
-
|
|
304
|
-
```ts
|
|
305
|
-
import { transactionSignature } from '@solana/transactions';
|
|
306
|
-
|
|
307
|
-
const signature = transactionSignature(userSuppliedSignature);
|
|
308
|
-
const {
|
|
309
|
-
value: [status],
|
|
310
|
-
} = await rpc.getSignatureStatuses([signature]).send();
|
|
311
|
-
```
|
|
312
|
-
|
|
313
271
|
## Serializing transactions
|
|
314
272
|
|
|
315
273
|
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.
|