@aptos-labs/ts-sdk 0.0.1 → 0.0.3
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 +32 -24
- package/dist/browser/index.global.js +25 -25
- package/dist/browser/index.global.js.map +1 -1
- package/dist/cjs/index.d.ts +809 -184
- package/dist/cjs/index.js +1458 -616
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.d.ts +809 -184
- package/dist/esm/index.mjs +1388 -614
- package/dist/esm/index.mjs.map +1 -1
- package/dist/types/index.d.ts +72 -25
- package/dist/types/index.js +28 -3
- package/dist/types/index.js.map +1 -1
- package/package.json +1 -1
- package/src/api/account.ts +2 -2
- package/src/api/coin.ts +5 -5
- package/src/api/digitalAsset.ts +5 -5
- package/src/api/event.ts +2 -2
- package/src/api/faucet.ts +7 -3
- package/src/api/transactionSubmission.ts +24 -24
- package/src/bcs/serializable/fixedBytes.ts +1 -1
- package/src/bcs/serializable/moveStructs.ts +16 -36
- package/src/core/account.ts +12 -8
- package/src/core/accountAddress.ts +4 -2
- package/src/core/authenticationKey.ts +24 -2
- package/src/core/crypto/anyPublicKey.ts +14 -18
- package/src/core/crypto/ed25519.ts +6 -0
- package/src/core/crypto/index.ts +1 -0
- package/src/core/crypto/multiKey.ts +122 -0
- package/src/core/crypto/secp256k1.ts +2 -0
- package/src/index.ts +1 -2
- package/src/internal/account.ts +5 -5
- package/src/internal/coin.ts +8 -8
- package/src/internal/digitalAsset.ts +7 -7
- package/src/internal/event.ts +2 -2
- package/src/internal/faucet.ts +9 -5
- package/src/internal/transactionSubmission.ts +40 -15
- package/src/transactions/authenticator/account.ts +39 -0
- package/src/transactions/authenticator/index.ts +5 -0
- package/src/transactions/authenticator/transaction.ts +6 -6
- package/src/transactions/index.ts +9 -0
- package/src/transactions/instances/index.ts +1 -0
- package/src/transactions/instances/transactionPayload.ts +13 -8
- package/src/transactions/transactionBuilder/helpers.ts +99 -0
- package/src/transactions/transactionBuilder/index.ts +6 -0
- package/src/transactions/transactionBuilder/remoteAbi.ts +339 -0
- package/src/transactions/{transaction_builder/transaction_builder.ts → transactionBuilder/transactionBuilder.ts} +149 -68
- package/src/transactions/typeTag/index.ts +385 -0
- package/src/transactions/typeTag/parser.ts +21 -8
- package/src/transactions/types.ts +87 -46
- package/src/types/index.ts +18 -16
- package/src/transactions/typeTag/typeTag.ts +0 -487
package/dist/cjs/index.d.ts
CHANGED
|
@@ -678,7 +678,7 @@ declare enum MimeType {
|
|
|
678
678
|
*/
|
|
679
679
|
declare type HexInput = string | Uint8Array;
|
|
680
680
|
/**
|
|
681
|
-
*
|
|
681
|
+
* TypeTag enum as they are represented in Rust
|
|
682
682
|
* {@link https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-core/types/src/language_storage.rs#L27}
|
|
683
683
|
*/
|
|
684
684
|
declare enum TypeTagVariants {
|
|
@@ -692,7 +692,9 @@ declare enum TypeTagVariants {
|
|
|
692
692
|
Struct = 7,
|
|
693
693
|
U16 = 8,
|
|
694
694
|
U32 = 9,
|
|
695
|
-
U256 = 10
|
|
695
|
+
U256 = 10,
|
|
696
|
+
Reference = 254,
|
|
697
|
+
Generic = 255
|
|
696
698
|
}
|
|
697
699
|
/**
|
|
698
700
|
* Script transaction arguments enum as they are represented in Rust
|
|
@@ -735,7 +737,7 @@ declare enum TransactionAuthenticatorVariant {
|
|
|
735
737
|
MultiEd25519 = 1,
|
|
736
738
|
MultiAgent = 2,
|
|
737
739
|
FeePayer = 3,
|
|
738
|
-
|
|
740
|
+
SingleSender = 4
|
|
739
741
|
}
|
|
740
742
|
/**
|
|
741
743
|
* Transaction Authenticator enum as they are represented in Rust
|
|
@@ -744,7 +746,16 @@ declare enum TransactionAuthenticatorVariant {
|
|
|
744
746
|
declare enum AccountAuthenticatorVariant {
|
|
745
747
|
Ed25519 = 0,
|
|
746
748
|
MultiEd25519 = 1,
|
|
747
|
-
|
|
749
|
+
SingleKey = 2,
|
|
750
|
+
MultiKey = 3
|
|
751
|
+
}
|
|
752
|
+
declare enum AnyPublicKeyVariant {
|
|
753
|
+
Ed25519 = 0,
|
|
754
|
+
Secp256k1 = 1
|
|
755
|
+
}
|
|
756
|
+
declare enum AnySignatureVariant {
|
|
757
|
+
Ed25519 = 0,
|
|
758
|
+
Secp256k1 = 1
|
|
748
759
|
}
|
|
749
760
|
/**
|
|
750
761
|
* BCS types
|
|
@@ -866,7 +877,7 @@ declare type GasEstimation = {
|
|
|
866
877
|
prioritized_gas_estimate?: number;
|
|
867
878
|
};
|
|
868
879
|
declare type MoveResource = {
|
|
869
|
-
type:
|
|
880
|
+
type: MoveStructType;
|
|
870
881
|
data: {};
|
|
871
882
|
};
|
|
872
883
|
declare type AccountData = {
|
|
@@ -1102,7 +1113,7 @@ declare type DeletedTableData = {
|
|
|
1102
1113
|
declare type TransactionPayloadResponse = EntryFunctionPayloadResponse | ScriptPayloadResponse | MultisigPayloadResponse;
|
|
1103
1114
|
declare type EntryFunctionPayloadResponse = {
|
|
1104
1115
|
type: string;
|
|
1105
|
-
function:
|
|
1116
|
+
function: MoveStructType;
|
|
1106
1117
|
/**
|
|
1107
1118
|
* Type arguments of the function
|
|
1108
1119
|
*/
|
|
@@ -1236,14 +1247,13 @@ declare type MoveUint32Type = number;
|
|
|
1236
1247
|
declare type MoveUint64Type = string;
|
|
1237
1248
|
declare type MoveUint128Type = string;
|
|
1238
1249
|
declare type MoveUint256Type = string;
|
|
1239
|
-
declare type MoveAddressType =
|
|
1240
|
-
declare type MoveObjectType =
|
|
1241
|
-
declare type MoveStructType = `0x${string}::${string}::${string}`;
|
|
1250
|
+
declare type MoveAddressType = string;
|
|
1251
|
+
declare type MoveObjectType = string;
|
|
1242
1252
|
declare type MoveOptionType = MoveType | null | undefined;
|
|
1243
1253
|
/**
|
|
1244
|
-
*
|
|
1254
|
+
* This is the format for a fully qualified struct, resource, or entry function in Move.
|
|
1245
1255
|
*/
|
|
1246
|
-
declare type
|
|
1256
|
+
declare type MoveStructType = `${string}::${string}::${string}`;
|
|
1247
1257
|
declare type MoveType = boolean | string | MoveUint8Type | MoveUint16Type | MoveUint32Type | MoveUint64Type | MoveUint128Type | MoveUint256Type | MoveAddressType | MoveObjectType | MoveStructType | Array<MoveType>;
|
|
1248
1258
|
/**
|
|
1249
1259
|
* Possible Move values acceptable by move functions (entry, view)
|
|
@@ -1399,7 +1409,7 @@ declare type LedgerInfo = {
|
|
|
1399
1409
|
*/
|
|
1400
1410
|
declare type Block = {
|
|
1401
1411
|
block_height: string;
|
|
1402
|
-
block_hash:
|
|
1412
|
+
block_hash: string;
|
|
1403
1413
|
block_timestamp: string;
|
|
1404
1414
|
first_version: string;
|
|
1405
1415
|
last_version: string;
|
|
@@ -1413,24 +1423,24 @@ declare type Block = {
|
|
|
1413
1423
|
*/
|
|
1414
1424
|
declare type ViewRequestData = {
|
|
1415
1425
|
function: MoveStructType;
|
|
1416
|
-
typeArguments?: Array<
|
|
1417
|
-
|
|
1426
|
+
typeArguments?: Array<MoveStructType>;
|
|
1427
|
+
functionArguments?: Array<MoveValue>;
|
|
1418
1428
|
};
|
|
1419
1429
|
/**
|
|
1420
1430
|
* View request for the Move view function API
|
|
1421
1431
|
*
|
|
1422
|
-
* `type
|
|
1432
|
+
* `type MoveStructType = ${string}::${string}::${string}`;
|
|
1423
1433
|
*/
|
|
1424
1434
|
declare type ViewRequest = {
|
|
1425
|
-
function:
|
|
1435
|
+
function: MoveStructType;
|
|
1426
1436
|
/**
|
|
1427
1437
|
* Type arguments of the function
|
|
1428
1438
|
*/
|
|
1429
|
-
type_arguments: Array<
|
|
1439
|
+
type_arguments: Array<MoveStructType>;
|
|
1430
1440
|
/**
|
|
1431
1441
|
* Arguments of the function
|
|
1432
1442
|
*/
|
|
1433
|
-
|
|
1443
|
+
functionArguments: Array<MoveValue>;
|
|
1434
1444
|
};
|
|
1435
1445
|
/**
|
|
1436
1446
|
* Table Item request for the GetTableItem API
|
|
@@ -1449,11 +1459,6 @@ declare type TableItemRequest = {
|
|
|
1449
1459
|
* They are combinations of signing schemes and derive schemes.
|
|
1450
1460
|
*/
|
|
1451
1461
|
declare type AuthenticationKeyScheme = SigningScheme | DeriveScheme;
|
|
1452
|
-
/**
|
|
1453
|
-
* A list of signing schemes that are supported by Aptos.
|
|
1454
|
-
*
|
|
1455
|
-
* https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs#L375-L378
|
|
1456
|
-
*/
|
|
1457
1462
|
declare enum SigningScheme {
|
|
1458
1463
|
/**
|
|
1459
1464
|
* For Ed25519PublicKey
|
|
@@ -1464,7 +1469,18 @@ declare enum SigningScheme {
|
|
|
1464
1469
|
*/
|
|
1465
1470
|
MultiEd25519 = 1,
|
|
1466
1471
|
/**
|
|
1467
|
-
* For
|
|
1472
|
+
* For SingleKey ecdsa
|
|
1473
|
+
*/
|
|
1474
|
+
SingleKey = 2,
|
|
1475
|
+
MultiKey = 3
|
|
1476
|
+
}
|
|
1477
|
+
declare enum SigningSchemeInput {
|
|
1478
|
+
/**
|
|
1479
|
+
* For Ed25519PublicKey
|
|
1480
|
+
*/
|
|
1481
|
+
Ed25519 = 0,
|
|
1482
|
+
/**
|
|
1483
|
+
* For Secp256k1Ecdsa
|
|
1468
1484
|
*/
|
|
1469
1485
|
Secp256k1Ecdsa = 2
|
|
1470
1486
|
}
|
|
@@ -1493,6 +1509,37 @@ declare enum DeriveScheme {
|
|
|
1493
1509
|
*/
|
|
1494
1510
|
DeriveResourceAccountAddress = 255
|
|
1495
1511
|
}
|
|
1512
|
+
/**
|
|
1513
|
+
* Option properties to pass for waitForTransaction() function
|
|
1514
|
+
*/
|
|
1515
|
+
declare type WaitForTransactionOptions = {
|
|
1516
|
+
timeoutSecs?: number;
|
|
1517
|
+
checkSuccess?: boolean;
|
|
1518
|
+
indexerVersionCheck?: boolean;
|
|
1519
|
+
};
|
|
1520
|
+
/**
|
|
1521
|
+
* Account input type to generate an account using Legacy
|
|
1522
|
+
* Ed25519 or MultiEd25519 keys or without a specified `scheme`.
|
|
1523
|
+
* If `scheme` is not specified, we default to ED25519
|
|
1524
|
+
* In this case `legacy` is always true
|
|
1525
|
+
*/
|
|
1526
|
+
declare type GenerateAccountWithLegacyKey = {
|
|
1527
|
+
scheme?: SigningSchemeInput.Ed25519;
|
|
1528
|
+
legacy: true;
|
|
1529
|
+
};
|
|
1530
|
+
/**
|
|
1531
|
+
* Account input type to generate an account using Unified
|
|
1532
|
+
* Secp256k1Ecdsa key
|
|
1533
|
+
* In this case `legacy` is always false
|
|
1534
|
+
*/
|
|
1535
|
+
declare type GenerateAccountWithUnifiedKey = {
|
|
1536
|
+
scheme: SigningSchemeInput.Secp256k1Ecdsa | SigningSchemeInput.Ed25519;
|
|
1537
|
+
legacy?: false;
|
|
1538
|
+
};
|
|
1539
|
+
/**
|
|
1540
|
+
* Unify GenerateAccount type for Legacy and Unified keys
|
|
1541
|
+
*/
|
|
1542
|
+
declare type GenerateAccount = GenerateAccountWithLegacyKey | GenerateAccountWithUnifiedKey;
|
|
1496
1543
|
|
|
1497
1544
|
/**
|
|
1498
1545
|
* Type of API endpoint for request routing
|
|
@@ -1509,6 +1556,9 @@ declare enum AptosApiType {
|
|
|
1509
1556
|
declare class AptosConfig {
|
|
1510
1557
|
/** The Network that this SDK is associated with. */
|
|
1511
1558
|
readonly network: Network;
|
|
1559
|
+
/**
|
|
1560
|
+
* The client instance the SDK uses
|
|
1561
|
+
*/
|
|
1512
1562
|
readonly client: Client;
|
|
1513
1563
|
/**
|
|
1514
1564
|
* The optional hardcoded fullnode URL to send requests to instead of using the network
|
|
@@ -2068,6 +2118,7 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2068
2118
|
* The length of an address string in LONG form without a leading 0x.
|
|
2069
2119
|
*/
|
|
2070
2120
|
static readonly LONG_STRING_LENGTH: number;
|
|
2121
|
+
static ZERO: AccountAddress;
|
|
2071
2122
|
static ONE: AccountAddress;
|
|
2072
2123
|
static TWO: AccountAddress;
|
|
2073
2124
|
static THREE: AccountAddress;
|
|
@@ -2101,7 +2152,7 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2101
2152
|
*
|
|
2102
2153
|
* @returns AccountAddress as a string conforming to AIP-40.
|
|
2103
2154
|
*/
|
|
2104
|
-
toString(): string
|
|
2155
|
+
toString(): `0x${string}`;
|
|
2105
2156
|
/**
|
|
2106
2157
|
* NOTE: Prefer to use `toString` where possible.
|
|
2107
2158
|
*
|
|
@@ -2123,7 +2174,7 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2123
2174
|
*
|
|
2124
2175
|
* @returns AccountAddress as a string in LONG form.
|
|
2125
2176
|
*/
|
|
2126
|
-
toStringLong(): string
|
|
2177
|
+
toStringLong(): `0x${string}`;
|
|
2127
2178
|
/**
|
|
2128
2179
|
* NOTE: Prefer to use `toString` where possible.
|
|
2129
2180
|
*
|
|
@@ -2280,9 +2331,9 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2280
2331
|
* @example
|
|
2281
2332
|
* const yourCustomSerializedBytes = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
|
|
2282
2333
|
* const fixedBytes = new FixedBytes(yourCustomSerializedBytes);
|
|
2283
|
-
* const payload = generateTransactionPayload({
|
|
2334
|
+
* const payload = await generateTransactionPayload({
|
|
2284
2335
|
* function: "0xbeefcafe::your_module::your_function_that_requires_custom_serialization",
|
|
2285
|
-
*
|
|
2336
|
+
* functionArguments: [yourCustomBytes],
|
|
2286
2337
|
* });
|
|
2287
2338
|
*
|
|
2288
2339
|
* For example, if you store each of the 32 bytes for an address as a U8 in a MoveVector<U8>, when you
|
|
@@ -2430,7 +2481,7 @@ declare class U256 extends Serializable implements TransactionArgument {
|
|
|
2430
2481
|
* values: an Array<T> of values where T is a class that implements Serializable
|
|
2431
2482
|
* @returns a `MoveVector<T>` with the values `values`
|
|
2432
2483
|
*/
|
|
2433
|
-
declare class MoveVector<T extends Serializable> extends Serializable implements TransactionArgument {
|
|
2484
|
+
declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends Serializable implements TransactionArgument {
|
|
2434
2485
|
values: Array<T>;
|
|
2435
2486
|
constructor(values: Array<T>);
|
|
2436
2487
|
serializeForEntryFunction(serializer: Serializer): void;
|
|
@@ -2528,7 +2579,7 @@ declare class MoveVector<T extends Serializable> extends Serializable implements
|
|
|
2528
2579
|
* @returns a MoveVector of the corresponding class T
|
|
2529
2580
|
* *
|
|
2530
2581
|
*/
|
|
2531
|
-
static deserialize<T extends Serializable>(deserializer: Deserializer, cls: Deserializable<T>): MoveVector<T>;
|
|
2582
|
+
static deserialize<T extends Serializable & EntryFunctionArgument>(deserializer: Deserializer, cls: Deserializable<T>): MoveVector<T>;
|
|
2532
2583
|
}
|
|
2533
2584
|
declare class MoveString extends Serializable implements TransactionArgument {
|
|
2534
2585
|
value: string;
|
|
@@ -2538,7 +2589,7 @@ declare class MoveString extends Serializable implements TransactionArgument {
|
|
|
2538
2589
|
serializeForScriptFunction(serializer: Serializer): void;
|
|
2539
2590
|
static deserialize(deserializer: Deserializer): MoveString;
|
|
2540
2591
|
}
|
|
2541
|
-
declare class MoveOption<T extends Serializable> extends Serializable implements EntryFunctionArgument {
|
|
2592
|
+
declare class MoveOption<T extends Serializable & EntryFunctionArgument> extends Serializable implements EntryFunctionArgument {
|
|
2542
2593
|
private vec;
|
|
2543
2594
|
readonly value?: T;
|
|
2544
2595
|
constructor(value?: T | null);
|
|
@@ -2659,15 +2710,7 @@ declare class MoveOption<T extends Serializable> extends Serializable implements
|
|
|
2659
2710
|
* @returns a MoveOption<MoveString> with an inner value `value`
|
|
2660
2711
|
*/
|
|
2661
2712
|
static MoveString(value?: string | null): MoveOption<MoveString>;
|
|
2662
|
-
static deserialize<U extends Serializable>(deserializer: Deserializer, cls: Deserializable<U>): MoveOption<U>;
|
|
2663
|
-
}
|
|
2664
|
-
declare class MoveObject extends Serializable implements TransactionArgument {
|
|
2665
|
-
value: AccountAddress;
|
|
2666
|
-
constructor(value: HexInput | AccountAddress);
|
|
2667
|
-
serialize(serializer: Serializer): void;
|
|
2668
|
-
serializeForEntryFunction(serializer: Serializer): void;
|
|
2669
|
-
serializeForScriptFunction(serializer: Serializer): void;
|
|
2670
|
-
static deserialize(deserializer: Deserializer): MoveObject;
|
|
2713
|
+
static deserialize<U extends Serializable & EntryFunctionArgument>(deserializer: Deserializer, cls: Deserializable<U>): MoveOption<U>;
|
|
2671
2714
|
}
|
|
2672
2715
|
|
|
2673
2716
|
/**
|
|
@@ -2739,6 +2782,22 @@ declare abstract class Signature extends Serializable {
|
|
|
2739
2782
|
*
|
|
2740
2783
|
* Use this class to create accounts, sign transactions, and more.
|
|
2741
2784
|
* Note: Creating an account instance does not create the account on-chain.
|
|
2785
|
+
*
|
|
2786
|
+
* Since [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263) Aptos supports
|
|
2787
|
+
* `Legacy` and `Unified` authentications.
|
|
2788
|
+
*
|
|
2789
|
+
* @Legacy includes `ED25519` and `MultiED25519`
|
|
2790
|
+
* @Unified includes `SingleSender` and `MultiSender`, where currently
|
|
2791
|
+
* `SingleSender` supports `ED25519` and `Secp256k1`, and `MultiSender` supports
|
|
2792
|
+
* `MultiED25519`.
|
|
2793
|
+
*
|
|
2794
|
+
* In TypeScript SDK, we support all of these options
|
|
2795
|
+
* @generate default to generate Unified keys, with an optional `legacy` boolean argument
|
|
2796
|
+
* that lets you generate new keys conforming to the Legacy authentication.
|
|
2797
|
+
* @fromPrivateKey derives an account by a provided private key and address, with an optional
|
|
2798
|
+
* `legacy` boolean argument that lets you generate new keys conforming to the Legacy authentication.
|
|
2799
|
+
* @fromDerivationPath derives an account with bip44 path and mnemonics,
|
|
2800
|
+
*
|
|
2742
2801
|
*/
|
|
2743
2802
|
declare class Account$1 {
|
|
2744
2803
|
/**
|
|
@@ -2764,38 +2823,56 @@ declare class Account$1 {
|
|
|
2764
2823
|
*
|
|
2765
2824
|
* @param args.privateKey PrivateKey - private key of the account
|
|
2766
2825
|
* @param args.address AccountAddress - address of the account
|
|
2826
|
+
* @param args.legacy optional. If set to true, the keypair authentication keys will be derived with a Legacy scheme.
|
|
2827
|
+
* Defaults to deriving an authentication key with a Unified scheme
|
|
2767
2828
|
*
|
|
2768
2829
|
* This method is private because it should only be called by the factory static methods.
|
|
2769
2830
|
* @returns Account
|
|
2770
2831
|
*/
|
|
2771
2832
|
private constructor();
|
|
2772
2833
|
/**
|
|
2773
|
-
* Derives an account with random private key and address
|
|
2834
|
+
* Derives an account with random private key and address.
|
|
2835
|
+
* Default generation is using the Unified flow with ED25519 key
|
|
2774
2836
|
*
|
|
2775
|
-
* @param
|
|
2776
|
-
*
|
|
2837
|
+
* @param args optional. Unify GenerateAccount type for Legacy and Unified keys
|
|
2838
|
+
*
|
|
2839
|
+
* Account input type to generate an account using Legacy
|
|
2840
|
+
* Ed25519 or MultiEd25519 keys or without a specified `scheme`.
|
|
2841
|
+
* ```
|
|
2842
|
+
* GenerateAccountWithLegacyKey = {
|
|
2843
|
+
* scheme?: SigningSchemeInput.Ed25519 | SigningSchemeInput.MultiEd25519;
|
|
2844
|
+
* legacy: true;
|
|
2845
|
+
* };
|
|
2846
|
+
* ```
|
|
2847
|
+
*
|
|
2848
|
+
* Account input type to generate an account using Unified
|
|
2849
|
+
* Secp256k1Ecdsa key
|
|
2850
|
+
* In this case `legacy` is always false
|
|
2851
|
+
* ```
|
|
2852
|
+
* GenerateAccountWithUnifiedKey = {
|
|
2853
|
+
* scheme: SigningSchemeInput.Secp256k1Ecdsa;
|
|
2854
|
+
* legacy?: false;
|
|
2855
|
+
* };
|
|
2856
|
+
* ```
|
|
2777
2857
|
*
|
|
2778
2858
|
* @returns Account with the given signing scheme
|
|
2779
2859
|
*/
|
|
2780
|
-
static generate(
|
|
2860
|
+
static generate(args?: GenerateAccount): Account$1;
|
|
2781
2861
|
/**
|
|
2782
|
-
*
|
|
2862
|
+
* Instantiates an account given a private key and a specified account address.
|
|
2863
|
+
* This is primarily used to instantiate an `Account` that has had its authentication key rotated.
|
|
2783
2864
|
*
|
|
2784
|
-
* @param privateKey
|
|
2785
|
-
* @
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
/**
|
|
2789
|
-
* Derives an account with provided private key and address
|
|
2790
|
-
* This is intended to be used for account that has it's key rotated
|
|
2865
|
+
* @param privateKey PrivateKey - private key of the account
|
|
2866
|
+
* @param address The account address
|
|
2867
|
+
* @param args.legacy optional. If set to true, the keypair authentication keys will be derived with a Legacy scheme.
|
|
2868
|
+
* Defaults to deriving an authentication key with a Unified scheme
|
|
2791
2869
|
*
|
|
2792
|
-
* @param args.privateKey Hex - private key of the account
|
|
2793
|
-
* @param args.address AccountAddress - address of the account
|
|
2794
2870
|
* @returns Account
|
|
2795
2871
|
*/
|
|
2796
2872
|
static fromPrivateKeyAndAddress(args: {
|
|
2797
2873
|
privateKey: PrivateKey;
|
|
2798
2874
|
address: AccountAddress;
|
|
2875
|
+
legacy?: boolean;
|
|
2799
2876
|
}): Account$1;
|
|
2800
2877
|
/**
|
|
2801
2878
|
* Derives an account with bip44 path and mnemonics,
|
|
@@ -2851,7 +2928,7 @@ declare class Account$1 {
|
|
|
2851
2928
|
*
|
|
2852
2929
|
* Account addresses can be derived from AuthenticationKey
|
|
2853
2930
|
*/
|
|
2854
|
-
declare class AuthenticationKey {
|
|
2931
|
+
declare class AuthenticationKey extends Serializable {
|
|
2855
2932
|
/**
|
|
2856
2933
|
* An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.
|
|
2857
2934
|
*/
|
|
@@ -2863,6 +2940,13 @@ declare class AuthenticationKey {
|
|
|
2863
2940
|
constructor(args: {
|
|
2864
2941
|
data: HexInput;
|
|
2865
2942
|
});
|
|
2943
|
+
serialize(serializer: Serializer): void;
|
|
2944
|
+
/**
|
|
2945
|
+
* Deserialize an AuthenticationKey from the byte buffer in a Deserializer instance.
|
|
2946
|
+
* @param deserializer The deserializer to deserialize the AuthenticationKey from.
|
|
2947
|
+
* @returns An instance of AuthenticationKey.
|
|
2948
|
+
*/
|
|
2949
|
+
static deserialize(deserializer: Deserializer): AuthenticationKey;
|
|
2866
2950
|
toString(): string;
|
|
2867
2951
|
toUint8Array(): Uint8Array;
|
|
2868
2952
|
/**
|
|
@@ -2871,7 +2955,10 @@ declare class AuthenticationKey {
|
|
|
2871
2955
|
* This allows for the creation of AuthenticationKeys that are not derived from Public Keys directly
|
|
2872
2956
|
* @param args
|
|
2873
2957
|
*/
|
|
2874
|
-
|
|
2958
|
+
static fromPublicKeyAndScheme(args: {
|
|
2959
|
+
publicKey: PublicKey;
|
|
2960
|
+
scheme: AuthenticationKeyScheme;
|
|
2961
|
+
}): AuthenticationKey;
|
|
2875
2962
|
/**
|
|
2876
2963
|
* Converts a PublicKey(s) to AuthenticationKey
|
|
2877
2964
|
*
|
|
@@ -2892,6 +2979,12 @@ declare class AuthenticationKey {
|
|
|
2892
2979
|
|
|
2893
2980
|
/**
|
|
2894
2981
|
* Represents the public key of an Ed25519 key pair.
|
|
2982
|
+
*
|
|
2983
|
+
* Since [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263) Aptos supports
|
|
2984
|
+
* `Legacy` and `Unified` authentication keys.
|
|
2985
|
+
*
|
|
2986
|
+
* Ed25519 scheme is represented in the SDK as `Legacy authentication key` and also
|
|
2987
|
+
* as `AnyPublicKey` that represents any `Unified authentication key`
|
|
2895
2988
|
*/
|
|
2896
2989
|
declare class Ed25519PublicKey extends PublicKey {
|
|
2897
2990
|
/**
|
|
@@ -2932,6 +3025,7 @@ declare class Ed25519PublicKey extends PublicKey {
|
|
|
2932
3025
|
}): boolean;
|
|
2933
3026
|
serialize(serializer: Serializer): void;
|
|
2934
3027
|
static deserialize(deserializer: Deserializer): Ed25519PublicKey;
|
|
3028
|
+
static load(deserializer: Deserializer): Ed25519PublicKey;
|
|
2935
3029
|
}
|
|
2936
3030
|
/**
|
|
2937
3031
|
* Represents the private key of an Ed25519 key pair.
|
|
@@ -3014,6 +3108,7 @@ declare class Ed25519Signature extends Signature {
|
|
|
3014
3108
|
toString(): string;
|
|
3015
3109
|
serialize(serializer: Serializer): void;
|
|
3016
3110
|
static deserialize(deserializer: Deserializer): Ed25519Signature;
|
|
3111
|
+
static load(deserializer: Deserializer): Ed25519Signature;
|
|
3017
3112
|
}
|
|
3018
3113
|
|
|
3019
3114
|
/**
|
|
@@ -3131,6 +3226,8 @@ declare class MultiEd25519Signature extends Signature {
|
|
|
3131
3226
|
|
|
3132
3227
|
/**
|
|
3133
3228
|
* Represents the Secp256k1 ecdsa public key
|
|
3229
|
+
*
|
|
3230
|
+
* Secp256k1 authentication key is represented in the SDK as `AnyPublicKey`.
|
|
3134
3231
|
*/
|
|
3135
3232
|
declare class Secp256k1PublicKey extends PublicKey {
|
|
3136
3233
|
static readonly LENGTH: number;
|
|
@@ -3166,6 +3263,7 @@ declare class Secp256k1PublicKey extends PublicKey {
|
|
|
3166
3263
|
}): boolean;
|
|
3167
3264
|
serialize(serializer: Serializer): void;
|
|
3168
3265
|
static deserialize(deserializer: Deserializer): Secp256k1PublicKey;
|
|
3266
|
+
static load(deserializer: Deserializer): Secp256k1PublicKey;
|
|
3169
3267
|
}
|
|
3170
3268
|
/**
|
|
3171
3269
|
* A Secp256k1 ecdsa private key
|
|
@@ -3253,6 +3351,105 @@ declare class Secp256k1Signature extends Signature {
|
|
|
3253
3351
|
toString(): string;
|
|
3254
3352
|
serialize(serializer: Serializer): void;
|
|
3255
3353
|
static deserialize(deserializer: Deserializer): Secp256k1Signature;
|
|
3354
|
+
static load(deserializer: Deserializer): Secp256k1Signature;
|
|
3355
|
+
}
|
|
3356
|
+
|
|
3357
|
+
declare class AnySignature extends Signature {
|
|
3358
|
+
readonly signature: Signature;
|
|
3359
|
+
constructor(signature: Signature);
|
|
3360
|
+
/**
|
|
3361
|
+
* Get the public key in bytes (Uint8Array).
|
|
3362
|
+
*
|
|
3363
|
+
* @returns Uint8Array representation of the public key
|
|
3364
|
+
*/
|
|
3365
|
+
toUint8Array(): Uint8Array;
|
|
3366
|
+
/**
|
|
3367
|
+
* Get the public key as a hex string with the 0x prefix.
|
|
3368
|
+
*
|
|
3369
|
+
* @returns string representation of the public key
|
|
3370
|
+
*/
|
|
3371
|
+
toString(): string;
|
|
3372
|
+
serialize(serializer: Serializer): void;
|
|
3373
|
+
static deserialize(deserializer: Deserializer): AnySignature;
|
|
3374
|
+
}
|
|
3375
|
+
|
|
3376
|
+
/**
|
|
3377
|
+
* Represents any public key supported by Aptos.
|
|
3378
|
+
*
|
|
3379
|
+
* Since [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263) Aptos supports
|
|
3380
|
+
* `Legacy` and `Unified` authentication keys.
|
|
3381
|
+
*
|
|
3382
|
+
* Any unified authentication key is represented in the SDK as `AnyPublicKey`.
|
|
3383
|
+
*/
|
|
3384
|
+
declare class AnyPublicKey extends PublicKey {
|
|
3385
|
+
/**
|
|
3386
|
+
* Reference to the inner public key
|
|
3387
|
+
*/
|
|
3388
|
+
readonly publicKey: PublicKey;
|
|
3389
|
+
constructor(publicKey: PublicKey);
|
|
3390
|
+
/**
|
|
3391
|
+
* Get the public key in bytes (Uint8Array).
|
|
3392
|
+
*
|
|
3393
|
+
* @returns Uint8Array representation of the public key
|
|
3394
|
+
*/
|
|
3395
|
+
toUint8Array(): Uint8Array;
|
|
3396
|
+
/**
|
|
3397
|
+
* Get the public key as a hex string with the 0x prefix.
|
|
3398
|
+
*
|
|
3399
|
+
* @returns string representation of the public key
|
|
3400
|
+
*/
|
|
3401
|
+
toString(): string;
|
|
3402
|
+
/**
|
|
3403
|
+
* Verifies a signed data with a public key
|
|
3404
|
+
*
|
|
3405
|
+
* @param args.message message
|
|
3406
|
+
* @param args.signature The signature
|
|
3407
|
+
* @returns true if the signature is valid
|
|
3408
|
+
*/
|
|
3409
|
+
verifySignature(args: {
|
|
3410
|
+
message: HexInput;
|
|
3411
|
+
signature: AnySignature;
|
|
3412
|
+
}): boolean;
|
|
3413
|
+
serialize(serializer: Serializer): void;
|
|
3414
|
+
static deserialize(deserializer: Deserializer): AnyPublicKey;
|
|
3415
|
+
}
|
|
3416
|
+
|
|
3417
|
+
declare class MultiKey extends PublicKey {
|
|
3418
|
+
/**
|
|
3419
|
+
* List of any public keys
|
|
3420
|
+
*/
|
|
3421
|
+
readonly publicKeys: AnyPublicKey[];
|
|
3422
|
+
/**
|
|
3423
|
+
* The minimum number of valid signatures required, for the number of public keys specified
|
|
3424
|
+
*/
|
|
3425
|
+
readonly signaturesRequired: number;
|
|
3426
|
+
constructor(args: {
|
|
3427
|
+
publicKeys: PublicKey[];
|
|
3428
|
+
signaturesRequired: number;
|
|
3429
|
+
});
|
|
3430
|
+
toUint8Array(): Uint8Array;
|
|
3431
|
+
/**
|
|
3432
|
+
* Create a bitmap that holds the mapping from the original public keys
|
|
3433
|
+
* to the signatures passed in
|
|
3434
|
+
*
|
|
3435
|
+
* @param args.bits array of the index mapping to the matching public keys
|
|
3436
|
+
* @returns Uint8array bit map
|
|
3437
|
+
*/
|
|
3438
|
+
createBitmap(args: {
|
|
3439
|
+
bits: number[];
|
|
3440
|
+
}): Uint8Array;
|
|
3441
|
+
/**
|
|
3442
|
+
* Hex string representation the multi key bytes
|
|
3443
|
+
*
|
|
3444
|
+
* @returns string
|
|
3445
|
+
*/
|
|
3446
|
+
toString(): string;
|
|
3447
|
+
verifySignature(args: {
|
|
3448
|
+
message: HexInput;
|
|
3449
|
+
signature: AnySignature;
|
|
3450
|
+
}): boolean;
|
|
3451
|
+
serialize(serializer: Serializer): void;
|
|
3452
|
+
static deserialize(deserializer: Deserializer): MultiKey;
|
|
3256
3453
|
}
|
|
3257
3454
|
|
|
3258
3455
|
/**
|
|
@@ -3351,8 +3548,10 @@ declare class Account {
|
|
|
3351
3548
|
options?: PaginationArgs & LedgerVersion;
|
|
3352
3549
|
}): Promise<MoveResource[]>;
|
|
3353
3550
|
/**
|
|
3354
|
-
* Queries a specific account resource given account address and resource type
|
|
3551
|
+
* Queries a specific account resource given account address and resource type. Note that the default is `any` in order
|
|
3552
|
+
* to allow for ease of accessing properties of the object.
|
|
3355
3553
|
*
|
|
3554
|
+
* @type The typed output of the resource
|
|
3356
3555
|
* @param args.accountAddress Aptos account address
|
|
3357
3556
|
* @param args.resourceType String representation of an on-chain Move struct type, i.e "0x1::aptos_coin::AptosCoin"
|
|
3358
3557
|
* @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
|
|
@@ -3362,16 +3561,15 @@ declare class Account {
|
|
|
3362
3561
|
* @example An example of an account resource
|
|
3363
3562
|
* ```
|
|
3364
3563
|
* {
|
|
3365
|
-
* type: "0x1::aptos_coin::AptosCoin",
|
|
3366
3564
|
* data: { value: 6 }
|
|
3367
3565
|
* }
|
|
3368
3566
|
* ```
|
|
3369
3567
|
*/
|
|
3370
|
-
getAccountResource(args: {
|
|
3568
|
+
getAccountResource<T extends {} = any>(args: {
|
|
3371
3569
|
accountAddress: HexInput;
|
|
3372
|
-
resourceType:
|
|
3570
|
+
resourceType: MoveStructType;
|
|
3373
3571
|
options?: LedgerVersion;
|
|
3374
|
-
}): Promise<
|
|
3572
|
+
}): Promise<T>;
|
|
3375
3573
|
/**
|
|
3376
3574
|
* Looks up the account address for a given authentication key
|
|
3377
3575
|
*
|
|
@@ -3509,6 +3707,23 @@ declare class Account {
|
|
|
3509
3707
|
orderBy?: OrderBy<GetAccountOwnedObjectsResponse[0]>;
|
|
3510
3708
|
};
|
|
3511
3709
|
}): Promise<GetAccountOwnedObjectsResponse>;
|
|
3710
|
+
/**
|
|
3711
|
+
* Derives an account by providing a private key.
|
|
3712
|
+
* This functions resolves the provided private key type and derives the public key from it.
|
|
3713
|
+
*
|
|
3714
|
+
* If the privateKey is a Secp256k1 type, it derives the account using the derived public key and
|
|
3715
|
+
* auth key using the SingleKey scheme locally.
|
|
3716
|
+
*
|
|
3717
|
+
* If the privateKey is a ED25519 type, it looks up the authentication key on chain, and uses it to resolve
|
|
3718
|
+
* whether it is a Legacy ED25519 key or a Unified ED25519 key. It then derives the account based
|
|
3719
|
+
* on that.
|
|
3720
|
+
*
|
|
3721
|
+
* @param args.privateKey An account private key
|
|
3722
|
+
* @returns Account type
|
|
3723
|
+
*/
|
|
3724
|
+
deriveAccountFromPrivateKey(args: {
|
|
3725
|
+
privateKey: PrivateKey;
|
|
3726
|
+
}): Promise<Account$1>;
|
|
3512
3727
|
}
|
|
3513
3728
|
|
|
3514
3729
|
/**
|
|
@@ -3559,65 +3774,101 @@ declare class ModuleId extends Serializable {
|
|
|
3559
3774
|
declare abstract class TypeTag extends Serializable {
|
|
3560
3775
|
abstract serialize(serializer: Serializer): void;
|
|
3561
3776
|
static deserialize(deserializer: Deserializer): TypeTag;
|
|
3777
|
+
abstract toString(): string;
|
|
3778
|
+
isBool(): this is TypeTagBool;
|
|
3779
|
+
isAddress(): this is TypeTagAddress;
|
|
3780
|
+
isGeneric(): this is TypeTagGeneric;
|
|
3781
|
+
isSigner(): this is TypeTagSigner;
|
|
3782
|
+
isVector(): this is TypeTagVector;
|
|
3783
|
+
isStruct(): this is TypeTagStruct;
|
|
3784
|
+
isU8(): this is TypeTagU8;
|
|
3785
|
+
isU16(): this is TypeTagU16;
|
|
3786
|
+
isU32(): this is TypeTagU32;
|
|
3787
|
+
isU64(): this is TypeTagU64;
|
|
3788
|
+
isU128(): this is TypeTagU128;
|
|
3789
|
+
isU256(): this is TypeTagU256;
|
|
3562
3790
|
}
|
|
3563
3791
|
declare class TypeTagBool extends TypeTag {
|
|
3792
|
+
toString(): string;
|
|
3564
3793
|
serialize(serializer: Serializer): void;
|
|
3565
3794
|
static load(_deserializer: Deserializer): TypeTagBool;
|
|
3566
3795
|
}
|
|
3567
3796
|
declare class TypeTagU8 extends TypeTag {
|
|
3797
|
+
toString(): string;
|
|
3568
3798
|
serialize(serializer: Serializer): void;
|
|
3569
3799
|
static load(_deserializer: Deserializer): TypeTagU8;
|
|
3570
3800
|
}
|
|
3571
3801
|
declare class TypeTagU16 extends TypeTag {
|
|
3802
|
+
toString(): string;
|
|
3572
3803
|
serialize(serializer: Serializer): void;
|
|
3573
3804
|
static load(_deserializer: Deserializer): TypeTagU16;
|
|
3574
3805
|
}
|
|
3575
3806
|
declare class TypeTagU32 extends TypeTag {
|
|
3807
|
+
toString(): string;
|
|
3576
3808
|
serialize(serializer: Serializer): void;
|
|
3577
3809
|
static load(_deserializer: Deserializer): TypeTagU32;
|
|
3578
3810
|
}
|
|
3579
3811
|
declare class TypeTagU64 extends TypeTag {
|
|
3812
|
+
toString(): string;
|
|
3580
3813
|
serialize(serializer: Serializer): void;
|
|
3581
3814
|
static load(_deserializer: Deserializer): TypeTagU64;
|
|
3582
3815
|
}
|
|
3583
3816
|
declare class TypeTagU128 extends TypeTag {
|
|
3817
|
+
toString(): string;
|
|
3584
3818
|
serialize(serializer: Serializer): void;
|
|
3585
3819
|
static load(_deserializer: Deserializer): TypeTagU128;
|
|
3586
3820
|
}
|
|
3587
3821
|
declare class TypeTagU256 extends TypeTag {
|
|
3822
|
+
toString(): string;
|
|
3588
3823
|
serialize(serializer: Serializer): void;
|
|
3589
3824
|
static load(_deserializer: Deserializer): TypeTagU256;
|
|
3590
3825
|
}
|
|
3591
3826
|
declare class TypeTagAddress extends TypeTag {
|
|
3827
|
+
toString(): string;
|
|
3592
3828
|
serialize(serializer: Serializer): void;
|
|
3593
3829
|
static load(_deserializer: Deserializer): TypeTagAddress;
|
|
3594
3830
|
}
|
|
3595
3831
|
declare class TypeTagSigner extends TypeTag {
|
|
3832
|
+
toString(): string;
|
|
3596
3833
|
serialize(serializer: Serializer): void;
|
|
3597
3834
|
static load(_deserializer: Deserializer): TypeTagSigner;
|
|
3598
3835
|
}
|
|
3836
|
+
declare class TypeTagReference extends TypeTag {
|
|
3837
|
+
readonly value: TypeTag;
|
|
3838
|
+
toString(): `&${string}`;
|
|
3839
|
+
constructor(value: TypeTag);
|
|
3840
|
+
serialize(serializer: Serializer): void;
|
|
3841
|
+
static load(deserializer: Deserializer): TypeTagReference;
|
|
3842
|
+
}
|
|
3843
|
+
/**
|
|
3844
|
+
* Generics are used for type parameters in entry functions. However,
|
|
3845
|
+
* they are not actually serialized into a real type, so they cannot be
|
|
3846
|
+
* used as a type directly.
|
|
3847
|
+
*/
|
|
3848
|
+
declare class TypeTagGeneric extends TypeTag {
|
|
3849
|
+
readonly value: number;
|
|
3850
|
+
toString(): `T${number}`;
|
|
3851
|
+
constructor(value: number);
|
|
3852
|
+
serialize(serializer: Serializer): void;
|
|
3853
|
+
static load(deserializer: Deserializer): TypeTagGeneric;
|
|
3854
|
+
}
|
|
3599
3855
|
declare class TypeTagVector extends TypeTag {
|
|
3600
3856
|
readonly value: TypeTag;
|
|
3857
|
+
toString(): `vector<${string}>`;
|
|
3601
3858
|
constructor(value: TypeTag);
|
|
3602
3859
|
serialize(serializer: Serializer): void;
|
|
3603
3860
|
static load(deserializer: Deserializer): TypeTagVector;
|
|
3604
3861
|
}
|
|
3605
3862
|
declare class TypeTagStruct extends TypeTag {
|
|
3606
3863
|
readonly value: StructTag;
|
|
3864
|
+
toString(): `0x${string}::${string}::${string}`;
|
|
3607
3865
|
constructor(value: StructTag);
|
|
3608
3866
|
serialize(serializer: Serializer): void;
|
|
3609
3867
|
static load(deserializer: Deserializer): TypeTagStruct;
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
|
|
3613
|
-
|
|
3614
|
-
* - address: 0x1
|
|
3615
|
-
* - module_name: "string"
|
|
3616
|
-
* - name: "String"
|
|
3617
|
-
*
|
|
3618
|
-
* @returns true if the StructTag is a String type tag, false otherwise
|
|
3619
|
-
*/
|
|
3620
|
-
isStringTypeTag(): boolean;
|
|
3868
|
+
isTypeTag(address: AccountAddress, moduleName: string, structName: string): boolean;
|
|
3869
|
+
isString(): boolean;
|
|
3870
|
+
isOption(): boolean;
|
|
3871
|
+
isObject(): boolean;
|
|
3621
3872
|
}
|
|
3622
3873
|
declare class StructTag extends Serializable {
|
|
3623
3874
|
readonly address: AccountAddress;
|
|
@@ -3625,46 +3876,23 @@ declare class StructTag extends Serializable {
|
|
|
3625
3876
|
readonly name: Identifier;
|
|
3626
3877
|
readonly type_args: Array<TypeTag>;
|
|
3627
3878
|
constructor(address: AccountAddress, module_name: Identifier, name: Identifier, type_args: Array<TypeTag>);
|
|
3628
|
-
/**
|
|
3629
|
-
* Converts a string literal to a StructTag
|
|
3630
|
-
* @param structTag String literal in format "AccountAddress::module_name::ResourceName",
|
|
3631
|
-
* e.g. "0x1::aptos_coin::AptosCoin"
|
|
3632
|
-
* @returns
|
|
3633
|
-
*/
|
|
3634
|
-
static fromString(structTag: string): StructTag;
|
|
3635
3879
|
serialize(serializer: Serializer): void;
|
|
3636
3880
|
static deserialize(deserializer: Deserializer): StructTag;
|
|
3637
3881
|
}
|
|
3638
|
-
declare
|
|
3882
|
+
declare function aptosCoinStructTag(): StructTag;
|
|
3883
|
+
declare function stringStructTag(): StructTag;
|
|
3639
3884
|
declare function optionStructTag(typeArg: TypeTag): StructTag;
|
|
3640
3885
|
declare function objectStructTag(typeArg: TypeTag): StructTag;
|
|
3886
|
+
|
|
3641
3887
|
/**
|
|
3642
|
-
*
|
|
3888
|
+
* Deserialize a Script Transaction Argument
|
|
3643
3889
|
*/
|
|
3644
|
-
declare
|
|
3645
|
-
private readonly tokens;
|
|
3646
|
-
private readonly typeTags;
|
|
3647
|
-
constructor(tagStr: string, typeTags?: string[]);
|
|
3648
|
-
private consume;
|
|
3649
|
-
/**
|
|
3650
|
-
* Consumes all of an unused generic field, mostly applicable to object
|
|
3651
|
-
*
|
|
3652
|
-
* Note: This is recursive. it can be problematic if there's bad input
|
|
3653
|
-
* @private
|
|
3654
|
-
*/
|
|
3655
|
-
private consumeWholeGeneric;
|
|
3656
|
-
private parseCommaList;
|
|
3657
|
-
parseTypeTag(): TypeTag;
|
|
3658
|
-
}
|
|
3659
|
-
declare class TypeTagParserError extends Error {
|
|
3660
|
-
constructor(message: string);
|
|
3661
|
-
}
|
|
3662
|
-
|
|
3890
|
+
declare function deserializeFromScriptArgument(deserializer: Deserializer): TransactionArgument;
|
|
3663
3891
|
/**
|
|
3664
3892
|
* Representation of the supported Transaction Payload
|
|
3665
3893
|
* that can serialized and deserialized
|
|
3666
3894
|
*/
|
|
3667
|
-
declare abstract class TransactionPayload
|
|
3895
|
+
declare abstract class TransactionPayload extends Serializable {
|
|
3668
3896
|
/**
|
|
3669
3897
|
* Serialize a Transaction Payload
|
|
3670
3898
|
*/
|
|
@@ -3672,12 +3900,12 @@ declare abstract class TransactionPayload$1 extends Serializable {
|
|
|
3672
3900
|
/**
|
|
3673
3901
|
* Deserialize a Transaction Payload
|
|
3674
3902
|
*/
|
|
3675
|
-
static deserialize(deserializer: Deserializer): TransactionPayload
|
|
3903
|
+
static deserialize(deserializer: Deserializer): TransactionPayload;
|
|
3676
3904
|
}
|
|
3677
3905
|
/**
|
|
3678
3906
|
* Representation of a Transaction Payload Script that can serialized and deserialized
|
|
3679
3907
|
*/
|
|
3680
|
-
declare class TransactionPayloadScript extends TransactionPayload
|
|
3908
|
+
declare class TransactionPayloadScript extends TransactionPayload {
|
|
3681
3909
|
readonly script: Script;
|
|
3682
3910
|
constructor(script: Script);
|
|
3683
3911
|
serialize(serializer: Serializer): void;
|
|
@@ -3686,7 +3914,7 @@ declare class TransactionPayloadScript extends TransactionPayload$1 {
|
|
|
3686
3914
|
/**
|
|
3687
3915
|
* Representation of a Transaction Payload Entry Function that can serialized and deserialized
|
|
3688
3916
|
*/
|
|
3689
|
-
declare class TransactionPayloadEntryFunction extends TransactionPayload
|
|
3917
|
+
declare class TransactionPayloadEntryFunction extends TransactionPayload {
|
|
3690
3918
|
readonly entryFunction: EntryFunction;
|
|
3691
3919
|
constructor(entryFunction: EntryFunction);
|
|
3692
3920
|
serialize(serializer: Serializer): void;
|
|
@@ -3695,7 +3923,7 @@ declare class TransactionPayloadEntryFunction extends TransactionPayload$1 {
|
|
|
3695
3923
|
/**
|
|
3696
3924
|
* Representation of a Transaction Payload Multi-sig that can serialized and deserialized
|
|
3697
3925
|
*/
|
|
3698
|
-
declare class TransactionPayloadMultisig extends TransactionPayload
|
|
3926
|
+
declare class TransactionPayloadMultisig extends TransactionPayload {
|
|
3699
3927
|
readonly multiSig: MultiSig;
|
|
3700
3928
|
constructor(multiSig: MultiSig);
|
|
3701
3929
|
serialize(serializer: Serializer): void;
|
|
@@ -3816,7 +4044,7 @@ declare class Script {
|
|
|
3816
4044
|
*/
|
|
3817
4045
|
declare class MultiSig {
|
|
3818
4046
|
readonly multisig_address: AccountAddress;
|
|
3819
|
-
readonly transaction_payload?:
|
|
4047
|
+
readonly transaction_payload?: MultisigTransactionPayload;
|
|
3820
4048
|
/**
|
|
3821
4049
|
* Contains the payload to run a multi-sig account transaction.
|
|
3822
4050
|
*
|
|
@@ -3825,14 +4053,19 @@ declare class MultiSig {
|
|
|
3825
4053
|
* @param transaction_payload The payload of the multi-sig transaction. This is optional when executing a multi-sig
|
|
3826
4054
|
* transaction whose payload is already stored on chain.
|
|
3827
4055
|
*/
|
|
3828
|
-
constructor(multisig_address: AccountAddress, transaction_payload?:
|
|
4056
|
+
constructor(multisig_address: AccountAddress, transaction_payload?: MultisigTransactionPayload);
|
|
3829
4057
|
serialize(serializer: Serializer): void;
|
|
3830
4058
|
static deserialize(deserializer: Deserializer): MultiSig;
|
|
3831
4059
|
}
|
|
3832
4060
|
/**
|
|
3833
|
-
* Representation of a MultiSig Transaction Payload
|
|
4061
|
+
* Representation of a MultiSig Transaction Payload from `multisig_account.move`
|
|
4062
|
+
* that can be serialized and deserialized
|
|
4063
|
+
|
|
4064
|
+
* This class exists right now to represent an extensible transaction payload class for
|
|
4065
|
+
* transactions used in `multisig_account.move`. Eventually, this class will be able to
|
|
4066
|
+
* support script payloads when the `multisig_account.move` module supports them.
|
|
3834
4067
|
*/
|
|
3835
|
-
declare class
|
|
4068
|
+
declare class MultisigTransactionPayload {
|
|
3836
4069
|
readonly transaction_payload: EntryFunction;
|
|
3837
4070
|
/**
|
|
3838
4071
|
* Contains the payload to run a multi-sig account transaction.
|
|
@@ -3843,7 +4076,7 @@ declare class MultiSigTransactionPayload {
|
|
|
3843
4076
|
*/
|
|
3844
4077
|
constructor(transaction_payload: EntryFunction);
|
|
3845
4078
|
serialize(serializer: Serializer): void;
|
|
3846
|
-
static deserialize(deserializer: Deserializer):
|
|
4079
|
+
static deserialize(deserializer: Deserializer): MultisigTransactionPayload;
|
|
3847
4080
|
}
|
|
3848
4081
|
|
|
3849
4082
|
/**
|
|
@@ -3852,7 +4085,7 @@ declare class MultiSigTransactionPayload {
|
|
|
3852
4085
|
declare class RawTransaction extends Serializable {
|
|
3853
4086
|
readonly sender: AccountAddress;
|
|
3854
4087
|
readonly sequence_number: bigint;
|
|
3855
|
-
readonly payload: TransactionPayload
|
|
4088
|
+
readonly payload: TransactionPayload;
|
|
3856
4089
|
readonly max_gas_amount: bigint;
|
|
3857
4090
|
readonly gas_unit_price: bigint;
|
|
3858
4091
|
readonly expiration_timestamp_secs: bigint;
|
|
@@ -3872,7 +4105,7 @@ declare class RawTransaction extends Serializable {
|
|
|
3872
4105
|
* @param expiration_timestamp_secs The blockchain timestamp at which the blockchain would discard this transaction.
|
|
3873
4106
|
* @param chain_id The chain ID of the blockchain that this transaction is intended to be run on.
|
|
3874
4107
|
*/
|
|
3875
|
-
constructor(sender: AccountAddress, sequence_number: bigint, payload: TransactionPayload
|
|
4108
|
+
constructor(sender: AccountAddress, sequence_number: bigint, payload: TransactionPayload, max_gas_amount: bigint, gas_unit_price: bigint, expiration_timestamp_secs: bigint, chain_id: ChainId);
|
|
3876
4109
|
serialize(serializer: Serializer): void;
|
|
3877
4110
|
static deserialize(deserializer: Deserializer): RawTransaction;
|
|
3878
4111
|
}
|
|
@@ -3926,8 +4159,184 @@ declare class FeePayerRawTransaction extends RawTransactionWithData {
|
|
|
3926
4159
|
static load(deserializer: Deserializer): FeePayerRawTransaction;
|
|
3927
4160
|
}
|
|
3928
4161
|
|
|
3929
|
-
declare
|
|
3930
|
-
|
|
4162
|
+
declare abstract class AccountAuthenticator extends Serializable {
|
|
4163
|
+
abstract serialize(serializer: Serializer): void;
|
|
4164
|
+
static deserialize(deserializer: Deserializer): AccountAuthenticator;
|
|
4165
|
+
}
|
|
4166
|
+
/**
|
|
4167
|
+
* Transaction authenticator Ed25519 for a multi signer transaction
|
|
4168
|
+
*
|
|
4169
|
+
* @param public_key Account's Ed25519 public key.
|
|
4170
|
+
* @param signature Account's Ed25519 signature
|
|
4171
|
+
*
|
|
4172
|
+
*/
|
|
4173
|
+
declare class AccountAuthenticatorEd25519 extends AccountAuthenticator {
|
|
4174
|
+
readonly public_key: Ed25519PublicKey;
|
|
4175
|
+
readonly signature: Ed25519Signature;
|
|
4176
|
+
constructor(public_key: Ed25519PublicKey, signature: Ed25519Signature);
|
|
4177
|
+
serialize(serializer: Serializer): void;
|
|
4178
|
+
static load(deserializer: Deserializer): AccountAuthenticatorEd25519;
|
|
4179
|
+
}
|
|
4180
|
+
/**
|
|
4181
|
+
* Transaction authenticator Multi Ed25519 for a multi signers transaction
|
|
4182
|
+
*
|
|
4183
|
+
* @param public_key Account's MultiEd25519 public key.
|
|
4184
|
+
* @param signature Account's MultiEd25519 signature
|
|
4185
|
+
*
|
|
4186
|
+
*/
|
|
4187
|
+
declare class AccountAuthenticatorMultiEd25519 extends AccountAuthenticator {
|
|
4188
|
+
readonly public_key: MultiEd25519PublicKey;
|
|
4189
|
+
readonly signature: MultiEd25519Signature;
|
|
4190
|
+
constructor(public_key: MultiEd25519PublicKey, signature: MultiEd25519Signature);
|
|
4191
|
+
serialize(serializer: Serializer): void;
|
|
4192
|
+
static load(deserializer: Deserializer): AccountAuthenticatorMultiEd25519;
|
|
4193
|
+
}
|
|
4194
|
+
/**
|
|
4195
|
+
* AccountAuthenticatorSingleKey for a single signer
|
|
4196
|
+
*
|
|
4197
|
+
* @param public_key AnyPublicKey
|
|
4198
|
+
* @param signature AnySignature
|
|
4199
|
+
*
|
|
4200
|
+
*/
|
|
4201
|
+
declare class AccountAuthenticatorSingleKey extends AccountAuthenticator {
|
|
4202
|
+
readonly public_key: AnyPublicKey;
|
|
4203
|
+
readonly signature: AnySignature;
|
|
4204
|
+
constructor(public_key: AnyPublicKey, signature: AnySignature);
|
|
4205
|
+
serialize(serializer: Serializer): void;
|
|
4206
|
+
static load(deserializer: Deserializer): AccountAuthenticatorSingleKey;
|
|
4207
|
+
}
|
|
4208
|
+
/**
|
|
4209
|
+
* AccountAuthenticatorMultiKey for a multi signer
|
|
4210
|
+
*
|
|
4211
|
+
* @param public_keys MultiKey
|
|
4212
|
+
* @param signatures Signature
|
|
4213
|
+
*
|
|
4214
|
+
*/
|
|
4215
|
+
declare class AccountAuthenticatorMultiKey extends AccountAuthenticator {
|
|
4216
|
+
readonly public_keys: MultiKey;
|
|
4217
|
+
readonly signatures: Array<AnySignature>;
|
|
4218
|
+
readonly signatures_bitmap: Uint8Array;
|
|
4219
|
+
constructor(public_keys: MultiKey, signatures: Array<AnySignature>, signatures_bitmap: Uint8Array);
|
|
4220
|
+
serialize(serializer: Serializer): void;
|
|
4221
|
+
static load(deserializer: Deserializer): AccountAuthenticatorMultiKey;
|
|
4222
|
+
}
|
|
4223
|
+
|
|
4224
|
+
declare abstract class TransactionAuthenticator extends Serializable {
|
|
4225
|
+
abstract serialize(serializer: Serializer): void;
|
|
4226
|
+
static deserialize(deserializer: Deserializer): TransactionAuthenticator;
|
|
4227
|
+
}
|
|
4228
|
+
/**
|
|
4229
|
+
* Transaction authenticator Ed25519 for a single signer transaction
|
|
4230
|
+
*
|
|
4231
|
+
* @param public_key Client's public key.
|
|
4232
|
+
* @param signature Ed25519 signature of a raw transaction.
|
|
4233
|
+
* @see {@link https://aptos.dev/integration/creating-a-signed-transaction | Creating a Signed Transaction}
|
|
4234
|
+
* for details about generating a signature.
|
|
4235
|
+
*/
|
|
4236
|
+
declare class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
|
|
4237
|
+
readonly public_key: Ed25519PublicKey;
|
|
4238
|
+
readonly signature: Ed25519Signature;
|
|
4239
|
+
constructor(public_key: Ed25519PublicKey, signature: Ed25519Signature);
|
|
4240
|
+
serialize(serializer: Serializer): void;
|
|
4241
|
+
static load(deserializer: Deserializer): TransactionAuthenticatorEd25519;
|
|
4242
|
+
}
|
|
4243
|
+
/**
|
|
4244
|
+
* Transaction authenticator Ed25519 for a multi signers transaction
|
|
4245
|
+
*
|
|
4246
|
+
* @param public_key Client's public key.
|
|
4247
|
+
* @param signature Multi Ed25519 signature of a raw transaction.
|
|
4248
|
+
*
|
|
4249
|
+
*/
|
|
4250
|
+
declare class TransactionAuthenticatorMultiEd25519 extends TransactionAuthenticator {
|
|
4251
|
+
readonly public_key: MultiEd25519PublicKey;
|
|
4252
|
+
readonly signature: MultiEd25519Signature;
|
|
4253
|
+
constructor(public_key: MultiEd25519PublicKey, signature: MultiEd25519Signature);
|
|
4254
|
+
serialize(serializer: Serializer): void;
|
|
4255
|
+
static load(deserializer: Deserializer): TransactionAuthenticatorMultiEd25519;
|
|
4256
|
+
}
|
|
4257
|
+
/**
|
|
4258
|
+
* Transaction authenticator for a multi-agent transaction
|
|
4259
|
+
*
|
|
4260
|
+
* @param sender Sender account authenticator
|
|
4261
|
+
* @param secondary_signer_addresses Secondary signers address
|
|
4262
|
+
* @param secondary_signers Secondary signers account authenticators
|
|
4263
|
+
*
|
|
4264
|
+
*/
|
|
4265
|
+
declare class TransactionAuthenticatorMultiAgent extends TransactionAuthenticator {
|
|
4266
|
+
readonly sender: AccountAuthenticator;
|
|
4267
|
+
readonly secondary_signer_addresses: Array<AccountAddress>;
|
|
4268
|
+
readonly secondary_signers: Array<AccountAuthenticator>;
|
|
4269
|
+
constructor(sender: AccountAuthenticator, secondary_signer_addresses: Array<AccountAddress>, secondary_signers: Array<AccountAuthenticator>);
|
|
4270
|
+
serialize(serializer: Serializer): void;
|
|
4271
|
+
static load(deserializer: Deserializer): TransactionAuthenticatorMultiAgent;
|
|
4272
|
+
}
|
|
4273
|
+
/**
|
|
4274
|
+
* Transaction authenticator for a fee payer transaction
|
|
4275
|
+
*
|
|
4276
|
+
* @param sender Sender account authenticator
|
|
4277
|
+
* @param secondary_signer_addresses Secondary signers address
|
|
4278
|
+
* @param secondary_signers Secondary signers account authenticators
|
|
4279
|
+
* @param fee_payer Object of the fee payer account address and the fee payer authentication
|
|
4280
|
+
*
|
|
4281
|
+
*/
|
|
4282
|
+
declare class TransactionAuthenticatorFeePayer extends TransactionAuthenticator {
|
|
4283
|
+
readonly sender: AccountAuthenticator;
|
|
4284
|
+
readonly secondary_signer_addresses: Array<AccountAddress>;
|
|
4285
|
+
readonly secondary_signers: Array<AccountAuthenticator>;
|
|
4286
|
+
readonly fee_payer: {
|
|
4287
|
+
address: AccountAddress;
|
|
4288
|
+
authenticator: AccountAuthenticator;
|
|
4289
|
+
};
|
|
4290
|
+
constructor(sender: AccountAuthenticator, secondary_signer_addresses: Array<AccountAddress>, secondary_signers: Array<AccountAuthenticator>, fee_payer: {
|
|
4291
|
+
address: AccountAddress;
|
|
4292
|
+
authenticator: AccountAuthenticator;
|
|
4293
|
+
});
|
|
4294
|
+
serialize(serializer: Serializer): void;
|
|
4295
|
+
static load(deserializer: Deserializer): TransactionAuthenticatorMultiAgent;
|
|
4296
|
+
}
|
|
4297
|
+
/**
|
|
4298
|
+
* Single Sender authenticator for a single signer transaction
|
|
4299
|
+
*
|
|
4300
|
+
* @param sender AccountAuthenticator
|
|
4301
|
+
*/
|
|
4302
|
+
declare class TransactionAuthenticatorSingleSender extends TransactionAuthenticator {
|
|
4303
|
+
readonly sender: AccountAuthenticator;
|
|
4304
|
+
constructor(sender: AccountAuthenticator);
|
|
4305
|
+
serialize(serializer: Serializer): void;
|
|
4306
|
+
static load(deserializer: Deserializer): TransactionAuthenticatorSingleSender;
|
|
4307
|
+
}
|
|
4308
|
+
|
|
4309
|
+
declare class SignedTransaction extends Serializable {
|
|
4310
|
+
readonly raw_txn: RawTransaction;
|
|
4311
|
+
readonly authenticator: TransactionAuthenticator;
|
|
4312
|
+
/**
|
|
4313
|
+
* A SignedTransaction consists of a raw transaction and an authenticator. The authenticator
|
|
4314
|
+
* contains a client's public key and the signature of the raw transaction.
|
|
4315
|
+
*
|
|
4316
|
+
* @see {@link https://aptos.dev/integration/creating-a-signed-transaction | Creating a Signed Transaction}
|
|
4317
|
+
*
|
|
4318
|
+
* @param raw_txn
|
|
4319
|
+
* @param authenticator Contains a client's public key and the signature of the raw transaction.
|
|
4320
|
+
* Authenticator has 3 flavors: single signature, multi-signature and multi-agent.
|
|
4321
|
+
* @see {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs} for details.
|
|
4322
|
+
*/
|
|
4323
|
+
constructor(raw_txn: RawTransaction, authenticator: TransactionAuthenticator);
|
|
4324
|
+
serialize(serializer: Serializer): void;
|
|
4325
|
+
static deserialize(deserializer: Deserializer): SignedTransaction;
|
|
4326
|
+
}
|
|
4327
|
+
|
|
4328
|
+
/**
|
|
4329
|
+
* Entry function arguments to be used when building a raw transaction using remote ABI
|
|
4330
|
+
*/
|
|
4331
|
+
declare type SimpleEntryFunctionArgumentTypes = boolean | number | bigint | string | null | undefined | Uint8Array | Array<SimpleEntryFunctionArgumentTypes>;
|
|
4332
|
+
/**
|
|
4333
|
+
* Entry function arguments to be used when building a raw transaction using BCS serialized arguments
|
|
4334
|
+
*/
|
|
4335
|
+
declare type EntryFunctionArgumentTypes = Bool | U8 | U16 | U32 | U64 | U128 | U256 | AccountAddress | MoveVector<EntryFunctionArgumentTypes> | MoveOption<EntryFunctionArgumentTypes> | MoveString | FixedBytes;
|
|
4336
|
+
/**
|
|
4337
|
+
* Script function arguments to be used when building a raw transaction using BCS serialized arguments
|
|
4338
|
+
*/
|
|
4339
|
+
declare type ScriptFunctionArgumentTypes = Bool | U8 | U16 | U32 | U64 | U128 | U256 | AccountAddress | MoveVector<U8> | MoveString | FixedBytes;
|
|
3931
4340
|
/**
|
|
3932
4341
|
* Type that holds all raw transaction instances Aptos SDK supports
|
|
3933
4342
|
*/
|
|
@@ -3935,7 +4344,7 @@ declare type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransacti
|
|
|
3935
4344
|
/**
|
|
3936
4345
|
* Optional options to set when generating a transaction
|
|
3937
4346
|
*/
|
|
3938
|
-
declare type
|
|
4347
|
+
declare type InputGenerateTransactionOptions = {
|
|
3939
4348
|
maxGasAmount?: AnyNumber;
|
|
3940
4349
|
gasUnitPrice?: AnyNumber;
|
|
3941
4350
|
expireTimestamp?: AnyNumber;
|
|
@@ -3944,80 +4353,101 @@ declare type GenerateTransactionOptions = {
|
|
|
3944
4353
|
/**
|
|
3945
4354
|
* The generated transaction payload type that was produces from `generateTransactionPayload()` function.
|
|
3946
4355
|
*/
|
|
3947
|
-
declare type
|
|
4356
|
+
declare type AnyTransactionPayloadInstance = TransactionPayloadEntryFunction | TransactionPayloadScript | TransactionPayloadMultisig;
|
|
3948
4357
|
/**
|
|
3949
4358
|
* Unified type for the data needed to generate a transaction payload of types:
|
|
3950
4359
|
* Entry Function | Script | Multi Sig
|
|
3951
4360
|
*/
|
|
3952
|
-
declare type
|
|
4361
|
+
declare type InputGenerateTransactionPayloadData = InputEntryFunctionData | InputScriptData | InputMultiSigData;
|
|
4362
|
+
declare type InputGenerateTransactionPayloadDataWithRemoteABI = (InputScriptData & {
|
|
4363
|
+
aptosConfig?: undefined;
|
|
4364
|
+
}) | InputEntryFunctionDataWithRemoteABI | InputMultiSigDataWithRemoteABI;
|
|
3953
4365
|
/**
|
|
3954
4366
|
* The data needed to generate an Entry Function payload
|
|
3955
4367
|
*/
|
|
3956
|
-
declare type
|
|
4368
|
+
declare type InputEntryFunctionData = {
|
|
3957
4369
|
function: MoveStructType;
|
|
3958
4370
|
typeArguments?: Array<TypeTag>;
|
|
3959
|
-
|
|
4371
|
+
functionArguments: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>;
|
|
4372
|
+
};
|
|
4373
|
+
declare type InputEntryFunctionDataWithRemoteABI = InputEntryFunctionData & {
|
|
4374
|
+
aptosConfig: AptosConfig;
|
|
3960
4375
|
};
|
|
3961
4376
|
/**
|
|
3962
4377
|
* The data needed to generate a Multi Sig payload
|
|
3963
4378
|
*/
|
|
3964
|
-
declare type
|
|
4379
|
+
declare type InputMultiSigData = {
|
|
3965
4380
|
multisigAddress: AccountAddress;
|
|
3966
|
-
} &
|
|
4381
|
+
} & InputEntryFunctionData;
|
|
4382
|
+
/**
|
|
4383
|
+
* The data needed to generate a Multi Sig payload
|
|
4384
|
+
*/
|
|
4385
|
+
declare type InputMultiSigDataWithRemoteABI = {
|
|
4386
|
+
multisigAddress: AccountAddress | string;
|
|
4387
|
+
} & InputEntryFunctionDataWithRemoteABI;
|
|
3967
4388
|
/**
|
|
3968
4389
|
* The data needed to generate a Script payload
|
|
3969
4390
|
*/
|
|
3970
|
-
declare type
|
|
4391
|
+
declare type InputScriptData = {
|
|
3971
4392
|
bytecode: HexInput;
|
|
3972
4393
|
typeArguments?: Array<TypeTag>;
|
|
3973
|
-
|
|
4394
|
+
functionArguments: Array<ScriptFunctionArgumentTypes>;
|
|
4395
|
+
};
|
|
4396
|
+
/**
|
|
4397
|
+
* Interface of an Entry function's ABI.
|
|
4398
|
+
*
|
|
4399
|
+
* This is used to provide type checking and simple input conversion on ABI based transaction submission.
|
|
4400
|
+
*/
|
|
4401
|
+
declare type EntryFunctionABI = {
|
|
4402
|
+
typeParameters: Array<MoveFunctionGenericTypeParam>;
|
|
4403
|
+
parameters: Array<TypeTag>;
|
|
3974
4404
|
};
|
|
3975
4405
|
/**
|
|
3976
4406
|
* Interface of the arguments to generate a single signer transaction.
|
|
3977
4407
|
* Used to provide to `generateTransaction()` method in the transaction builder flow
|
|
3978
4408
|
*/
|
|
3979
|
-
interface
|
|
4409
|
+
interface InputGenerateSingleSignerRawTransactionArgs {
|
|
3980
4410
|
aptosConfig: AptosConfig;
|
|
3981
4411
|
sender: HexInput;
|
|
3982
|
-
payload:
|
|
4412
|
+
payload: AnyTransactionPayloadInstance;
|
|
3983
4413
|
feePayerAddress?: undefined;
|
|
3984
4414
|
secondarySignerAddresses?: undefined;
|
|
3985
|
-
options?:
|
|
4415
|
+
options?: InputGenerateTransactionOptions;
|
|
3986
4416
|
}
|
|
3987
4417
|
/**
|
|
3988
4418
|
* Interface of the arguments to generate a fee payer transaction.
|
|
3989
4419
|
* Used to provide to `generateTransaction()` method in the transaction builder flow
|
|
3990
4420
|
*/
|
|
3991
|
-
interface
|
|
4421
|
+
interface InputGenerateFeePayerRawTransactionArgs {
|
|
3992
4422
|
aptosConfig: AptosConfig;
|
|
3993
4423
|
sender: HexInput;
|
|
3994
|
-
payload:
|
|
4424
|
+
payload: AnyTransactionPayloadInstance;
|
|
3995
4425
|
feePayerAddress: HexInput;
|
|
3996
4426
|
secondarySignerAddresses?: HexInput[];
|
|
3997
|
-
options?:
|
|
4427
|
+
options?: InputGenerateTransactionOptions;
|
|
3998
4428
|
}
|
|
3999
4429
|
/**
|
|
4000
4430
|
* Interface of the arguments to generate a multi-agent transaction.
|
|
4001
4431
|
* Used to provide to `generateTransaction()` method in the transaction builder flow
|
|
4002
4432
|
*/
|
|
4003
|
-
interface
|
|
4433
|
+
interface InputGenerateMultiAgentRawTransactionArgs {
|
|
4004
4434
|
aptosConfig: AptosConfig;
|
|
4005
4435
|
sender: HexInput;
|
|
4006
|
-
payload:
|
|
4436
|
+
payload: AnyTransactionPayloadInstance;
|
|
4007
4437
|
secondarySignerAddresses: HexInput[];
|
|
4008
4438
|
feePayerAddress?: undefined;
|
|
4009
|
-
options?:
|
|
4439
|
+
options?: InputGenerateTransactionOptions;
|
|
4010
4440
|
}
|
|
4011
4441
|
/**
|
|
4012
4442
|
* Unified type that holds all the interfaces to generate different transaction types
|
|
4013
4443
|
*/
|
|
4014
|
-
declare type
|
|
4444
|
+
declare type InputGenerateRawTransactionArgs = InputGenerateSingleSignerRawTransactionArgs | InputGenerateFeePayerRawTransactionArgs | InputGenerateMultiAgentRawTransactionArgs;
|
|
4015
4445
|
/**
|
|
4016
4446
|
* Interface that holds the return data when generating a single signer transaction
|
|
4017
4447
|
*
|
|
4018
4448
|
* @param rawTransaction a bcs serialized raw transaction
|
|
4019
4449
|
*/
|
|
4020
|
-
interface
|
|
4450
|
+
interface InputSingleSignerTransaction {
|
|
4021
4451
|
rawTransaction: Uint8Array;
|
|
4022
4452
|
feePayerAddress?: undefined;
|
|
4023
4453
|
secondarySignerAddresses?: undefined;
|
|
@@ -4029,7 +4459,7 @@ interface SingleSignerTransaction {
|
|
|
4029
4459
|
* @param secondarySignerAddresses optional. secondary signer addresses for multi-agent transaction
|
|
4030
4460
|
* @param feePayerAddress fee payer address for a fee payer transaction (aka Sponsored Transaction)
|
|
4031
4461
|
*/
|
|
4032
|
-
interface
|
|
4462
|
+
interface InputFeePayerTransaction {
|
|
4033
4463
|
rawTransaction: Uint8Array;
|
|
4034
4464
|
feePayerAddress: AccountAddress;
|
|
4035
4465
|
secondarySignerAddresses?: AccountAddress[];
|
|
@@ -4040,7 +4470,7 @@ interface FeePayerTransaction {
|
|
|
4040
4470
|
* @param rawTransaction a bcs serialized raw transaction
|
|
4041
4471
|
* @param secondarySignerAddresses secondary signer addresses for multi-agent transaction
|
|
4042
4472
|
*/
|
|
4043
|
-
interface
|
|
4473
|
+
interface InputMultiAgentTransaction {
|
|
4044
4474
|
rawTransaction: Uint8Array;
|
|
4045
4475
|
secondarySignerAddresses: AccountAddress[];
|
|
4046
4476
|
feePayerAddress?: undefined;
|
|
@@ -4048,8 +4478,8 @@ interface MultiAgentTransaction {
|
|
|
4048
4478
|
/**
|
|
4049
4479
|
* Unified type that holds all the return interfaces when generating different transaction types
|
|
4050
4480
|
*/
|
|
4051
|
-
declare type AnyRawTransaction =
|
|
4052
|
-
declare type
|
|
4481
|
+
declare type AnyRawTransaction = InputSingleSignerTransaction | InputFeePayerTransaction | InputMultiAgentTransaction;
|
|
4482
|
+
declare type InputSimulateTransactionData = {
|
|
4053
4483
|
/**
|
|
4054
4484
|
* The transaction to simulate, probably generated by `generateTransaction()`
|
|
4055
4485
|
*/
|
|
@@ -4066,9 +4496,9 @@ declare type SimulateTransactionData = {
|
|
|
4066
4496
|
* For a fee payer transaction (aka Sponsored Transaction)
|
|
4067
4497
|
*/
|
|
4068
4498
|
feePayerPublicKey?: PublicKey;
|
|
4069
|
-
options?:
|
|
4499
|
+
options?: InputSimulateTransactionOptions;
|
|
4070
4500
|
};
|
|
4071
|
-
declare type
|
|
4501
|
+
declare type InputSimulateTransactionOptions = {
|
|
4072
4502
|
estimateGasUnitPrice?: boolean;
|
|
4073
4503
|
estimateMaxGasAmount?: boolean;
|
|
4074
4504
|
estimatePrioritizedGasUnitPrice?: boolean;
|
|
@@ -4076,37 +4506,37 @@ declare type SimulateTransactionOptions = {
|
|
|
4076
4506
|
/**
|
|
4077
4507
|
* Interface that holds the user data input when generating a single signer transaction
|
|
4078
4508
|
*/
|
|
4079
|
-
interface
|
|
4509
|
+
interface InputGenerateSingleSignerRawTransactionData {
|
|
4080
4510
|
sender: HexInput;
|
|
4081
4511
|
feePayerAddress?: undefined;
|
|
4082
4512
|
secondarySignerAddresses?: undefined;
|
|
4083
|
-
options?:
|
|
4084
|
-
data:
|
|
4513
|
+
options?: InputGenerateTransactionOptions;
|
|
4514
|
+
data: InputGenerateTransactionPayloadData;
|
|
4085
4515
|
}
|
|
4086
4516
|
/**
|
|
4087
4517
|
* Interface that holds the user data input when generating a fee payer transaction
|
|
4088
4518
|
*/
|
|
4089
|
-
interface
|
|
4519
|
+
interface InputGenerateFeePayerRawTransactionData {
|
|
4090
4520
|
sender: HexInput;
|
|
4091
4521
|
feePayerAddress: HexInput;
|
|
4092
4522
|
secondarySignerAddresses?: HexInput[];
|
|
4093
|
-
options?:
|
|
4094
|
-
data:
|
|
4523
|
+
options?: InputGenerateTransactionOptions;
|
|
4524
|
+
data: InputGenerateTransactionPayloadData;
|
|
4095
4525
|
}
|
|
4096
4526
|
/**
|
|
4097
4527
|
* Interface that holds the user data input when generating a multi-agent transaction
|
|
4098
4528
|
*/
|
|
4099
|
-
interface
|
|
4529
|
+
interface InputGenerateMultiAgentRawTransactionData {
|
|
4100
4530
|
sender: HexInput;
|
|
4101
4531
|
secondarySignerAddresses: HexInput[];
|
|
4102
4532
|
feePayerAddress?: undefined;
|
|
4103
|
-
options?:
|
|
4104
|
-
data:
|
|
4533
|
+
options?: InputGenerateTransactionOptions;
|
|
4534
|
+
data: InputGenerateTransactionPayloadData;
|
|
4105
4535
|
}
|
|
4106
4536
|
/**
|
|
4107
4537
|
* Unified type that holds all the user data input interfaces when generating different transaction types
|
|
4108
4538
|
*/
|
|
4109
|
-
declare type
|
|
4539
|
+
declare type InputGenerateTransactionData = InputGenerateMultiAgentRawTransactionData | InputGenerateFeePayerRawTransactionData | InputGenerateSingleSignerRawTransactionData;
|
|
4110
4540
|
|
|
4111
4541
|
/**
|
|
4112
4542
|
* A class to handle all `Coin` operations
|
|
@@ -4128,9 +4558,9 @@ declare class Coin {
|
|
|
4128
4558
|
sender: Account$1;
|
|
4129
4559
|
recipient: HexInput;
|
|
4130
4560
|
amount: AnyNumber;
|
|
4131
|
-
coinType?:
|
|
4132
|
-
options?:
|
|
4133
|
-
}): Promise<
|
|
4561
|
+
coinType?: MoveStructType;
|
|
4562
|
+
options?: InputGenerateTransactionOptions;
|
|
4563
|
+
}): Promise<InputSingleSignerTransaction>;
|
|
4134
4564
|
}
|
|
4135
4565
|
|
|
4136
4566
|
/**
|
|
@@ -4191,8 +4621,8 @@ declare class DigitalAsset {
|
|
|
4191
4621
|
description: string;
|
|
4192
4622
|
name: string;
|
|
4193
4623
|
uri: string;
|
|
4194
|
-
options?:
|
|
4195
|
-
} & CreateCollectionOptions): Promise<
|
|
4624
|
+
options?: InputGenerateTransactionOptions;
|
|
4625
|
+
} & CreateCollectionOptions): Promise<InputSingleSignerTransaction>;
|
|
4196
4626
|
/**
|
|
4197
4627
|
* Queries data of a specific collection by the collection creator address and the collection name.
|
|
4198
4628
|
*
|
|
@@ -4246,8 +4676,8 @@ declare class DigitalAsset {
|
|
|
4246
4676
|
description: string;
|
|
4247
4677
|
name: string;
|
|
4248
4678
|
uri: string;
|
|
4249
|
-
options?:
|
|
4250
|
-
}): Promise<
|
|
4679
|
+
options?: InputGenerateTransactionOptions;
|
|
4680
|
+
}): Promise<InputSingleSignerTransaction>;
|
|
4251
4681
|
/**
|
|
4252
4682
|
* Gets token data given the address of a token.
|
|
4253
4683
|
*
|
|
@@ -4322,7 +4752,7 @@ declare class Event {
|
|
|
4322
4752
|
*/
|
|
4323
4753
|
getAccountEventsByEventType(args: {
|
|
4324
4754
|
accountAddress: HexInput;
|
|
4325
|
-
eventType:
|
|
4755
|
+
eventType: MoveStructType;
|
|
4326
4756
|
options?: {
|
|
4327
4757
|
pagination?: PaginationArgs;
|
|
4328
4758
|
orderBy?: OrderBy<GetEventsResponse[0]>;
|
|
@@ -4365,13 +4795,13 @@ declare class Faucet {
|
|
|
4365
4795
|
*
|
|
4366
4796
|
* @param args.accountAddress Address of the account to fund
|
|
4367
4797
|
* @param args.amount Amount of tokens to fund the account with
|
|
4368
|
-
* @param args.
|
|
4798
|
+
* @param args.options Configuration options for waitForTransaction
|
|
4369
4799
|
* @returns Transaction hash of the transaction that funded the account
|
|
4370
4800
|
*/
|
|
4371
4801
|
fundAccount(args: {
|
|
4372
4802
|
accountAddress: HexInput;
|
|
4373
4803
|
amount: number;
|
|
4374
|
-
|
|
4804
|
+
options?: WaitForTransactionOptions;
|
|
4375
4805
|
}): Promise<string>;
|
|
4376
4806
|
}
|
|
4377
4807
|
|
|
@@ -4395,6 +4825,19 @@ declare class FungibleAsset {
|
|
|
4395
4825
|
where?: FungibleAssetMetadataBoolExp;
|
|
4396
4826
|
};
|
|
4397
4827
|
}): Promise<GetFungibleAssetMetadataResponse>;
|
|
4828
|
+
/**
|
|
4829
|
+
* Queries the current specific fungible asset metadata
|
|
4830
|
+
*
|
|
4831
|
+
* This query returns the fungible asset metadata for a specific fungible asset.
|
|
4832
|
+
*
|
|
4833
|
+
* @param assetType The asset type of the fungible asset.
|
|
4834
|
+
* e.g
|
|
4835
|
+
* "0x1::aptos_coin::AptosCoin" for Aptos Coin
|
|
4836
|
+
* "0xc2948283c2ce03aafbb294821de7ee684b06116bb378ab614fa2de07a99355a8" - address format if this is fungible asset
|
|
4837
|
+
*
|
|
4838
|
+
* @returns getFungibleAssetMetadata A fungible asset metadata item
|
|
4839
|
+
*/
|
|
4840
|
+
getFungibleAssetMetadataByAssetType(assetType: string): Promise<GetFungibleAssetMetadataResponse[0]>;
|
|
4398
4841
|
/**
|
|
4399
4842
|
* Queries the fungible asset activities
|
|
4400
4843
|
*
|
|
@@ -4515,8 +4958,8 @@ declare class General {
|
|
|
4515
4958
|
* `
|
|
4516
4959
|
* const payload: ViewRequest = {
|
|
4517
4960
|
* function: "0x1::coin::balance",
|
|
4518
|
-
*
|
|
4519
|
-
*
|
|
4961
|
+
* typeArguments: ["0x1::aptos_coin::AptosCoin"],
|
|
4962
|
+
* functionArguments: [accountAddress],
|
|
4520
4963
|
* };
|
|
4521
4964
|
* `
|
|
4522
4965
|
*
|
|
@@ -4676,10 +5119,7 @@ declare class Transaction {
|
|
|
4676
5119
|
*/
|
|
4677
5120
|
waitForTransaction(args: {
|
|
4678
5121
|
transactionHash: HexInput;
|
|
4679
|
-
options?:
|
|
4680
|
-
timeoutSecs?: number;
|
|
4681
|
-
checkSuccess?: boolean;
|
|
4682
|
-
};
|
|
5122
|
+
options?: WaitForTransactionOptions;
|
|
4683
5123
|
}): Promise<TransactionResponse>;
|
|
4684
5124
|
/**
|
|
4685
5125
|
* Gives an estimate of the gas unit price required to get a
|
|
@@ -4699,11 +5139,6 @@ declare class Transaction {
|
|
|
4699
5139
|
getGasPriceEstimation(): Promise<GasEstimation>;
|
|
4700
5140
|
}
|
|
4701
5141
|
|
|
4702
|
-
declare abstract class AccountAuthenticator extends Serializable {
|
|
4703
|
-
abstract serialize(serializer: Serializer): void;
|
|
4704
|
-
static deserialize(deserializer: Deserializer): AccountAuthenticator;
|
|
4705
|
-
}
|
|
4706
|
-
|
|
4707
5142
|
declare class TransactionSubmission {
|
|
4708
5143
|
readonly config: AptosConfig;
|
|
4709
5144
|
constructor(config: AptosConfig);
|
|
@@ -4713,10 +5148,10 @@ declare class TransactionSubmission {
|
|
|
4713
5148
|
* When we call `generateTransaction` function with the relevant type properties,
|
|
4714
5149
|
* Typescript can infer the return type based on the appropriate function overload.
|
|
4715
5150
|
*/
|
|
4716
|
-
generateTransaction(args:
|
|
4717
|
-
generateTransaction(args:
|
|
4718
|
-
generateTransaction(args:
|
|
4719
|
-
generateTransaction(args:
|
|
5151
|
+
generateTransaction(args: InputGenerateSingleSignerRawTransactionData): Promise<InputSingleSignerTransaction>;
|
|
5152
|
+
generateTransaction(args: InputGenerateFeePayerRawTransactionData): Promise<InputFeePayerTransaction>;
|
|
5153
|
+
generateTransaction(args: InputGenerateMultiAgentRawTransactionData): Promise<InputMultiAgentTransaction>;
|
|
5154
|
+
generateTransaction(args: InputGenerateTransactionData): Promise<AnyRawTransaction>;
|
|
4720
5155
|
/**
|
|
4721
5156
|
* Sign a transaction that can later be submitted to chain
|
|
4722
5157
|
*
|
|
@@ -4745,7 +5180,7 @@ declare class TransactionSubmission {
|
|
|
4745
5180
|
* @param args.feePayerPublicKey optional. For when the transaction is a fee payer (aka sponsored) transaction
|
|
4746
5181
|
* @param args.options optional. A config to simulate the transaction with
|
|
4747
5182
|
*/
|
|
4748
|
-
simulateTransaction(args:
|
|
5183
|
+
simulateTransaction(args: InputSimulateTransactionData): Promise<Array<UserTransactionResponse>>;
|
|
4749
5184
|
/**
|
|
4750
5185
|
* Submit transaction to chain
|
|
4751
5186
|
*
|
|
@@ -4789,18 +5224,18 @@ declare class TransactionSubmission {
|
|
|
4789
5224
|
* `aptos move compile --save-metadata ...`,
|
|
4790
5225
|
* For more info {@link https://aptos.dev/tutorials/your-first-dapp/#step-4-publish-a-move-module}
|
|
4791
5226
|
*
|
|
4792
|
-
* @param account The publisher account
|
|
4793
|
-
* @param metadataBytes The package metadata bytes
|
|
4794
|
-
* @param
|
|
5227
|
+
* @param args.account The publisher account
|
|
5228
|
+
* @param args.metadataBytes The package metadata bytes
|
|
5229
|
+
* @param args.moduleBytecode An array of the bytecode of each module in the package in compiler output order
|
|
4795
5230
|
*
|
|
4796
5231
|
* @returns A SingleSignerTransaction that can be simulated or submitted to chain
|
|
4797
5232
|
*/
|
|
4798
|
-
|
|
5233
|
+
publishPackageTransaction(args: {
|
|
4799
5234
|
account: HexInput;
|
|
4800
5235
|
metadataBytes: HexInput;
|
|
4801
|
-
|
|
4802
|
-
options?:
|
|
4803
|
-
}): Promise<
|
|
5236
|
+
moduleBytecode: Array<HexInput>;
|
|
5237
|
+
options?: InputGenerateTransactionOptions;
|
|
5238
|
+
}): Promise<InputSingleSignerTransaction>;
|
|
4804
5239
|
}
|
|
4805
5240
|
|
|
4806
5241
|
/**
|
|
@@ -4975,6 +5410,196 @@ declare function postAptosFullNode<Req, Res>(options: PostAptosRequestOptions):
|
|
|
4975
5410
|
declare function postAptosIndexer<Req, Res>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
|
|
4976
5411
|
declare function postAptosFaucet<Req, Res>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
|
|
4977
5412
|
|
|
5413
|
+
declare function isBool(arg: SimpleEntryFunctionArgumentTypes): arg is boolean;
|
|
5414
|
+
declare function isString(arg: any): arg is string;
|
|
5415
|
+
declare function isNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number;
|
|
5416
|
+
declare function isLargeNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number | bigint | string;
|
|
5417
|
+
declare function isNull(arg: SimpleEntryFunctionArgumentTypes): arg is null | undefined;
|
|
5418
|
+
declare function isBcsBool(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is Bool;
|
|
5419
|
+
declare function isBcsAddress(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is AccountAddress;
|
|
5420
|
+
declare function isBcsString(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is MoveString;
|
|
5421
|
+
declare function isBcsFixedBytes(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is FixedBytes;
|
|
5422
|
+
declare function isBcsU8(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U8;
|
|
5423
|
+
declare function isBcsU16(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U16;
|
|
5424
|
+
declare function isBcsU32(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U32;
|
|
5425
|
+
declare function isBcsU64(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U64;
|
|
5426
|
+
declare function isBcsU128(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U128;
|
|
5427
|
+
declare function isBcsU256(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U256;
|
|
5428
|
+
declare function isScriptDataInput(arg: InputGenerateTransactionPayloadDataWithRemoteABI | InputGenerateTransactionPayloadData): arg is InputScriptData;
|
|
5429
|
+
declare function throwTypeMismatch(expectedType: string, position: number): void;
|
|
5430
|
+
/**
|
|
5431
|
+
* Finds first non-signer arg.
|
|
5432
|
+
*
|
|
5433
|
+
* A function is often defined with a `signer` or `&signer` arguments at the start, which are filled in
|
|
5434
|
+
* by signatures, and not by the caller.
|
|
5435
|
+
* @param functionAbi
|
|
5436
|
+
*/
|
|
5437
|
+
declare function findFirstNonSignerArg(functionAbi: MoveFunction): number;
|
|
5438
|
+
declare function getFunctionParts(functionArg: MoveStructType): {
|
|
5439
|
+
moduleAddress: string;
|
|
5440
|
+
moduleName: string;
|
|
5441
|
+
functionName: string;
|
|
5442
|
+
};
|
|
5443
|
+
|
|
5444
|
+
/**
|
|
5445
|
+
* We are defining function signatures, each with its specific input and output.
|
|
5446
|
+
* These are the possible function signature for our `generateTransactionPayload` function.
|
|
5447
|
+
* When we call our `generateTransactionPayload` function with the relevant type properties,
|
|
5448
|
+
* Typescript can infer the return type based on the appropriate function overload.
|
|
5449
|
+
*/
|
|
5450
|
+
declare function generateTransactionPayload(args: InputScriptData & {
|
|
5451
|
+
aptosConfig?: undefined;
|
|
5452
|
+
}): Promise<TransactionPayloadScript>;
|
|
5453
|
+
declare function generateTransactionPayload(args: InputEntryFunctionDataWithRemoteABI): Promise<TransactionPayloadEntryFunction>;
|
|
5454
|
+
declare function generateTransactionPayload(args: InputMultiSigDataWithRemoteABI): Promise<TransactionPayloadMultisig>;
|
|
5455
|
+
declare function generateTransactionPayload(args: InputGenerateTransactionPayloadDataWithRemoteABI): Promise<AnyTransactionPayloadInstance>;
|
|
5456
|
+
declare function generateTransactionPayloadWithABI(args: InputEntryFunctionData, functionAbi: EntryFunctionABI): TransactionPayloadEntryFunction;
|
|
5457
|
+
declare function generateTransactionPayloadWithABI(args: InputMultiSigData, functionAbi: EntryFunctionABI): TransactionPayloadMultisig;
|
|
5458
|
+
declare function generateTransactionPayloadWithABI(args: InputGenerateTransactionPayloadData, functionAbi: EntryFunctionABI): AnyTransactionPayloadInstance;
|
|
5459
|
+
/**
|
|
5460
|
+
* Generates a raw transaction
|
|
5461
|
+
*
|
|
5462
|
+
* @param args.aptosConfig AptosConfig
|
|
5463
|
+
* @param args.sender The transaction's sender account address as a hex input
|
|
5464
|
+
* @param args.payload The transaction payload - can create by using generateTransactionPayload()
|
|
5465
|
+
*
|
|
5466
|
+
* @returns RawTransaction
|
|
5467
|
+
*/
|
|
5468
|
+
declare function generateRawTransaction(args: {
|
|
5469
|
+
aptosConfig: AptosConfig;
|
|
5470
|
+
sender: HexInput;
|
|
5471
|
+
payload: AnyTransactionPayloadInstance;
|
|
5472
|
+
options?: InputGenerateTransactionOptions;
|
|
5473
|
+
}): Promise<RawTransaction>;
|
|
5474
|
+
/**
|
|
5475
|
+
* We are defining function signatures, each with its specific input and output.
|
|
5476
|
+
* These are the possible function signature for our `generateTransaction` function.
|
|
5477
|
+
* When we call our `generateTransaction` function with the relevant type properties,
|
|
5478
|
+
* Typescript can infer the return type based on the appropriate function overload.
|
|
5479
|
+
*/
|
|
5480
|
+
declare function buildTransaction(args: InputGenerateSingleSignerRawTransactionArgs): Promise<InputSingleSignerTransaction>;
|
|
5481
|
+
declare function buildTransaction(args: InputGenerateFeePayerRawTransactionArgs): Promise<InputFeePayerTransaction>;
|
|
5482
|
+
declare function buildTransaction(args: InputGenerateMultiAgentRawTransactionArgs): Promise<InputMultiAgentTransaction>;
|
|
5483
|
+
declare function buildTransaction(args: InputGenerateRawTransactionArgs): Promise<AnyRawTransaction>;
|
|
5484
|
+
/**
|
|
5485
|
+
* Simulate a transaction before signing and submit to chain
|
|
5486
|
+
*
|
|
5487
|
+
* @param args.transaction A aptos transaction type to sign
|
|
5488
|
+
* @param args.signerPublicKey The signer public key
|
|
5489
|
+
* @param args.secondarySignersPublicKeys optional. The secondary signers public keys if multi signers transaction
|
|
5490
|
+
* @param args.feePayerPublicKey optional. The fee payer public key is a fee payer (aka sponsored) transaction
|
|
5491
|
+
* @param args.options optional. SimulateTransactionOptions
|
|
5492
|
+
*
|
|
5493
|
+
* @returns A signed serialized transaction that can be simulated
|
|
5494
|
+
*/
|
|
5495
|
+
declare function generateSignedTransactionForSimulation(args: InputSimulateTransactionData): Uint8Array;
|
|
5496
|
+
declare function getAuthenticatorForSimulation(publicKey: PublicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey;
|
|
5497
|
+
/**
|
|
5498
|
+
* Sign a transaction that can later be submitted to chain
|
|
5499
|
+
*
|
|
5500
|
+
* @param args.signer The signer account to sign the transaction
|
|
5501
|
+
* @param args.transaction A aptos transaction type to sign
|
|
5502
|
+
*
|
|
5503
|
+
* @return The signer AccountAuthenticator
|
|
5504
|
+
*/
|
|
5505
|
+
declare function sign(args: {
|
|
5506
|
+
signer: Account$1;
|
|
5507
|
+
transaction: AnyRawTransaction;
|
|
5508
|
+
}): AccountAuthenticator;
|
|
5509
|
+
/**
|
|
5510
|
+
* Prepare a transaction to be submitted to chain
|
|
5511
|
+
*
|
|
5512
|
+
* @param args.transaction A aptos transaction type
|
|
5513
|
+
* @param args.senderAuthenticator The account authenticator of the transaction sender
|
|
5514
|
+
* @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
|
|
5515
|
+
*
|
|
5516
|
+
* @returns A SignedTransaction
|
|
5517
|
+
*/
|
|
5518
|
+
declare function generateSignedTransaction(args: {
|
|
5519
|
+
transaction: AnyRawTransaction;
|
|
5520
|
+
senderAuthenticator: AccountAuthenticator;
|
|
5521
|
+
secondarySignerAuthenticators?: {
|
|
5522
|
+
feePayerAuthenticator?: AccountAuthenticator;
|
|
5523
|
+
additionalSignersAuthenticators?: Array<AccountAuthenticator>;
|
|
5524
|
+
};
|
|
5525
|
+
}): Uint8Array;
|
|
5526
|
+
/**
|
|
5527
|
+
* Derive the raw transaction type - FeePayerRawTransaction or MultiAgentRawTransaction or RawTransaction
|
|
5528
|
+
*
|
|
5529
|
+
* @param transaction A aptos transaction type
|
|
5530
|
+
*
|
|
5531
|
+
* @returns FeePayerRawTransaction | MultiAgentRawTransaction | RawTransaction
|
|
5532
|
+
*/
|
|
5533
|
+
declare function deriveTransactionType(transaction: AnyRawTransaction): AnyRawTransactionInstance;
|
|
5534
|
+
/**
|
|
5535
|
+
* Generate a multi signers signed transaction that can be submitted to chain
|
|
5536
|
+
*
|
|
5537
|
+
* @param transaction MultiAgentRawTransaction | FeePayerRawTransaction
|
|
5538
|
+
* @param senderAuthenticator The account authenticator of the transaction sender
|
|
5539
|
+
* @param secondarySignerAuthenticators The extra signers account Authenticators
|
|
5540
|
+
*
|
|
5541
|
+
* @returns A SignedTransaction
|
|
5542
|
+
*/
|
|
5543
|
+
declare function generateMultiSignersSignedTransaction(transaction: MultiAgentRawTransaction | FeePayerRawTransaction, senderAuthenticator: AccountAuthenticator, secondarySignerAuthenticators: {
|
|
5544
|
+
feePayerAuthenticator?: AccountAuthenticator;
|
|
5545
|
+
additionalSignersAuthenticators?: Array<AccountAuthenticator>;
|
|
5546
|
+
}): Uint8Array;
|
|
5547
|
+
declare function getSigningMessage(rawTxn: AnyRawTransactionInstance): Uint8Array;
|
|
5548
|
+
|
|
5549
|
+
/**
|
|
5550
|
+
* Convert type arguments to only type tags, allowing for string representations of type tags
|
|
5551
|
+
*/
|
|
5552
|
+
declare function standardizeTypeTags(typeArguments?: Array<TypeTag | string>): Array<TypeTag>;
|
|
5553
|
+
/**
|
|
5554
|
+
* Fetches the ABI for an entry function from the module
|
|
5555
|
+
*
|
|
5556
|
+
* @param moduleAddress
|
|
5557
|
+
* @param moduleName
|
|
5558
|
+
* @param functionName
|
|
5559
|
+
* @param aptosConfig
|
|
5560
|
+
*/
|
|
5561
|
+
declare function fetchEntryFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<EntryFunctionABI>;
|
|
5562
|
+
/**
|
|
5563
|
+
* Converts a non-BCS encoded argument into BCS encoded, if necessary
|
|
5564
|
+
* @param functionName
|
|
5565
|
+
* @param functionAbi
|
|
5566
|
+
* @param arg
|
|
5567
|
+
* @param position
|
|
5568
|
+
*/
|
|
5569
|
+
declare function convertArgument(functionName: string, functionAbi: EntryFunctionABI, arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes, position: number, genericTypeParams: Array<TypeTag>): EntryFunctionArgumentTypes;
|
|
5570
|
+
|
|
5571
|
+
declare enum TypeTagParserErrorType {
|
|
5572
|
+
InvalidTypeTag = "unknown type",
|
|
5573
|
+
UnexpectedTypeArgumentClose = "unexpected '>'",
|
|
5574
|
+
UnexpectedWhitespaceCharacter = "unexpected whitespace character",
|
|
5575
|
+
UnexpectedComma = "unexpected ','",
|
|
5576
|
+
TypeArgumentCountMismatch = "type argument count doesn't match expected amount",
|
|
5577
|
+
MissingTypeArgumentClose = "no matching '>' for '<'",
|
|
5578
|
+
UnexpectedPrimitiveTypeArguments = "primitive types not expected to have type arguments",
|
|
5579
|
+
UnexpectedVectorTypeArgumentCount = "vector type expected to have exactly one type argument",
|
|
5580
|
+
UnexpectedStructFormat = "unexpected struct format, must be of the form 0xaddress::module_name::struct_name",
|
|
5581
|
+
InvalidModuleNameCharacter = "module name must only contain alphanumeric or '_' characters",
|
|
5582
|
+
InvalidStructNameCharacter = "struct name must only contain alphanumeric or '_' characters"
|
|
5583
|
+
}
|
|
5584
|
+
declare class TypeTagParserError extends Error {
|
|
5585
|
+
constructor(typeTagStr: string, invalidReason: TypeTagParserErrorType);
|
|
5586
|
+
}
|
|
5587
|
+
/**
|
|
5588
|
+
* All types are made of a few parts they're either:
|
|
5589
|
+
* 1. A simple type e.g. u8
|
|
5590
|
+
* 2. A standalone struct e.g. 0x1::account::Account
|
|
5591
|
+
* 3. A nested struct e.g. 0x1::coin::Coin<0x1234::coin::MyCoin>
|
|
5592
|
+
*
|
|
5593
|
+
* There are a few more special cases that need to be handled, however.
|
|
5594
|
+
* 1. Multiple generics e.g 0x1::pair::Pair<u8, u16>
|
|
5595
|
+
* 2. Spacing in the generics e.g. 0x1::pair::Pair< u8 , u16>
|
|
5596
|
+
* 3. Nested generics of different depths e.g. 0x1::pair::Pair<0x1::coin::Coin<0x1234::coin::MyCoin>, u8>
|
|
5597
|
+
* 4. Generics for types in ABIs are filled in with placeholders e.g T1, T2, T3
|
|
5598
|
+
*/
|
|
5599
|
+
declare function parseTypeTag(typeStr: string, options?: {
|
|
5600
|
+
allowGenerics?: boolean;
|
|
5601
|
+
}): TypeTag;
|
|
5602
|
+
|
|
4978
5603
|
declare type DerivedKeys = {
|
|
4979
5604
|
key: Uint8Array;
|
|
4980
5605
|
chainCode: Uint8Array;
|
|
@@ -5009,4 +5634,4 @@ declare const isValidPath: (path: string) => boolean;
|
|
|
5009
5634
|
*/
|
|
5010
5635
|
declare const derivePrivateKeyFromMnemonic: (keyType: KeyType, path: string, seedPhrase: string, offset?: number) => DerivedKeys;
|
|
5011
5636
|
|
|
5012
|
-
export { APTOS_PATH_REGEX, Account$1 as Account, AccountAddress, AccountAuthenticatorVariant, AccountData, AccountEd25519Signature, AccountMultiEd25519Signature, AccountSecp256k1Signature, AccountSignature, AddressInvalidReason, AnyNumber, AnyRawTransaction, AnyRawTransactionInstance, Aptos, AptosApiError, AptosConfig, AptosRequest, AptosResponse, AptosSettings, AuthenticationKey, AuthenticationKeyScheme, Block, BlockMetadataTransactionResponse, Bool, Client, ClientConfig, ClientRequest, ClientResponse, DecodedTableData, DeletedTableData, DeriveScheme, DerivedKeys, Deserializable, Deserializer, DirectWriteSet, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, EntryFunctionArgumentTypes, EntryFunctionBytes,
|
|
5637
|
+
export { APTOS_PATH_REGEX, Account$1 as Account, AccountAddress, AccountAuthenticator, AccountAuthenticatorEd25519, AccountAuthenticatorMultiEd25519, AccountAuthenticatorMultiKey, AccountAuthenticatorSingleKey, AccountAuthenticatorVariant, AccountData, AccountEd25519Signature, AccountMultiEd25519Signature, AccountSecp256k1Signature, AccountSignature, AddressInvalidReason, AnyNumber, AnyPublicKeyVariant, AnyRawTransaction, AnyRawTransactionInstance, AnySignatureVariant, AnyTransactionPayloadInstance, Aptos, AptosApiError, AptosConfig, AptosRequest, AptosResponse, AptosSettings, AuthenticationKey, AuthenticationKeyScheme, Block, BlockMetadataTransactionResponse, Bool, ChainId, Client, ClientConfig, ClientRequest, ClientResponse, DecodedTableData, DeletedTableData, DeriveScheme, DerivedKeys, Deserializable, Deserializer, DirectWriteSet, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, EntryFunction, EntryFunctionABI, EntryFunctionArgument, EntryFunctionArgumentTypes, EntryFunctionBytes, EntryFunctionPayloadResponse, Event$1 as Event, EventGuid, FeePayerRawTransaction, FixedBytes, GasEstimation, GenerateAccount, GenerateAccountWithLegacyKey, GenerateAccountWithUnifiedKey, GenesisPayload, GenesisTransactionResponse, GetAccountCoinsDataResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountOwnedObjectsResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountOwnedTokensQueryResponse, GetAptosRequestOptions, GetChainTopUserTransactionsResponse, GetCollectionDataResponse, GetCurrentFungibleAssetBalancesResponse, GetCurrentTokenOwnershipResponse, GetDelegatedStakingActivitiesResponse, GetEventsResponse, GetFungibleAssetActivitiesResponse, GetFungibleAssetMetadataResponse, GetNumberOfDelegatorsResponse, GetOwnedTokensResponse, GetProcessorStatusResponse, GetRequestOptions, GetTokenActivityResponse, GetTokenDataResponse, GraphqlQuery, Hex, HexInput, HexInvalidReason, Identifier, InputEntryFunctionData, InputEntryFunctionDataWithRemoteABI, InputFeePayerTransaction, InputGenerateFeePayerRawTransactionArgs, InputGenerateFeePayerRawTransactionData, InputGenerateMultiAgentRawTransactionArgs, InputGenerateMultiAgentRawTransactionData, InputGenerateRawTransactionArgs, InputGenerateSingleSignerRawTransactionArgs, InputGenerateSingleSignerRawTransactionData, InputGenerateTransactionData, InputGenerateTransactionOptions, InputGenerateTransactionPayloadData, InputGenerateTransactionPayloadDataWithRemoteABI, InputMultiAgentTransaction, InputMultiSigData, InputMultiSigDataWithRemoteABI, InputScriptData, InputSimulateTransactionData, InputSimulateTransactionOptions, InputSingleSignerTransaction, KeyType, LedgerInfo, LedgerVersion, MimeType, ModuleId, MoveAbility, MoveAddressType, MoveFunction, MoveFunctionGenericTypeParam, MoveFunctionVisibility, MoveModule, MoveModuleBytecode, MoveModuleId, MoveObjectType, MoveOption, MoveOptionType, MoveResource, MoveScriptBytecode, MoveString, MoveStruct, MoveStructField, MoveStructType, MoveType, MoveUint128Type, MoveUint16Type, MoveUint256Type, MoveUint32Type, MoveUint64Type, MoveUint8Type, MoveValue, MoveVector, MultiAgentRawTransaction, MultiEd25519PublicKey, MultiEd25519Signature, MultiKey, MultiSig, MultisigPayloadResponse, MultisigTransactionPayload, Network, NetworkToChainId, NetworkToFaucetAPI, NetworkToIndexerAPI, NetworkToNodeAPI, OrderBy, OrderByValue, PaginationArgs, ParsingError, ParsingResult, PendingTransactionResponse, PostAptosRequestOptions, PostRequestOptions, PrivateKey, PublicKey, RawTransaction, RawTransactionWithData, RoleType, Script, ScriptFunctionArgument, ScriptFunctionArgumentTypes, ScriptPayloadResponse, ScriptTransactionArgumentVariants, ScriptWriteSet, Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature, Serializable, Serializer, Signature, SignedTransaction, SigningScheme, SigningSchemeInput, SimpleEntryFunctionArgumentTypes, StateCheckpointTransactionResponse, StructTag, TableItemRequest, TokenStandard, TransactionArgument, TransactionAuthenticator, TransactionAuthenticatorEd25519, TransactionAuthenticatorFeePayer, TransactionAuthenticatorMultiAgent, TransactionAuthenticatorMultiEd25519, TransactionAuthenticatorSingleSender, TransactionAuthenticatorVariant, TransactionEd25519Signature, TransactionFeePayerSignature, TransactionMultiAgentSignature, TransactionMultiEd25519Signature, TransactionPayload, TransactionPayloadEntryFunction, TransactionPayloadMultisig, TransactionPayloadResponse, TransactionPayloadScript, TransactionPayloadVariants, TransactionResponse, TransactionResponseType, TransactionSecp256k1Signature, TransactionSignature, TransactionVariants, TypeTag, TypeTagAddress, TypeTagBool, TypeTagGeneric, TypeTagParserError, TypeTagParserErrorType, TypeTagReference, TypeTagSigner, TypeTagStruct, TypeTagU128, TypeTagU16, TypeTagU256, TypeTagU32, TypeTagU64, TypeTagU8, TypeTagVariants, TypeTagVector, U128, U16, U256, U32, U64, U8, Uint128, Uint16, Uint256, Uint32, Uint64, Uint8, UserTransactionResponse, ViewRequest, ViewRequestData, WaitForTransactionOptions, WriteSet, WriteSetChange, WriteSetChangeDeleteModule, WriteSetChangeDeleteResource, WriteSetChangeDeleteTableItem, WriteSetChangeWriteModule, WriteSetChangeWriteResource, WriteSetChangeWriteTableItem, aptosCoinStructTag, aptosRequest, buildTransaction, convertArgument, derivePrivateKeyFromMnemonic, deriveTransactionType, deserializeFromScriptArgument, ensureBoolean, fetchEntryFunctionAbi, findFirstNonSignerArg, generateMultiSignersSignedTransaction, generateRawTransaction, generateSignedTransaction, generateSignedTransactionForSimulation, generateTransactionPayload, generateTransactionPayloadWithABI, get, getAptosFullNode, getAuthenticatorForSimulation, getFunctionParts, getSigningMessage, isBcsAddress, isBcsBool, isBcsFixedBytes, isBcsString, isBcsU128, isBcsU16, isBcsU256, isBcsU32, isBcsU64, isBcsU8, isBool, isLargeNumber, isNull, isNumber, isScriptDataInput, isString, isValidPath, objectStructTag, optionStructTag, outOfRangeErrorMessage, paginateWithCursor, parseTypeTag, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, request, sign, standardizeTypeTags, stringStructTag, throwTypeMismatch, validateNumberInRange };
|