@aptos-labs/ts-sdk 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/browser/index.global.js +26 -25
- package/dist/browser/index.global.js.map +1 -1
- package/dist/cjs/index.d.ts +413 -227
- package/dist/cjs/index.js +451 -181
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.d.ts +413 -227
- package/dist/esm/index.mjs +440 -178
- package/dist/esm/index.mjs.map +1 -1
- package/dist/types/index.d.ts +11 -17
- package/dist/types/index.js.map +1 -1
- package/package.json +3 -2
- package/src/api/account.ts +17 -18
- package/src/api/ans.ts +58 -0
- package/src/api/aptos.ts +7 -1
- package/src/api/coin.ts +3 -3
- package/src/api/digitalAsset.ts +9 -8
- package/src/api/event.ts +4 -3
- package/src/api/faucet.ts +3 -2
- package/src/api/general.ts +2 -2
- package/src/api/staking.ts +5 -4
- package/src/api/transactionSubmission.ts +27 -18
- package/src/bcs/deserializer.ts +4 -4
- package/src/bcs/serializable/moveStructs.ts +5 -9
- package/src/bcs/serializer.ts +4 -4
- package/src/client/core.ts +14 -6
- package/src/core/account.ts +83 -29
- package/src/core/accountAddress.ts +34 -30
- package/src/core/authenticationKey.ts +11 -9
- package/src/core/crypto/ed25519.ts +48 -1
- package/src/core/crypto/hdKey.ts +105 -0
- package/src/core/crypto/index.ts +1 -0
- package/src/core/crypto/secp256k1.ts +36 -0
- package/src/index.ts +0 -1
- package/src/internal/account.ts +80 -58
- package/src/internal/ans.ts +177 -0
- package/src/internal/coin.ts +5 -5
- package/src/internal/digitalAsset.ts +16 -17
- package/src/internal/event.ts +7 -7
- package/src/internal/faucet.ts +4 -4
- package/src/internal/general.ts +3 -3
- package/src/internal/staking.ts +8 -8
- package/src/internal/transactionSubmission.ts +71 -18
- package/src/transactions/instances/index.ts +1 -0
- package/src/transactions/instances/moduleId.ts +1 -1
- package/src/transactions/instances/rotationProofChallenge.ts +58 -0
- package/src/transactions/transactionBuilder/helpers.ts +5 -1
- package/src/transactions/transactionBuilder/remoteAbi.ts +3 -3
- package/src/transactions/transactionBuilder/transactionBuilder.ts +31 -45
- package/src/transactions/typeTag/index.ts +10 -10
- package/src/transactions/typeTag/parser.ts +1 -1
- package/src/transactions/types.ts +28 -17
- package/src/types/index.ts +11 -16
- package/src/utils/apiEndpoints.ts +8 -0
- package/src/version.ts +1 -1
- package/src/utils/hdKey.ts +0 -113
package/dist/esm/index.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ declare enum Network {
|
|
|
9
9
|
CUSTOM = "custom"
|
|
10
10
|
}
|
|
11
11
|
declare const NetworkToChainId: Record<string, number>;
|
|
12
|
+
declare const NetworkToNetworkName: Record<string, Network>;
|
|
12
13
|
|
|
13
14
|
declare type Maybe<T> = T | null;
|
|
14
15
|
declare type InputMaybe<T> = Maybe<T>;
|
|
@@ -1518,28 +1519,22 @@ declare type WaitForTransactionOptions = {
|
|
|
1518
1519
|
indexerVersionCheck?: boolean;
|
|
1519
1520
|
};
|
|
1520
1521
|
/**
|
|
1521
|
-
*
|
|
1522
|
-
* Ed25519 or
|
|
1523
|
-
* If `scheme` is not specified, we default to ED25519
|
|
1524
|
-
* In this case `legacy` is always true
|
|
1522
|
+
* Input type to generate an account using Single Signer
|
|
1523
|
+
* Ed25519 or Legacy Ed25519
|
|
1525
1524
|
*/
|
|
1526
|
-
declare type
|
|
1527
|
-
scheme
|
|
1528
|
-
legacy:
|
|
1525
|
+
declare type GenerateAccountWithEd25519 = {
|
|
1526
|
+
scheme: SigningSchemeInput.Ed25519;
|
|
1527
|
+
legacy: boolean;
|
|
1529
1528
|
};
|
|
1530
1529
|
/**
|
|
1531
|
-
*
|
|
1532
|
-
*
|
|
1533
|
-
* In this case `legacy` is always false
|
|
1530
|
+
* Input type to generate an account using Single Signer
|
|
1531
|
+
* Secp256k1
|
|
1534
1532
|
*/
|
|
1535
|
-
declare type
|
|
1536
|
-
scheme: SigningSchemeInput.Secp256k1Ecdsa
|
|
1533
|
+
declare type GenerateAccountWithSingleSignerSecp256k1Key = {
|
|
1534
|
+
scheme: SigningSchemeInput.Secp256k1Ecdsa;
|
|
1537
1535
|
legacy?: false;
|
|
1538
1536
|
};
|
|
1539
|
-
|
|
1540
|
-
* Unify GenerateAccount type for Legacy and Unified keys
|
|
1541
|
-
*/
|
|
1542
|
-
declare type GenerateAccount = GenerateAccountWithLegacyKey | GenerateAccountWithUnifiedKey;
|
|
1537
|
+
declare type GenerateAccount = GenerateAccountWithEd25519 | GenerateAccountWithSingleSignerSecp256k1Key;
|
|
1543
1538
|
|
|
1544
1539
|
/**
|
|
1545
1540
|
* Type of API endpoint for request routing
|
|
@@ -1886,10 +1881,10 @@ declare class Serializer {
|
|
|
1886
1881
|
* @param values The array of BCS Serializable values
|
|
1887
1882
|
* @example
|
|
1888
1883
|
* const addresses = new Array<AccountAddress>(
|
|
1889
|
-
* AccountAddress.
|
|
1890
|
-
* AccountAddress.
|
|
1891
|
-
* AccountAddress.
|
|
1892
|
-
* AccountAddress.
|
|
1884
|
+
* AccountAddress.fromRelaxed("0x1"),
|
|
1885
|
+
* AccountAddress.fromRelaxed("0x2"),
|
|
1886
|
+
* AccountAddress.fromRelaxed("0xa"),
|
|
1887
|
+
* AccountAddress.fromRelaxed("0xb"),
|
|
1893
1888
|
* );
|
|
1894
1889
|
* const serializer = new Serializer();
|
|
1895
1890
|
* serializer.serializeVector(addresses);
|
|
@@ -2029,10 +2024,10 @@ declare class Deserializer {
|
|
|
2029
2024
|
* @example
|
|
2030
2025
|
* // serialize a vector of addresses
|
|
2031
2026
|
* const addresses = new Array<AccountAddress>(
|
|
2032
|
-
* AccountAddress.
|
|
2033
|
-
* AccountAddress.
|
|
2034
|
-
* AccountAddress.
|
|
2035
|
-
* AccountAddress.
|
|
2027
|
+
* AccountAddress.fromRelaxed("0x1"),
|
|
2028
|
+
* AccountAddress.fromRelaxed("0x2"),
|
|
2029
|
+
* AccountAddress.fromRelaxed("0xa"),
|
|
2030
|
+
* AccountAddress.fromRelaxed("0xb"),
|
|
2036
2031
|
* );
|
|
2037
2032
|
* const serializer = new Serializer();
|
|
2038
2033
|
* serializer.serializeVector(addresses);
|
|
@@ -2089,6 +2084,7 @@ declare enum AddressInvalidReason {
|
|
|
2089
2084
|
LONG_FORM_REQUIRED_UNLESS_SPECIAL = "long_form_required_unless_special",
|
|
2090
2085
|
INVALID_PADDING_ZEROES = "INVALID_PADDING_ZEROES"
|
|
2091
2086
|
}
|
|
2087
|
+
declare type AccountAddressInput = HexInput | AccountAddress;
|
|
2092
2088
|
/**
|
|
2093
2089
|
* NOTE: Only use this class for account addresses. For other hex data, e.g. transaction
|
|
2094
2090
|
* hashes, use the Hex class.
|
|
@@ -2128,9 +2124,7 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2128
2124
|
*
|
|
2129
2125
|
* @param args.data A Uint8Array representing an account address.
|
|
2130
2126
|
*/
|
|
2131
|
-
constructor(
|
|
2132
|
-
data: Uint8Array;
|
|
2133
|
-
});
|
|
2127
|
+
constructor(input: Uint8Array);
|
|
2134
2128
|
/**
|
|
2135
2129
|
* Returns whether an address is special, where special is defined as 0x0 to 0xf
|
|
2136
2130
|
* inclusive. In other words, the last byte of the address must be < 0b10000 (16)
|
|
@@ -2274,23 +2268,19 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2274
2268
|
*/
|
|
2275
2269
|
static fromStringRelaxed(input: string): AccountAddress;
|
|
2276
2270
|
/**
|
|
2277
|
-
* Convenience method for creating an AccountAddress from
|
|
2278
|
-
* more information on how this works, see the constructor and fromString.
|
|
2279
|
-
*
|
|
2280
|
-
* @param input A hex string or Uint8Array representing an account address.
|
|
2271
|
+
* Convenience method for creating an AccountAddress from all known inputs.
|
|
2281
2272
|
*
|
|
2282
|
-
*
|
|
2273
|
+
* This handles, Uint8array, string, and AccountAddress itself
|
|
2274
|
+
* @param input
|
|
2283
2275
|
*/
|
|
2284
|
-
static
|
|
2276
|
+
static fromRelaxed(input: AccountAddressInput): AccountAddress;
|
|
2285
2277
|
/**
|
|
2286
|
-
* Convenience method for creating an AccountAddress from
|
|
2287
|
-
* more information on how this works, see the constructor and fromStringRelaxed.
|
|
2288
|
-
*
|
|
2289
|
-
* @param hexInput A hex string or Uint8Array representing an account address.
|
|
2278
|
+
* Convenience method for creating an AccountAddress from all known inputs.
|
|
2290
2279
|
*
|
|
2291
|
-
*
|
|
2280
|
+
* This handles, Uint8array, string, and AccountAddress itself
|
|
2281
|
+
* @param input
|
|
2292
2282
|
*/
|
|
2293
|
-
static
|
|
2283
|
+
static from(input: AccountAddressInput): AccountAddress;
|
|
2294
2284
|
/**
|
|
2295
2285
|
* Check if the string is a valid AccountAddress.
|
|
2296
2286
|
*
|
|
@@ -2301,7 +2291,7 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2301
2291
|
* is not valid, invalidReason will be set explaining why it is invalid.
|
|
2302
2292
|
*/
|
|
2303
2293
|
static isValid(args: {
|
|
2304
|
-
input:
|
|
2294
|
+
input: AccountAddressInput;
|
|
2305
2295
|
relaxed?: boolean;
|
|
2306
2296
|
}): ParsingResult<AddressInvalidReason>;
|
|
2307
2297
|
/**
|
|
@@ -2472,11 +2462,6 @@ declare class U256 extends Serializable implements TransactionArgument {
|
|
|
2472
2462
|
* const vecOfStrings = new MoveVector([new MoveString("hello"), new MoveString("world")]);
|
|
2473
2463
|
* const vecOfStrings2 = MoveVector.MoveString(["hello", "world"]);
|
|
2474
2464
|
*
|
|
2475
|
-
* // where MySerializableStruct is a class you've made that implements Serializable
|
|
2476
|
-
* const vecOfSerializableValues = new MoveVector<MySerializableStruct>([
|
|
2477
|
-
* new MySerializableStruct("hello", "world"),
|
|
2478
|
-
* new MySerializableStruct("foo", "bar"),
|
|
2479
|
-
* ]);
|
|
2480
2465
|
* @params
|
|
2481
2466
|
* values: an Array<T> of values where T is a class that implements Serializable
|
|
2482
2467
|
* @returns a `MoveVector<T>` with the values `values`
|
|
@@ -2549,7 +2534,7 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
|
|
|
2549
2534
|
*
|
|
2550
2535
|
* @example
|
|
2551
2536
|
* const v = MoveVector.Bool([true, false, true, false]);
|
|
2552
|
-
* @params values: an array of `
|
|
2537
|
+
* @params values: an array of `bools` to convert to Bools
|
|
2553
2538
|
* @returns a `MoveVector<Bool>`
|
|
2554
2539
|
*/
|
|
2555
2540
|
static Bool(values: Array<boolean>): MoveVector<Bool>;
|
|
@@ -2558,7 +2543,7 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
|
|
|
2558
2543
|
*
|
|
2559
2544
|
* @example
|
|
2560
2545
|
* const v = MoveVector.MoveString(["hello", "world"]);
|
|
2561
|
-
* @params values: an array of `
|
|
2546
|
+
* @params values: an array of `strings` to convert to MoveStrings
|
|
2562
2547
|
* @returns a `MoveVector<MoveString>`
|
|
2563
2548
|
*/
|
|
2564
2549
|
static MoveString(values: Array<string>): MoveVector<MoveString>;
|
|
@@ -2570,8 +2555,9 @@ declare class MoveVector<T extends Serializable & EntryFunctionArgument> extends
|
|
|
2570
2555
|
*
|
|
2571
2556
|
* NOTE: This will not work with types that aren't of the Serializable class.
|
|
2572
2557
|
*
|
|
2573
|
-
* If you
|
|
2574
|
-
*
|
|
2558
|
+
* If you're looking for a more flexible deserialization function, you can use the deserializeVector function
|
|
2559
|
+
* in the Deserializer class.
|
|
2560
|
+
*
|
|
2575
2561
|
* @example
|
|
2576
2562
|
* const vec = MoveVector.deserialize(deserializer, U64);
|
|
2577
2563
|
* @params deserializer: the Deserializer instance to use, with bytes loaded into it already.
|
|
@@ -2777,6 +2763,66 @@ declare abstract class Signature extends Serializable {
|
|
|
2777
2763
|
abstract serialize(serializer: Serializer): void;
|
|
2778
2764
|
}
|
|
2779
2765
|
|
|
2766
|
+
/**
|
|
2767
|
+
* Each account stores an authentication key. Authentication key enables account owners to rotate
|
|
2768
|
+
* their private key(s) associated with the account without changing the address that hosts their account.
|
|
2769
|
+
* @see {@link https://aptos.dev/concepts/accounts | Account Basics}
|
|
2770
|
+
*
|
|
2771
|
+
* Account addresses can be derived from AuthenticationKey
|
|
2772
|
+
*/
|
|
2773
|
+
declare class AuthenticationKey extends Serializable {
|
|
2774
|
+
/**
|
|
2775
|
+
* An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.
|
|
2776
|
+
*
|
|
2777
|
+
* The data to hash depends on the underlying public key type and the derivation scheme.
|
|
2778
|
+
*/
|
|
2779
|
+
static readonly LENGTH: number;
|
|
2780
|
+
/**
|
|
2781
|
+
* The raw bytes of the authentication key.
|
|
2782
|
+
*/
|
|
2783
|
+
readonly data: Hex;
|
|
2784
|
+
constructor(args: {
|
|
2785
|
+
data: HexInput;
|
|
2786
|
+
});
|
|
2787
|
+
serialize(serializer: Serializer): void;
|
|
2788
|
+
/**
|
|
2789
|
+
* Deserialize an AuthenticationKey from the byte buffer in a Deserializer instance.
|
|
2790
|
+
* @param deserializer The deserializer to deserialize the AuthenticationKey from.
|
|
2791
|
+
* @returns An instance of AuthenticationKey.
|
|
2792
|
+
*/
|
|
2793
|
+
static deserialize(deserializer: Deserializer): AuthenticationKey;
|
|
2794
|
+
toString(): string;
|
|
2795
|
+
toUint8Array(): Uint8Array;
|
|
2796
|
+
/**
|
|
2797
|
+
* Derives an AuthenticationKey from the public key seed bytes and an explicit derivation scheme.
|
|
2798
|
+
*
|
|
2799
|
+
* This facilitates targeting a specific scheme for deriving an authentication key from a public key.
|
|
2800
|
+
*
|
|
2801
|
+
* @param args - the public key and scheme to use for the derivation
|
|
2802
|
+
*/
|
|
2803
|
+
static fromPublicKeyAndScheme(args: {
|
|
2804
|
+
publicKey: PublicKey;
|
|
2805
|
+
scheme: AuthenticationKeyScheme;
|
|
2806
|
+
}): AuthenticationKey;
|
|
2807
|
+
/**
|
|
2808
|
+
* Converts a PublicKey(s) to an AuthenticationKey, using the derivation scheme inferred from the
|
|
2809
|
+
* instance of the PublicKey type passed in.
|
|
2810
|
+
*
|
|
2811
|
+
* @param args.publicKey
|
|
2812
|
+
* @returns AuthenticationKey
|
|
2813
|
+
*/
|
|
2814
|
+
static fromPublicKey(args: {
|
|
2815
|
+
publicKey: PublicKey;
|
|
2816
|
+
}): AuthenticationKey;
|
|
2817
|
+
/**
|
|
2818
|
+
* Derives an account address from an AuthenticationKey. Since an AccountAddress is also 32 bytes,
|
|
2819
|
+
* the AuthenticationKey bytes are directly translated to an AccountAddress.
|
|
2820
|
+
*
|
|
2821
|
+
* @returns AccountAddress
|
|
2822
|
+
*/
|
|
2823
|
+
derivedAddress(): AccountAddress;
|
|
2824
|
+
}
|
|
2825
|
+
|
|
2780
2826
|
/**
|
|
2781
2827
|
* Class for creating and managing account on Aptos network
|
|
2782
2828
|
*
|
|
@@ -2832,7 +2878,8 @@ declare class Account$1 {
|
|
|
2832
2878
|
private constructor();
|
|
2833
2879
|
/**
|
|
2834
2880
|
* Derives an account with random private key and address.
|
|
2835
|
-
*
|
|
2881
|
+
*
|
|
2882
|
+
* Default generation is using the Legacy ED25519 key
|
|
2836
2883
|
*
|
|
2837
2884
|
* @param args optional. Unify GenerateAccount type for Legacy and Unified keys
|
|
2838
2885
|
*
|
|
@@ -2858,14 +2905,30 @@ declare class Account$1 {
|
|
|
2858
2905
|
* @returns Account with the given signing scheme
|
|
2859
2906
|
*/
|
|
2860
2907
|
static generate(args?: GenerateAccount): Account$1;
|
|
2908
|
+
/**
|
|
2909
|
+
* Instantiates an account given a private key.
|
|
2910
|
+
*
|
|
2911
|
+
* This is used as a local calculation and therefore is used to instantiate an `Account`
|
|
2912
|
+
* that has not had its authentication key rotated.
|
|
2913
|
+
*
|
|
2914
|
+
* @param privateKey PrivateKey - private key of the account
|
|
2915
|
+
* @param args.legacy optional. If set to false, the keypair generated is a Unified keypair. Defaults
|
|
2916
|
+
* to generating a Legacy Ed25519 keypair
|
|
2917
|
+
*
|
|
2918
|
+
* @returns Account
|
|
2919
|
+
*/
|
|
2920
|
+
static fromPrivateKey(args: {
|
|
2921
|
+
privateKey: PrivateKey;
|
|
2922
|
+
legacy?: boolean;
|
|
2923
|
+
}): Account$1;
|
|
2861
2924
|
/**
|
|
2862
2925
|
* Instantiates an account given a private key and a specified account address.
|
|
2863
2926
|
* This is primarily used to instantiate an `Account` that has had its authentication key rotated.
|
|
2864
2927
|
*
|
|
2865
|
-
* @param privateKey PrivateKey - private key
|
|
2866
|
-
* @param address The account address
|
|
2867
|
-
* @param args.legacy optional. If set to
|
|
2868
|
-
*
|
|
2928
|
+
* @param args.privateKey PrivateKey - the underlying private key for the account
|
|
2929
|
+
* @param args.address AccountAddress - The account address the `Account` will sign for
|
|
2930
|
+
* @param args.legacy optional. If set to false, the keypair generated is a Unified keypair. Defaults
|
|
2931
|
+
* to generating a Legacy Ed25519 keypair
|
|
2869
2932
|
*
|
|
2870
2933
|
* @returns Account
|
|
2871
2934
|
*/
|
|
@@ -2877,14 +2940,21 @@ declare class Account$1 {
|
|
|
2877
2940
|
/**
|
|
2878
2941
|
* Derives an account with bip44 path and mnemonics,
|
|
2879
2942
|
*
|
|
2880
|
-
* @param args.
|
|
2943
|
+
* @param args.scheme The signing scheme to derive with
|
|
2944
|
+
* @param args.path the BIP44 derive hardened path (e.g. m/44'/637'/0'/0'/0') for Ed25519,
|
|
2945
|
+
* or non-hardened path (e.g. m/44'/637'/0'/0/0) for secp256k1
|
|
2881
2946
|
* Detailed description: {@link https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki}
|
|
2882
2947
|
* @param args.mnemonic the mnemonic seed phrase of the account
|
|
2883
|
-
* @
|
|
2948
|
+
* @param args.legacy optional. If set to false, the keypair generated is a Unified keypair. Defaults
|
|
2949
|
+
* to generating a Legacy Ed25519 keypair
|
|
2950
|
+
*
|
|
2951
|
+
* @returns Account
|
|
2884
2952
|
*/
|
|
2885
2953
|
static fromDerivationPath(args: {
|
|
2954
|
+
scheme: SigningSchemeInput;
|
|
2886
2955
|
path: string;
|
|
2887
2956
|
mnemonic: string;
|
|
2957
|
+
legacy?: boolean;
|
|
2888
2958
|
}): Account$1;
|
|
2889
2959
|
/**
|
|
2890
2960
|
* This key enables account owners to rotate their private key(s)
|
|
@@ -2892,11 +2962,11 @@ declare class Account$1 {
|
|
|
2892
2962
|
* See here for more info: {@link https://aptos.dev/concepts/accounts#single-signer-authentication}
|
|
2893
2963
|
*
|
|
2894
2964
|
* @param args.publicKey PublicKey - public key of the account
|
|
2895
|
-
* @returns
|
|
2965
|
+
* @returns The authentication key for the associated account
|
|
2896
2966
|
*/
|
|
2897
2967
|
static authKey(args: {
|
|
2898
2968
|
publicKey: PublicKey;
|
|
2899
|
-
}):
|
|
2969
|
+
}): AuthenticationKey;
|
|
2900
2970
|
/**
|
|
2901
2971
|
* Sign the given message with the private key.
|
|
2902
2972
|
*
|
|
@@ -2919,64 +2989,6 @@ declare class Account$1 {
|
|
|
2919
2989
|
}): boolean;
|
|
2920
2990
|
}
|
|
2921
2991
|
|
|
2922
|
-
/**
|
|
2923
|
-
* Each account stores an authentication key. Authentication key enables account owners to rotate
|
|
2924
|
-
* their private key(s) associated with the account without changing the address that hosts their account.
|
|
2925
|
-
* @see {@link https://aptos.dev/concepts/accounts | Account Basics}
|
|
2926
|
-
*
|
|
2927
|
-
* Note: AuthenticationKey only supports Ed25519 and MultiEd25519 public keys for now.
|
|
2928
|
-
*
|
|
2929
|
-
* Account addresses can be derived from AuthenticationKey
|
|
2930
|
-
*/
|
|
2931
|
-
declare class AuthenticationKey extends Serializable {
|
|
2932
|
-
/**
|
|
2933
|
-
* An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.
|
|
2934
|
-
*/
|
|
2935
|
-
static readonly LENGTH: number;
|
|
2936
|
-
/**
|
|
2937
|
-
* The raw bytes of the authentication key.
|
|
2938
|
-
*/
|
|
2939
|
-
readonly data: Hex;
|
|
2940
|
-
constructor(args: {
|
|
2941
|
-
data: HexInput;
|
|
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;
|
|
2950
|
-
toString(): string;
|
|
2951
|
-
toUint8Array(): Uint8Array;
|
|
2952
|
-
/**
|
|
2953
|
-
* Creates an AuthenticationKey from seed bytes and a scheme
|
|
2954
|
-
*
|
|
2955
|
-
* This allows for the creation of AuthenticationKeys that are not derived from Public Keys directly
|
|
2956
|
-
* @param args
|
|
2957
|
-
*/
|
|
2958
|
-
static fromPublicKeyAndScheme(args: {
|
|
2959
|
-
publicKey: PublicKey;
|
|
2960
|
-
scheme: AuthenticationKeyScheme;
|
|
2961
|
-
}): AuthenticationKey;
|
|
2962
|
-
/**
|
|
2963
|
-
* Converts a PublicKey(s) to AuthenticationKey
|
|
2964
|
-
*
|
|
2965
|
-
* @param args.publicKey
|
|
2966
|
-
* @returns AuthenticationKey
|
|
2967
|
-
*/
|
|
2968
|
-
static fromPublicKey(args: {
|
|
2969
|
-
publicKey: PublicKey;
|
|
2970
|
-
}): AuthenticationKey;
|
|
2971
|
-
/**
|
|
2972
|
-
* Derives an account address from AuthenticationKey. Since current AccountAddress is 32 bytes,
|
|
2973
|
-
* AuthenticationKey bytes are directly translated to AccountAddress.
|
|
2974
|
-
*
|
|
2975
|
-
* @returns AccountAddress
|
|
2976
|
-
*/
|
|
2977
|
-
derivedAddress(): AccountAddress;
|
|
2978
|
-
}
|
|
2979
|
-
|
|
2980
2992
|
/**
|
|
2981
2993
|
* Represents the public key of an Ed25519 key pair.
|
|
2982
2994
|
*
|
|
@@ -3035,6 +3047,11 @@ declare class Ed25519PrivateKey extends PrivateKey {
|
|
|
3035
3047
|
* Length of an Ed25519 private key
|
|
3036
3048
|
*/
|
|
3037
3049
|
static readonly LENGTH: number;
|
|
3050
|
+
/**
|
|
3051
|
+
* The Ed25519 key seed to use for BIP-32 compatibility
|
|
3052
|
+
* See more {@link https://github.com/satoshilabs/slips/blob/master/slip-0010.md}
|
|
3053
|
+
*/
|
|
3054
|
+
static readonly SLIP_0010_SEED = "ed25519 seed";
|
|
3038
3055
|
/**
|
|
3039
3056
|
* The Ed25519 signing key
|
|
3040
3057
|
* @private
|
|
@@ -3079,6 +3096,28 @@ declare class Ed25519PrivateKey extends PrivateKey {
|
|
|
3079
3096
|
* @returns Ed25519PublicKey
|
|
3080
3097
|
*/
|
|
3081
3098
|
publicKey(): Ed25519PublicKey;
|
|
3099
|
+
/**
|
|
3100
|
+
* Derives a private key from a mnemonic seed phrase.
|
|
3101
|
+
*
|
|
3102
|
+
* To derive multiple keys from the same phrase, change the path
|
|
3103
|
+
*
|
|
3104
|
+
* IMPORTANT: Ed25519 supports hardened derivation only (since it lacks a key homomorphism,
|
|
3105
|
+
* so non-hardened derivation cannot work)
|
|
3106
|
+
*
|
|
3107
|
+
* @param path the BIP44 path
|
|
3108
|
+
* @param mnemonics the mnemonic seed phrase
|
|
3109
|
+
*/
|
|
3110
|
+
static fromDerivationPath(path: string, mnemonics: string): Ed25519PrivateKey;
|
|
3111
|
+
/**
|
|
3112
|
+
* A private inner function so we can separate from the main fromDerivationPath() method
|
|
3113
|
+
* to add tests to verify we create the keys correctly.
|
|
3114
|
+
*
|
|
3115
|
+
* @param path the BIP44 path
|
|
3116
|
+
* @param seed the seed phrase created by the mnemonics
|
|
3117
|
+
* @param offset the offset used for key derivation, defaults to 0x80000000
|
|
3118
|
+
* @returns
|
|
3119
|
+
*/
|
|
3120
|
+
private static fromDerivationPathInner;
|
|
3082
3121
|
}
|
|
3083
3122
|
/**
|
|
3084
3123
|
* A signature of a message signed using an Ed25519 private key
|
|
@@ -3317,6 +3356,25 @@ declare class Secp256k1PrivateKey extends PrivateKey {
|
|
|
3317
3356
|
* @returns Secp256k1PublicKey
|
|
3318
3357
|
*/
|
|
3319
3358
|
publicKey(): Secp256k1PublicKey;
|
|
3359
|
+
/**
|
|
3360
|
+
* Derives a private key from a mnemonic seed phrase.
|
|
3361
|
+
*
|
|
3362
|
+
* @param path the BIP44 path
|
|
3363
|
+
* @param mnemonics the mnemonic seed phrase
|
|
3364
|
+
*
|
|
3365
|
+
* @returns The generated key
|
|
3366
|
+
*/
|
|
3367
|
+
static fromDerivationPath(path: string, mnemonics: string): Secp256k1PrivateKey;
|
|
3368
|
+
/**
|
|
3369
|
+
* A private inner function so we can separate from the main fromDerivationPath() method
|
|
3370
|
+
* to add tests to verify we create the keys correctly.
|
|
3371
|
+
*
|
|
3372
|
+
* @param path the BIP44 path
|
|
3373
|
+
* @param seed the seed phrase created by the mnemonics
|
|
3374
|
+
*
|
|
3375
|
+
* @returns The generated key
|
|
3376
|
+
*/
|
|
3377
|
+
private static fromDerivationPathInner;
|
|
3320
3378
|
}
|
|
3321
3379
|
/**
|
|
3322
3380
|
* A signature of a message signed using an Secp256k1 ecdsa private key
|
|
@@ -3452,6 +3510,70 @@ declare class MultiKey extends PublicKey {
|
|
|
3452
3510
|
static deserialize(deserializer: Deserializer): MultiKey;
|
|
3453
3511
|
}
|
|
3454
3512
|
|
|
3513
|
+
declare type DerivedKeys = {
|
|
3514
|
+
key: Uint8Array;
|
|
3515
|
+
chainCode: Uint8Array;
|
|
3516
|
+
};
|
|
3517
|
+
/**
|
|
3518
|
+
* Aptos derive path is 637
|
|
3519
|
+
*/
|
|
3520
|
+
declare const APTOS_HARDENED_REGEX: RegExp;
|
|
3521
|
+
declare const APTOS_BIP44_REGEX: RegExp;
|
|
3522
|
+
/**
|
|
3523
|
+
* A list of supported key types and associated seeds
|
|
3524
|
+
*/
|
|
3525
|
+
declare enum KeyType {
|
|
3526
|
+
ED25519 = "ed25519 seed"
|
|
3527
|
+
}
|
|
3528
|
+
declare const HARDENED_OFFSET = 2147483648;
|
|
3529
|
+
/**
|
|
3530
|
+
* Aptos derive path is 637
|
|
3531
|
+
*
|
|
3532
|
+
* Parse and validate a path that is compliant to BIP-44 in form m/44'/637'/{account_index}'/{change_index}/{address_index}
|
|
3533
|
+
* for Secp256k1
|
|
3534
|
+
*
|
|
3535
|
+
* Note that for secp256k1, last two components must be non-hardened.
|
|
3536
|
+
*
|
|
3537
|
+
* @param path path string (e.g. `m/44'/637'/0'/0/0`).
|
|
3538
|
+
*/
|
|
3539
|
+
declare function isValidBIP44Path(path: string): boolean;
|
|
3540
|
+
/**
|
|
3541
|
+
* Aptos derive path is 637
|
|
3542
|
+
*
|
|
3543
|
+
* Parse and validate a path that is compliant to SLIP-0010 and BIP-44
|
|
3544
|
+
* in form m/44'/637'/{account_index}'/{change_index}'/{address_index}'.
|
|
3545
|
+
* See SLIP-0010 {@link https://github.com/satoshilabs/slips/blob/master/slip-0044.md}
|
|
3546
|
+
* See BIP-44 {@link https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki}
|
|
3547
|
+
*
|
|
3548
|
+
* Note that for Ed25519, all components must be hardened.
|
|
3549
|
+
* This is because non-hardened [PK] derivation would not work due to Ed25519's lack of a key homomorphism.
|
|
3550
|
+
* Specifically, you cannot derive the PK associated with derivation path a/b/c given the PK of a/b.
|
|
3551
|
+
* This is because the PK in Ed25519 is, more or less, computed as 𝑔𝐻(𝑠𝑘),
|
|
3552
|
+
* with the hash function breaking the homomorphism.
|
|
3553
|
+
*
|
|
3554
|
+
* @param path path string (e.g. `m/44'/637'/0'/0'/0'`).
|
|
3555
|
+
*/
|
|
3556
|
+
declare function isValidHardenedPath(path: string): boolean;
|
|
3557
|
+
declare const deriveKey: (hashSeed: Uint8Array | string, data: Uint8Array | string) => DerivedKeys;
|
|
3558
|
+
/**
|
|
3559
|
+
* Derive a child key from the private key
|
|
3560
|
+
* @param key
|
|
3561
|
+
* @param chainCode
|
|
3562
|
+
* @param index
|
|
3563
|
+
* @constructor
|
|
3564
|
+
*/
|
|
3565
|
+
declare const CKDPriv: ({ key, chainCode }: DerivedKeys, index: number) => DerivedKeys;
|
|
3566
|
+
/**
|
|
3567
|
+
* Splits derive path into segments
|
|
3568
|
+
* @param path
|
|
3569
|
+
*/
|
|
3570
|
+
declare const splitPath: (path: string) => Array<string>;
|
|
3571
|
+
/**
|
|
3572
|
+
* Normalizes the mnemonic by removing extra whitespace and making it lowercase
|
|
3573
|
+
* @param mnemonic the mnemonic seed phrase
|
|
3574
|
+
*/
|
|
3575
|
+
declare const mnemonicToSeed: (mnemonic: string) => Uint8Array;
|
|
3576
|
+
|
|
3455
3577
|
/**
|
|
3456
3578
|
* A class to query all `Account` related queries on Aptos.
|
|
3457
3579
|
*/
|
|
@@ -3474,7 +3596,7 @@ declare class Account {
|
|
|
3474
3596
|
* ```
|
|
3475
3597
|
*/
|
|
3476
3598
|
getAccountInfo(args: {
|
|
3477
|
-
accountAddress:
|
|
3599
|
+
accountAddress: AccountAddressInput;
|
|
3478
3600
|
}): Promise<AccountData>;
|
|
3479
3601
|
/**
|
|
3480
3602
|
* Queries for all modules in an account given an account address
|
|
@@ -3490,7 +3612,7 @@ declare class Account {
|
|
|
3490
3612
|
* @returns Account modules
|
|
3491
3613
|
*/
|
|
3492
3614
|
getAccountModules(args: {
|
|
3493
|
-
accountAddress:
|
|
3615
|
+
accountAddress: AccountAddressInput;
|
|
3494
3616
|
options?: PaginationArgs & LedgerVersion;
|
|
3495
3617
|
}): Promise<MoveModuleBytecode[]>;
|
|
3496
3618
|
/**
|
|
@@ -3511,7 +3633,7 @@ declare class Account {
|
|
|
3511
3633
|
* ```
|
|
3512
3634
|
*/
|
|
3513
3635
|
getAccountModule(args: {
|
|
3514
|
-
accountAddress:
|
|
3636
|
+
accountAddress: AccountAddressInput;
|
|
3515
3637
|
moduleName: string;
|
|
3516
3638
|
options?: LedgerVersion;
|
|
3517
3639
|
}): Promise<MoveModuleBytecode>;
|
|
@@ -3528,7 +3650,7 @@ declare class Account {
|
|
|
3528
3650
|
* @returns The account transactions
|
|
3529
3651
|
*/
|
|
3530
3652
|
getAccountTransactions(args: {
|
|
3531
|
-
accountAddress:
|
|
3653
|
+
accountAddress: AccountAddressInput;
|
|
3532
3654
|
options?: PaginationArgs;
|
|
3533
3655
|
}): Promise<TransactionResponse[]>;
|
|
3534
3656
|
/**
|
|
@@ -3544,7 +3666,7 @@ declare class Account {
|
|
|
3544
3666
|
* @returns Account resources
|
|
3545
3667
|
*/
|
|
3546
3668
|
getAccountResources(args: {
|
|
3547
|
-
accountAddress:
|
|
3669
|
+
accountAddress: AccountAddressInput;
|
|
3548
3670
|
options?: PaginationArgs & LedgerVersion;
|
|
3549
3671
|
}): Promise<MoveResource[]>;
|
|
3550
3672
|
/**
|
|
@@ -3566,7 +3688,7 @@ declare class Account {
|
|
|
3566
3688
|
* ```
|
|
3567
3689
|
*/
|
|
3568
3690
|
getAccountResource<T extends {} = any>(args: {
|
|
3569
|
-
accountAddress:
|
|
3691
|
+
accountAddress: AccountAddressInput;
|
|
3570
3692
|
resourceType: MoveStructType;
|
|
3571
3693
|
options?: LedgerVersion;
|
|
3572
3694
|
}): Promise<T>;
|
|
@@ -3580,7 +3702,7 @@ declare class Account {
|
|
|
3580
3702
|
* @returns Promise<AccountAddress> The accountAddress associated with the authentication key
|
|
3581
3703
|
*/
|
|
3582
3704
|
lookupOriginalAccountAddress(args: {
|
|
3583
|
-
authenticationKey:
|
|
3705
|
+
authenticationKey: AccountAddressInput;
|
|
3584
3706
|
options?: LedgerVersion;
|
|
3585
3707
|
}): Promise<AccountAddress>;
|
|
3586
3708
|
/**
|
|
@@ -3590,7 +3712,7 @@ declare class Account {
|
|
|
3590
3712
|
* @returns Current count of tokens owned by the account
|
|
3591
3713
|
*/
|
|
3592
3714
|
getAccountTokensCount(args: {
|
|
3593
|
-
accountAddress:
|
|
3715
|
+
accountAddress: AccountAddressInput;
|
|
3594
3716
|
}): Promise<number>;
|
|
3595
3717
|
/**
|
|
3596
3718
|
* Queries the account's current owned tokens.
|
|
@@ -3606,7 +3728,7 @@ declare class Account {
|
|
|
3606
3728
|
* @returns Tokens array with the token data
|
|
3607
3729
|
*/
|
|
3608
3730
|
getAccountOwnedTokens(args: {
|
|
3609
|
-
accountAddress:
|
|
3731
|
+
accountAddress: AccountAddressInput;
|
|
3610
3732
|
options?: {
|
|
3611
3733
|
tokenStandard?: TokenStandard;
|
|
3612
3734
|
pagination?: PaginationArgs;
|
|
@@ -3628,8 +3750,8 @@ declare class Account {
|
|
|
3628
3750
|
* @returns Tokens array with the token data
|
|
3629
3751
|
*/
|
|
3630
3752
|
getAccountOwnedTokensFromCollectionAddress(args: {
|
|
3631
|
-
accountAddress:
|
|
3632
|
-
collectionAddress:
|
|
3753
|
+
accountAddress: AccountAddressInput;
|
|
3754
|
+
collectionAddress: AccountAddressInput;
|
|
3633
3755
|
options?: {
|
|
3634
3756
|
tokenStandard?: TokenStandard;
|
|
3635
3757
|
pagination?: PaginationArgs;
|
|
@@ -3650,7 +3772,7 @@ declare class Account {
|
|
|
3650
3772
|
* @returns Collections array with the collections data
|
|
3651
3773
|
*/
|
|
3652
3774
|
getAccountCollectionsWithOwnedTokens(args: {
|
|
3653
|
-
accountAddress:
|
|
3775
|
+
accountAddress: AccountAddressInput;
|
|
3654
3776
|
options?: {
|
|
3655
3777
|
tokenStandard?: TokenStandard;
|
|
3656
3778
|
pagination?: PaginationArgs;
|
|
@@ -3664,7 +3786,7 @@ declare class Account {
|
|
|
3664
3786
|
* @returns Current count of transactions made by an account
|
|
3665
3787
|
*/
|
|
3666
3788
|
getAccountTransactionsCount(args: {
|
|
3667
|
-
accountAddress:
|
|
3789
|
+
accountAddress: AccountAddressInput;
|
|
3668
3790
|
}): Promise<number>;
|
|
3669
3791
|
/**
|
|
3670
3792
|
* Queries an account's coins data
|
|
@@ -3676,7 +3798,7 @@ declare class Account {
|
|
|
3676
3798
|
* @returns Array with the coins data
|
|
3677
3799
|
*/
|
|
3678
3800
|
getAccountCoinsData(args: {
|
|
3679
|
-
accountAddress:
|
|
3801
|
+
accountAddress: AccountAddressInput;
|
|
3680
3802
|
options?: {
|
|
3681
3803
|
pagination?: PaginationArgs;
|
|
3682
3804
|
orderBy?: OrderBy<GetAccountCoinsDataResponse[0]>;
|
|
@@ -3689,7 +3811,7 @@ declare class Account {
|
|
|
3689
3811
|
* @returns Current count of the aggregated count of all account's coins
|
|
3690
3812
|
*/
|
|
3691
3813
|
getAccountCoinsCount(args: {
|
|
3692
|
-
accountAddress:
|
|
3814
|
+
accountAddress: AccountAddressInput;
|
|
3693
3815
|
}): Promise<number>;
|
|
3694
3816
|
/**
|
|
3695
3817
|
* Queries an account's owned objects
|
|
@@ -3701,7 +3823,7 @@ declare class Account {
|
|
|
3701
3823
|
* @returns Objects array with the object data
|
|
3702
3824
|
*/
|
|
3703
3825
|
getAccountOwnedObjects(args: {
|
|
3704
|
-
accountAddress:
|
|
3826
|
+
accountAddress: AccountAddressInput;
|
|
3705
3827
|
options?: {
|
|
3706
3828
|
pagination?: PaginationArgs;
|
|
3707
3829
|
orderBy?: OrderBy<GetAccountOwnedObjectsResponse[0]>;
|
|
@@ -3872,9 +3994,9 @@ declare class TypeTagStruct extends TypeTag {
|
|
|
3872
3994
|
}
|
|
3873
3995
|
declare class StructTag extends Serializable {
|
|
3874
3996
|
readonly address: AccountAddress;
|
|
3875
|
-
readonly
|
|
3997
|
+
readonly moduleName: Identifier;
|
|
3876
3998
|
readonly name: Identifier;
|
|
3877
|
-
readonly
|
|
3999
|
+
readonly typeArgs: Array<TypeTag>;
|
|
3878
4000
|
constructor(address: AccountAddress, module_name: Identifier, name: Identifier, type_args: Array<TypeTag>);
|
|
3879
4001
|
serialize(serializer: Serializer): void;
|
|
3880
4002
|
static deserialize(deserializer: Deserializer): StructTag;
|
|
@@ -4159,6 +4281,27 @@ declare class FeePayerRawTransaction extends RawTransactionWithData {
|
|
|
4159
4281
|
static load(deserializer: Deserializer): FeePayerRawTransaction;
|
|
4160
4282
|
}
|
|
4161
4283
|
|
|
4284
|
+
/**
|
|
4285
|
+
* Representation of the challenge which is needed to sign by owner of the account
|
|
4286
|
+
* to rotate the authentication key.
|
|
4287
|
+
*/
|
|
4288
|
+
declare class RotationProofChallenge extends Serializable {
|
|
4289
|
+
readonly accountAddress: AccountAddress;
|
|
4290
|
+
readonly moduleName: MoveString;
|
|
4291
|
+
readonly structName: MoveString;
|
|
4292
|
+
readonly originator: AccountAddress;
|
|
4293
|
+
readonly currentAuthKey: AccountAddress;
|
|
4294
|
+
readonly newPublicKey: MoveVector<U8>;
|
|
4295
|
+
readonly sequenceNumber: U64;
|
|
4296
|
+
constructor(args: {
|
|
4297
|
+
sequenceNumber: AnyNumber;
|
|
4298
|
+
originator: AccountAddress;
|
|
4299
|
+
currentAuthKey: AccountAddress;
|
|
4300
|
+
newPublicKey: PublicKey;
|
|
4301
|
+
});
|
|
4302
|
+
serialize(serializer: Serializer): void;
|
|
4303
|
+
}
|
|
4304
|
+
|
|
4162
4305
|
declare abstract class AccountAuthenticator extends Serializable {
|
|
4163
4306
|
abstract serialize(serializer: Serializer): void;
|
|
4164
4307
|
static deserialize(deserializer: Deserializer): AccountAuthenticator;
|
|
@@ -4383,7 +4526,7 @@ declare type InputMultiSigData = {
|
|
|
4383
4526
|
* The data needed to generate a Multi Sig payload
|
|
4384
4527
|
*/
|
|
4385
4528
|
declare type InputMultiSigDataWithRemoteABI = {
|
|
4386
|
-
multisigAddress:
|
|
4529
|
+
multisigAddress: AccountAddressInput;
|
|
4387
4530
|
} & InputEntryFunctionDataWithRemoteABI;
|
|
4388
4531
|
/**
|
|
4389
4532
|
* The data needed to generate a Script payload
|
|
@@ -4408,7 +4551,7 @@ declare type EntryFunctionABI = {
|
|
|
4408
4551
|
*/
|
|
4409
4552
|
interface InputGenerateSingleSignerRawTransactionArgs {
|
|
4410
4553
|
aptosConfig: AptosConfig;
|
|
4411
|
-
sender:
|
|
4554
|
+
sender: AccountAddressInput;
|
|
4412
4555
|
payload: AnyTransactionPayloadInstance;
|
|
4413
4556
|
feePayerAddress?: undefined;
|
|
4414
4557
|
secondarySignerAddresses?: undefined;
|
|
@@ -4420,10 +4563,10 @@ interface InputGenerateSingleSignerRawTransactionArgs {
|
|
|
4420
4563
|
*/
|
|
4421
4564
|
interface InputGenerateFeePayerRawTransactionArgs {
|
|
4422
4565
|
aptosConfig: AptosConfig;
|
|
4423
|
-
sender:
|
|
4566
|
+
sender: AccountAddressInput;
|
|
4424
4567
|
payload: AnyTransactionPayloadInstance;
|
|
4425
|
-
feePayerAddress:
|
|
4426
|
-
secondarySignerAddresses?:
|
|
4568
|
+
feePayerAddress: AccountAddressInput;
|
|
4569
|
+
secondarySignerAddresses?: AccountAddressInput[];
|
|
4427
4570
|
options?: InputGenerateTransactionOptions;
|
|
4428
4571
|
}
|
|
4429
4572
|
/**
|
|
@@ -4432,9 +4575,9 @@ interface InputGenerateFeePayerRawTransactionArgs {
|
|
|
4432
4575
|
*/
|
|
4433
4576
|
interface InputGenerateMultiAgentRawTransactionArgs {
|
|
4434
4577
|
aptosConfig: AptosConfig;
|
|
4435
|
-
sender:
|
|
4578
|
+
sender: AccountAddressInput;
|
|
4436
4579
|
payload: AnyTransactionPayloadInstance;
|
|
4437
|
-
secondarySignerAddresses:
|
|
4580
|
+
secondarySignerAddresses: AccountAddressInput[];
|
|
4438
4581
|
feePayerAddress?: undefined;
|
|
4439
4582
|
options?: InputGenerateTransactionOptions;
|
|
4440
4583
|
}
|
|
@@ -4448,7 +4591,7 @@ declare type InputGenerateRawTransactionArgs = InputGenerateSingleSignerRawTrans
|
|
|
4448
4591
|
* @param rawTransaction a bcs serialized raw transaction
|
|
4449
4592
|
*/
|
|
4450
4593
|
interface InputSingleSignerTransaction {
|
|
4451
|
-
rawTransaction:
|
|
4594
|
+
rawTransaction: RawTransaction;
|
|
4452
4595
|
feePayerAddress?: undefined;
|
|
4453
4596
|
secondarySignerAddresses?: undefined;
|
|
4454
4597
|
}
|
|
@@ -4460,7 +4603,7 @@ interface InputSingleSignerTransaction {
|
|
|
4460
4603
|
* @param feePayerAddress fee payer address for a fee payer transaction (aka Sponsored Transaction)
|
|
4461
4604
|
*/
|
|
4462
4605
|
interface InputFeePayerTransaction {
|
|
4463
|
-
rawTransaction:
|
|
4606
|
+
rawTransaction: RawTransaction;
|
|
4464
4607
|
feePayerAddress: AccountAddress;
|
|
4465
4608
|
secondarySignerAddresses?: AccountAddress[];
|
|
4466
4609
|
}
|
|
@@ -4471,7 +4614,7 @@ interface InputFeePayerTransaction {
|
|
|
4471
4614
|
* @param secondarySignerAddresses secondary signer addresses for multi-agent transaction
|
|
4472
4615
|
*/
|
|
4473
4616
|
interface InputMultiAgentTransaction {
|
|
4474
|
-
rawTransaction:
|
|
4617
|
+
rawTransaction: RawTransaction;
|
|
4475
4618
|
secondarySignerAddresses: AccountAddress[];
|
|
4476
4619
|
feePayerAddress?: undefined;
|
|
4477
4620
|
}
|
|
@@ -4507,7 +4650,7 @@ declare type InputSimulateTransactionOptions = {
|
|
|
4507
4650
|
* Interface that holds the user data input when generating a single signer transaction
|
|
4508
4651
|
*/
|
|
4509
4652
|
interface InputGenerateSingleSignerRawTransactionData {
|
|
4510
|
-
sender:
|
|
4653
|
+
sender: AccountAddressInput;
|
|
4511
4654
|
feePayerAddress?: undefined;
|
|
4512
4655
|
secondarySignerAddresses?: undefined;
|
|
4513
4656
|
options?: InputGenerateTransactionOptions;
|
|
@@ -4517,9 +4660,9 @@ interface InputGenerateSingleSignerRawTransactionData {
|
|
|
4517
4660
|
* Interface that holds the user data input when generating a fee payer transaction
|
|
4518
4661
|
*/
|
|
4519
4662
|
interface InputGenerateFeePayerRawTransactionData {
|
|
4520
|
-
sender:
|
|
4521
|
-
feePayerAddress:
|
|
4522
|
-
secondarySignerAddresses?:
|
|
4663
|
+
sender: AccountAddressInput;
|
|
4664
|
+
feePayerAddress: AccountAddressInput;
|
|
4665
|
+
secondarySignerAddresses?: AccountAddressInput[];
|
|
4523
4666
|
options?: InputGenerateTransactionOptions;
|
|
4524
4667
|
data: InputGenerateTransactionPayloadData;
|
|
4525
4668
|
}
|
|
@@ -4527,8 +4670,8 @@ interface InputGenerateFeePayerRawTransactionData {
|
|
|
4527
4670
|
* Interface that holds the user data input when generating a multi-agent transaction
|
|
4528
4671
|
*/
|
|
4529
4672
|
interface InputGenerateMultiAgentRawTransactionData {
|
|
4530
|
-
sender:
|
|
4531
|
-
secondarySignerAddresses:
|
|
4673
|
+
sender: AccountAddressInput;
|
|
4674
|
+
secondarySignerAddresses: AccountAddressInput[];
|
|
4532
4675
|
feePayerAddress?: undefined;
|
|
4533
4676
|
options?: InputGenerateTransactionOptions;
|
|
4534
4677
|
data: InputGenerateTransactionPayloadData;
|
|
@@ -4537,6 +4680,15 @@ interface InputGenerateMultiAgentRawTransactionData {
|
|
|
4537
4680
|
* Unified type that holds all the user data input interfaces when generating different transaction types
|
|
4538
4681
|
*/
|
|
4539
4682
|
declare type InputGenerateTransactionData = InputGenerateMultiAgentRawTransactionData | InputGenerateFeePayerRawTransactionData | InputGenerateSingleSignerRawTransactionData;
|
|
4683
|
+
/**
|
|
4684
|
+
* Interface that holds the user data input when submitting a transaction
|
|
4685
|
+
*/
|
|
4686
|
+
interface InputSubmitTransactionData {
|
|
4687
|
+
transaction: AnyRawTransaction;
|
|
4688
|
+
senderAuthenticator: AccountAuthenticator;
|
|
4689
|
+
feePayerAuthenticator?: AccountAuthenticator;
|
|
4690
|
+
additionalSignersAuthenticators?: Array<AccountAuthenticator>;
|
|
4691
|
+
}
|
|
4540
4692
|
|
|
4541
4693
|
/**
|
|
4542
4694
|
* A class to handle all `Coin` operations
|
|
@@ -4556,7 +4708,7 @@ declare class Coin {
|
|
|
4556
4708
|
*/
|
|
4557
4709
|
transferCoinTransaction(args: {
|
|
4558
4710
|
sender: Account$1;
|
|
4559
|
-
recipient:
|
|
4711
|
+
recipient: AccountAddressInput;
|
|
4560
4712
|
amount: AnyNumber;
|
|
4561
4713
|
coinType?: MoveStructType;
|
|
4562
4714
|
options?: InputGenerateTransactionOptions;
|
|
@@ -4635,7 +4787,7 @@ declare class DigitalAsset {
|
|
|
4635
4787
|
* @returns GetCollectionDataResponse response type
|
|
4636
4788
|
*/
|
|
4637
4789
|
getCollectionData(args: {
|
|
4638
|
-
creatorAddress:
|
|
4790
|
+
creatorAddress: AccountAddressInput;
|
|
4639
4791
|
collectionName: string;
|
|
4640
4792
|
options?: {
|
|
4641
4793
|
tokenStandard?: TokenStandard;
|
|
@@ -4653,7 +4805,7 @@ declare class DigitalAsset {
|
|
|
4653
4805
|
* @returns the collection id
|
|
4654
4806
|
*/
|
|
4655
4807
|
getCollectionId(args: {
|
|
4656
|
-
creatorAddress:
|
|
4808
|
+
creatorAddress: AccountAddressInput;
|
|
4657
4809
|
collectionName: string;
|
|
4658
4810
|
options?: {
|
|
4659
4811
|
tokenStandard?: TokenStandard;
|
|
@@ -4685,7 +4837,7 @@ declare class DigitalAsset {
|
|
|
4685
4837
|
* @returns GetTokenDataResponse containing relevant data to the token.
|
|
4686
4838
|
*/
|
|
4687
4839
|
getTokenData(args: {
|
|
4688
|
-
tokenAddress:
|
|
4840
|
+
tokenAddress: AccountAddressInput;
|
|
4689
4841
|
}): Promise<GetTokenDataResponse>;
|
|
4690
4842
|
/**
|
|
4691
4843
|
* Gets token ownership data given the address of a token.
|
|
@@ -4694,7 +4846,7 @@ declare class DigitalAsset {
|
|
|
4694
4846
|
* @returns GetCurrentTokenOwnershipResponse containing relevant ownership data of the token.
|
|
4695
4847
|
*/
|
|
4696
4848
|
getCurrentTokenOwnership(args: {
|
|
4697
|
-
tokenAddress:
|
|
4849
|
+
tokenAddress: AccountAddressInput;
|
|
4698
4850
|
}): Promise<GetCurrentTokenOwnershipResponse>;
|
|
4699
4851
|
/**
|
|
4700
4852
|
* Gets the tokens that the given address owns.
|
|
@@ -4703,7 +4855,7 @@ declare class DigitalAsset {
|
|
|
4703
4855
|
* @returns GetOwnedTokensResponse containing ownership data of the tokens belonging to the ownerAddresss.
|
|
4704
4856
|
*/
|
|
4705
4857
|
getOwnedTokens(args: {
|
|
4706
|
-
ownerAddress:
|
|
4858
|
+
ownerAddress: AccountAddressInput;
|
|
4707
4859
|
options?: {
|
|
4708
4860
|
pagination?: PaginationArgs;
|
|
4709
4861
|
orderBy?: OrderBy<GetOwnedTokensResponse[0]>;
|
|
@@ -4716,7 +4868,7 @@ declare class DigitalAsset {
|
|
|
4716
4868
|
* @returns GetTokenActivityResponse containing relevant activity data to the token.
|
|
4717
4869
|
*/
|
|
4718
4870
|
getTokenActivity(args: {
|
|
4719
|
-
tokenAddress:
|
|
4871
|
+
tokenAddress: AccountAddressInput;
|
|
4720
4872
|
options?: {
|
|
4721
4873
|
pagination?: PaginationArgs;
|
|
4722
4874
|
orderBy?: OrderBy<GetTokenActivityResponse[0]>;
|
|
@@ -4739,7 +4891,7 @@ declare class Event {
|
|
|
4739
4891
|
* @returns Promise<GetEventsResponse>
|
|
4740
4892
|
*/
|
|
4741
4893
|
getAccountEventsByCreationNumber(args: {
|
|
4742
|
-
accountAddress:
|
|
4894
|
+
accountAddress: AccountAddressInput;
|
|
4743
4895
|
creationNumber: AnyNumber;
|
|
4744
4896
|
}): Promise<GetEventsResponse>;
|
|
4745
4897
|
/**
|
|
@@ -4751,7 +4903,7 @@ declare class Event {
|
|
|
4751
4903
|
* @returns Promise<GetEventsResponse>
|
|
4752
4904
|
*/
|
|
4753
4905
|
getAccountEventsByEventType(args: {
|
|
4754
|
-
accountAddress:
|
|
4906
|
+
accountAddress: AccountAddressInput;
|
|
4755
4907
|
eventType: MoveStructType;
|
|
4756
4908
|
options?: {
|
|
4757
4909
|
pagination?: PaginationArgs;
|
|
@@ -4799,7 +4951,7 @@ declare class Faucet {
|
|
|
4799
4951
|
* @returns Transaction hash of the transaction that funded the account
|
|
4800
4952
|
*/
|
|
4801
4953
|
fundAccount(args: {
|
|
4802
|
-
accountAddress:
|
|
4954
|
+
accountAddress: AccountAddressInput;
|
|
4803
4955
|
amount: number;
|
|
4804
4956
|
options?: WaitForTransactionOptions;
|
|
4805
4957
|
}): Promise<string>;
|
|
@@ -4945,11 +5097,11 @@ declare class General {
|
|
|
4945
5097
|
*
|
|
4946
5098
|
* @returns Table item value rendered in JSON
|
|
4947
5099
|
*/
|
|
4948
|
-
getTableItem(args: {
|
|
5100
|
+
getTableItem<T>(args: {
|
|
4949
5101
|
handle: string;
|
|
4950
5102
|
data: TableItemRequest;
|
|
4951
5103
|
options?: LedgerVersion;
|
|
4952
|
-
}): Promise<
|
|
5104
|
+
}): Promise<T>;
|
|
4953
5105
|
/**
|
|
4954
5106
|
* Queries for a Move view function
|
|
4955
5107
|
* @param args.payload Payload for the view function
|
|
@@ -5009,6 +5161,76 @@ declare class General {
|
|
|
5009
5161
|
getIndexerLastSuccessVersion(): Promise<number>;
|
|
5010
5162
|
}
|
|
5011
5163
|
|
|
5164
|
+
/**
|
|
5165
|
+
* This file contains the underlying implementations for exposed API surface in
|
|
5166
|
+
* the {@link api/name}. By moving the methods out into a separate file,
|
|
5167
|
+
* other namespaces and processes can access these methods without depending on the entire
|
|
5168
|
+
* name namespace and without having a dependency cycle error.
|
|
5169
|
+
*/
|
|
5170
|
+
|
|
5171
|
+
interface RegisterNameParameters {
|
|
5172
|
+
aptosConfig: AptosConfig;
|
|
5173
|
+
sender: Account$1;
|
|
5174
|
+
name: string;
|
|
5175
|
+
expiration: {
|
|
5176
|
+
policy: "domain";
|
|
5177
|
+
years: 1;
|
|
5178
|
+
} | {
|
|
5179
|
+
policy: "subdomain:follow-domain";
|
|
5180
|
+
} | {
|
|
5181
|
+
policy: "subdomain:independent";
|
|
5182
|
+
expirationDate: Date;
|
|
5183
|
+
};
|
|
5184
|
+
transferable?: boolean;
|
|
5185
|
+
toAddress?: HexInput;
|
|
5186
|
+
targetAddress?: HexInput;
|
|
5187
|
+
options?: InputGenerateTransactionOptions;
|
|
5188
|
+
}
|
|
5189
|
+
|
|
5190
|
+
/**
|
|
5191
|
+
* A class to handle all `ANS` operations
|
|
5192
|
+
*/
|
|
5193
|
+
declare class ANS {
|
|
5194
|
+
readonly config: AptosConfig;
|
|
5195
|
+
constructor(config: AptosConfig);
|
|
5196
|
+
/**
|
|
5197
|
+
* Retrieve the owner address of a domain name or subdomain name.
|
|
5198
|
+
*
|
|
5199
|
+
* ```ts
|
|
5200
|
+
* getOwnerAddress({name: "test.aptos"})
|
|
5201
|
+
* // Will return the owner address of "test.aptos.apt" or undefined
|
|
5202
|
+
* ```
|
|
5203
|
+
*
|
|
5204
|
+
* @param args.name - A string of the name to retrieve
|
|
5205
|
+
*
|
|
5206
|
+
* @returns MoveAddressType if the name is owned, undefined otherwise
|
|
5207
|
+
*/
|
|
5208
|
+
getOwnerAddress(args: {
|
|
5209
|
+
name: string;
|
|
5210
|
+
}): Promise<MoveAddressType | undefined>;
|
|
5211
|
+
/**
|
|
5212
|
+
* Registers a new domain or subdomain name
|
|
5213
|
+
*
|
|
5214
|
+
* @param args.sender - The sender account
|
|
5215
|
+
* @param args.name - A string or {domainName: string, subdomainName?: string} of the name to register. This
|
|
5216
|
+
* can be inclusive or exclusive of the .apt suffix.
|
|
5217
|
+
* Examples include: "xyz", "xyz.apt", "xyz.kyc.apt", {domainName: "xyz"}, {domainName: "kyc", subdomainName: "xyz"}.
|
|
5218
|
+
* @param args.expiration - An object with the expiration policy of the name.
|
|
5219
|
+
* @param args.expiration.policy - 'domain' | 'subdomain:follow-domain' | 'subdomain:independent'
|
|
5220
|
+
* - domain: Years is required and the name will expire after the given number of years.
|
|
5221
|
+
* - subdomain:follow-domain: The name will expire at the same time as the domain name.
|
|
5222
|
+
* - subdomain:independent: The name will expire at the given date.
|
|
5223
|
+
* @param args.transferable - Determines if the subdomain being minted is soul-bound. Applicable only to subdomains.
|
|
5224
|
+
* @param args.targetAddress optional - The address the domain name will resolve to. If not provided,
|
|
5225
|
+
* the sender's address will be used.
|
|
5226
|
+
* @param args.toAddress optional - The address to send the domain name to. If not provided,
|
|
5227
|
+
* the transaction will be sent to the router.
|
|
5228
|
+
*
|
|
5229
|
+
* @returns InputSingleSignerTransaction
|
|
5230
|
+
*/
|
|
5231
|
+
registerName(args: Omit<RegisterNameParameters, "aptosConfig">): Promise<InputSingleSignerTransaction>;
|
|
5232
|
+
}
|
|
5233
|
+
|
|
5012
5234
|
/**
|
|
5013
5235
|
* A class to query all `Staking` related queries on Aptos.
|
|
5014
5236
|
*/
|
|
@@ -5022,7 +5244,7 @@ declare class Staking {
|
|
|
5022
5244
|
* @returns The number of delegators for the given pool
|
|
5023
5245
|
*/
|
|
5024
5246
|
getNumberOfDelegators(args: {
|
|
5025
|
-
poolAddress:
|
|
5247
|
+
poolAddress: AccountAddressInput;
|
|
5026
5248
|
}): Promise<number>;
|
|
5027
5249
|
/**
|
|
5028
5250
|
* Queries current number of delegators in a pool. Throws an error if the pool is not found.
|
|
@@ -5042,8 +5264,8 @@ declare class Staking {
|
|
|
5042
5264
|
* @returns GetDelegatedStakingActivitiesResponse response type
|
|
5043
5265
|
*/
|
|
5044
5266
|
getDelegatedStakingActivities(args: {
|
|
5045
|
-
delegatorAddress:
|
|
5046
|
-
poolAddress:
|
|
5267
|
+
delegatorAddress: AccountAddressInput;
|
|
5268
|
+
poolAddress: AccountAddressInput;
|
|
5047
5269
|
}): Promise<GetDelegatedStakingActivitiesResponse>;
|
|
5048
5270
|
}
|
|
5049
5271
|
|
|
@@ -5156,10 +5378,10 @@ declare class TransactionSubmission {
|
|
|
5156
5378
|
* Sign a transaction that can later be submitted to chain
|
|
5157
5379
|
*
|
|
5158
5380
|
* @param args.signer The signer account to sign the transaction
|
|
5159
|
-
* @param args.transaction
|
|
5381
|
+
* @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
|
|
5160
5382
|
* ```
|
|
5161
5383
|
* {
|
|
5162
|
-
* rawTransaction:
|
|
5384
|
+
* rawTransaction: RawTransaction,
|
|
5163
5385
|
* secondarySignerAddresses? : Array<AccountAddress>,
|
|
5164
5386
|
* feePayerAddress?: AccountAddress
|
|
5165
5387
|
* }
|
|
@@ -5190,22 +5412,15 @@ declare class TransactionSubmission {
|
|
|
5190
5412
|
*
|
|
5191
5413
|
* @return PendingTransactionResponse
|
|
5192
5414
|
*/
|
|
5193
|
-
submitTransaction(args:
|
|
5194
|
-
transaction: AnyRawTransaction;
|
|
5195
|
-
senderAuthenticator: AccountAuthenticator;
|
|
5196
|
-
secondarySignerAuthenticators?: {
|
|
5197
|
-
feePayerAuthenticator?: AccountAuthenticator;
|
|
5198
|
-
additionalSignersAuthenticators?: Array<AccountAuthenticator>;
|
|
5199
|
-
};
|
|
5200
|
-
}): Promise<PendingTransactionResponse>;
|
|
5415
|
+
submitTransaction(args: InputSubmitTransactionData): Promise<PendingTransactionResponse>;
|
|
5201
5416
|
/**
|
|
5202
5417
|
* Sign and submit a single signer transaction to chain
|
|
5203
5418
|
*
|
|
5204
5419
|
* @param args.signer The signer account to sign the transaction
|
|
5205
|
-
* @param args.transaction
|
|
5420
|
+
* @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
|
|
5206
5421
|
* ```
|
|
5207
5422
|
* {
|
|
5208
|
-
* rawTransaction:
|
|
5423
|
+
* rawTransaction: RawTransaction,
|
|
5209
5424
|
* secondarySignerAddresses? : Array<AccountAddress>,
|
|
5210
5425
|
* feePayerAddress?: AccountAddress
|
|
5211
5426
|
* }
|
|
@@ -5231,11 +5446,25 @@ declare class TransactionSubmission {
|
|
|
5231
5446
|
* @returns A SingleSignerTransaction that can be simulated or submitted to chain
|
|
5232
5447
|
*/
|
|
5233
5448
|
publishPackageTransaction(args: {
|
|
5234
|
-
account:
|
|
5449
|
+
account: AccountAddressInput;
|
|
5235
5450
|
metadataBytes: HexInput;
|
|
5236
5451
|
moduleBytecode: Array<HexInput>;
|
|
5237
5452
|
options?: InputGenerateTransactionOptions;
|
|
5238
5453
|
}): Promise<InputSingleSignerTransaction>;
|
|
5454
|
+
/**
|
|
5455
|
+
* Rotate an account's auth key. After rotation, only the new private key can be used to sign txns for
|
|
5456
|
+
* the account.
|
|
5457
|
+
* Note: Only legacy Ed25519 scheme is supported for now.
|
|
5458
|
+
* More info: {@link https://aptos.dev/guides/account-management/key-rotation/}
|
|
5459
|
+
* @param args.fromAccount The account to rotate the auth key for
|
|
5460
|
+
* @param args.toNewPrivateKey The new private key to rotate to
|
|
5461
|
+
*
|
|
5462
|
+
* @returns PendingTransactionResponse
|
|
5463
|
+
*/
|
|
5464
|
+
rotateAuthKey(args: {
|
|
5465
|
+
fromAccount: Account$1;
|
|
5466
|
+
toNewPrivateKey: PrivateKey;
|
|
5467
|
+
}): Promise<TransactionResponse>;
|
|
5239
5468
|
}
|
|
5240
5469
|
|
|
5241
5470
|
/**
|
|
@@ -5248,6 +5477,7 @@ declare class TransactionSubmission {
|
|
|
5248
5477
|
declare class Aptos {
|
|
5249
5478
|
readonly config: AptosConfig;
|
|
5250
5479
|
readonly account: Account;
|
|
5480
|
+
readonly ans: ANS;
|
|
5251
5481
|
readonly coin: Coin;
|
|
5252
5482
|
readonly digitalAsset: DigitalAsset;
|
|
5253
5483
|
readonly event: Event;
|
|
@@ -5259,7 +5489,7 @@ declare class Aptos {
|
|
|
5259
5489
|
readonly transactionSubmission: TransactionSubmission;
|
|
5260
5490
|
constructor(settings?: AptosConfig);
|
|
5261
5491
|
}
|
|
5262
|
-
interface Aptos extends Account, Coin, DigitalAsset, Event, Faucet, FungibleAsset, General, Staking, Transaction, TransactionSubmission {
|
|
5492
|
+
interface Aptos extends Account, Coin, DigitalAsset, Event, Faucet, FungibleAsset, General, Staking, Transaction, ANS, TransactionSubmission {
|
|
5263
5493
|
}
|
|
5264
5494
|
|
|
5265
5495
|
/**
|
|
@@ -5467,7 +5697,7 @@ declare function generateTransactionPayloadWithABI(args: InputGenerateTransactio
|
|
|
5467
5697
|
*/
|
|
5468
5698
|
declare function generateRawTransaction(args: {
|
|
5469
5699
|
aptosConfig: AptosConfig;
|
|
5470
|
-
sender:
|
|
5700
|
+
sender: AccountAddressInput;
|
|
5471
5701
|
payload: AnyTransactionPayloadInstance;
|
|
5472
5702
|
options?: InputGenerateTransactionOptions;
|
|
5473
5703
|
}): Promise<RawTransaction>;
|
|
@@ -5515,14 +5745,7 @@ declare function sign(args: {
|
|
|
5515
5745
|
*
|
|
5516
5746
|
* @returns A SignedTransaction
|
|
5517
5747
|
*/
|
|
5518
|
-
declare function generateSignedTransaction(args:
|
|
5519
|
-
transaction: AnyRawTransaction;
|
|
5520
|
-
senderAuthenticator: AccountAuthenticator;
|
|
5521
|
-
secondarySignerAuthenticators?: {
|
|
5522
|
-
feePayerAuthenticator?: AccountAuthenticator;
|
|
5523
|
-
additionalSignersAuthenticators?: Array<AccountAuthenticator>;
|
|
5524
|
-
};
|
|
5525
|
-
}): Uint8Array;
|
|
5748
|
+
declare function generateSignedTransaction(args: InputSubmitTransactionData): Uint8Array;
|
|
5526
5749
|
/**
|
|
5527
5750
|
* Derive the raw transaction type - FeePayerRawTransaction or MultiAgentRawTransaction or RawTransaction
|
|
5528
5751
|
*
|
|
@@ -5540,10 +5763,7 @@ declare function deriveTransactionType(transaction: AnyRawTransaction): AnyRawTr
|
|
|
5540
5763
|
*
|
|
5541
5764
|
* @returns A SignedTransaction
|
|
5542
5765
|
*/
|
|
5543
|
-
declare function generateMultiSignersSignedTransaction(transaction: MultiAgentRawTransaction | FeePayerRawTransaction, senderAuthenticator: AccountAuthenticator,
|
|
5544
|
-
feePayerAuthenticator?: AccountAuthenticator;
|
|
5545
|
-
additionalSignersAuthenticators?: Array<AccountAuthenticator>;
|
|
5546
|
-
}): Uint8Array;
|
|
5766
|
+
declare function generateMultiSignersSignedTransaction(transaction: MultiAgentRawTransaction | FeePayerRawTransaction, senderAuthenticator: AccountAuthenticator, feePayerAuthenticator?: AccountAuthenticator, additionalSignersAuthenticators?: Array<AccountAuthenticator>): Uint8Array;
|
|
5547
5767
|
declare function getSigningMessage(rawTxn: AnyRawTransactionInstance): Uint8Array;
|
|
5548
5768
|
|
|
5549
5769
|
/**
|
|
@@ -5600,38 +5820,4 @@ declare function parseTypeTag(typeStr: string, options?: {
|
|
|
5600
5820
|
allowGenerics?: boolean;
|
|
5601
5821
|
}): TypeTag;
|
|
5602
5822
|
|
|
5603
|
-
|
|
5604
|
-
key: Uint8Array;
|
|
5605
|
-
chainCode: Uint8Array;
|
|
5606
|
-
};
|
|
5607
|
-
/**
|
|
5608
|
-
* Aptos derive path is 637
|
|
5609
|
-
*
|
|
5610
|
-
* See https://github.com/satoshilabs/slips/blob/master/slip-0044.md
|
|
5611
|
-
*/
|
|
5612
|
-
declare const APTOS_PATH_REGEX: RegExp;
|
|
5613
|
-
/**
|
|
5614
|
-
* A list of supported key types and associated seeds
|
|
5615
|
-
*/
|
|
5616
|
-
declare enum KeyType {
|
|
5617
|
-
ED25519 = "ed25519 seed"
|
|
5618
|
-
}
|
|
5619
|
-
/**
|
|
5620
|
-
* Checks if the BIP44 path is valid for Aptos
|
|
5621
|
-
* @param path the BIP44 path
|
|
5622
|
-
*
|
|
5623
|
-
* @returns true if the path is a valid Aptos path
|
|
5624
|
-
*/
|
|
5625
|
-
declare const isValidPath: (path: string) => boolean;
|
|
5626
|
-
/**
|
|
5627
|
-
* Derives a private key from a mnemonic seed phrase.
|
|
5628
|
-
*
|
|
5629
|
-
* To derive multiple keys from the same phrase, change the path
|
|
5630
|
-
* @param keyType the key type seed used to derive keys
|
|
5631
|
-
* @param path the BIP44 path
|
|
5632
|
-
* @param seedPhrase the mnemonic seed phrase
|
|
5633
|
-
* @param offset the offset used for key derivation, defaults to [HARDENED_OFFSET]
|
|
5634
|
-
*/
|
|
5635
|
-
declare const derivePrivateKeyFromMnemonic: (keyType: KeyType, path: string, seedPhrase: string, offset?: number) => DerivedKeys;
|
|
5636
|
-
|
|
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 };
|
|
5823
|
+
export { APTOS_BIP44_REGEX, APTOS_HARDENED_REGEX, Account$1 as Account, AccountAddress, AccountAddressInput, 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, CKDPriv, 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, GenerateAccountWithEd25519, GenerateAccountWithSingleSignerSecp256k1Key, GenesisPayload, GenesisTransactionResponse, GetAccountCoinsDataResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountOwnedObjectsResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountOwnedTokensQueryResponse, GetAptosRequestOptions, GetChainTopUserTransactionsResponse, GetCollectionDataResponse, GetCurrentFungibleAssetBalancesResponse, GetCurrentTokenOwnershipResponse, GetDelegatedStakingActivitiesResponse, GetEventsResponse, GetFungibleAssetActivitiesResponse, GetFungibleAssetMetadataResponse, GetNumberOfDelegatorsResponse, GetOwnedTokensResponse, GetProcessorStatusResponse, GetRequestOptions, GetTokenActivityResponse, GetTokenDataResponse, GraphqlQuery, HARDENED_OFFSET, 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, InputSubmitTransactionData, 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, NetworkToNetworkName, NetworkToNodeAPI, OrderBy, OrderByValue, PaginationArgs, ParsingError, ParsingResult, PendingTransactionResponse, PostAptosRequestOptions, PostRequestOptions, PrivateKey, PublicKey, RawTransaction, RawTransactionWithData, RoleType, RotationProofChallenge, 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, deriveKey, 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, isValidBIP44Path, isValidHardenedPath, mnemonicToSeed, objectStructTag, optionStructTag, outOfRangeErrorMessage, paginateWithCursor, parseTypeTag, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, request, sign, splitPath, standardizeTypeTags, stringStructTag, throwTypeMismatch, validateNumberInRange };
|