@aptos-labs/ts-sdk 0.0.0 → 0.0.1

package/src/types/index.ts

@@ -87,7 +87,7 @@ export enum TransactionAuthenticatorVariant {
   MultiEd25519 = 1,
   MultiAgent = 2,
   FeePayer = 3,
-  Secp256k1Ecdsa = 4,
+  SingleSenderTransactionAuthenticator = 4,
 }
 
 /**
@@ -97,7 +97,18 @@ export enum TransactionAuthenticatorVariant {
 export enum AccountAuthenticatorVariant {
   Ed25519 = 0,
   MultiEd25519 = 1,
-  Secp256k1 = 2,
+  SingleKey = 2,
+  MultiKey = 3,
+}
+
+export enum AnyPublicKeyVariant {
+  Ed25519 = 0,
+  Secp256k1 = 1,
+}
+
+export enum AnySignatureVariant {
+  Ed25519 = 0,
+  Secp256k1 = 1,
 }
 
 /**
@@ -117,7 +128,7 @@ export type AnyNumber = number | bigint;
  * behavior and interaction with the Aptos network
  */
 export type AptosSettings = {
-  readonly network: Network;
+  readonly network?: Network;
 
   readonly fullnode?: string;
 
@@ -126,6 +137,8 @@ export type AptosSettings = {
   readonly indexer?: string;
 
   readonly clientConfig?: ClientConfig;
+
+  readonly client?: Client;
 };
 
 /**
@@ -156,6 +169,30 @@ export type ClientConfig = {
   WITH_CREDENTIALS?: boolean;
 };
 
+export interface ClientRequest<Req> {
+  url: string;
+  method: "GET" | "POST";
+  body?: Req;
+  contentType?: string;
+  params?: any;
+  overrides?: ClientConfig;
+  headers?: Record<string, any>;
+}
+
+export interface ClientResponse<Res> {
+  status: number;
+  statusText: string;
+  data: Res;
+  config?: any;
+  request?: any;
+  response?: any;
+  headers?: any;
+}
+
+export interface Client {
+  provider<Req, Res>(requestOptions: ClientRequest<Req>): Promise<ClientResponse<Res>>;
+}
+
 /**
  * The API request type
  *
@@ -639,9 +676,9 @@ export type MoveUint32Type = number;
 export type MoveUint64Type = string;
 export type MoveUint128Type = string;
 export type MoveUint256Type = string;
-export type MoveAddressType = `0x${string}`;
-export type MoveObjectType = `0x${string}`;
-export type MoveStructType = `0x${string}::${string}::${string}`;
+export type MoveAddressType = string;
+export type MoveObjectType = string;
+export type MoveStructType = `${string}::${string}::${string}`;
 export type MoveOptionType = MoveType | null | undefined;
 /**
  * String representation of a on-chain Move struct type.
@@ -840,7 +877,7 @@ export type LedgerInfo = {
  */
 export type Block = {
   block_height: string;
-  block_hash: `0x${string}`;
+  block_hash: string;
   block_timestamp: string;
   first_version: string;
   last_version: string;
@@ -856,7 +893,7 @@ export type Block = {
 export type ViewRequestData = {
   function: MoveStructType;
   typeArguments?: Array<MoveResourceType>;
-  arguments?: Array<MoveValue>;
+  functionArguments?: Array<MoveValue>;
 };
 
 // REQUEST TYPES
@@ -875,7 +912,7 @@ export type ViewRequest = {
   /**
    * Arguments of the function
    */
-  arguments: Array<MoveValue>;
+  functionArguments: Array<MoveValue>;
 };
 
 /**
@@ -897,11 +934,6 @@ export type TableItemRequest = {
  */
 export type AuthenticationKeyScheme = SigningScheme | DeriveScheme;
 
-/**
- * A list of signing schemes that are supported by Aptos.
- *
- * https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs#L375-L378
- */
 export enum SigningScheme {
   /**
    * For Ed25519PublicKey
@@ -912,7 +944,22 @@ export enum SigningScheme {
    */
   MultiEd25519 = 1,
   /**
-   * For Secp256k1 ecdsa
+   * For SingleKey ecdsa
+   */
+  SingleKey = 2,
+}
+
+export enum SigningSchemeInput {
+  /**
+   * For Ed25519PublicKey
+   */
+  Ed25519 = 0,
+  /**
+   * For MultiEd25519PublicKey
+   */
+  MultiEd25519 = 1,
+  /**
+   * For Secp256k1Ecdsa
    */
   Secp256k1Ecdsa = 2,
 }
@@ -942,3 +989,34 @@ export enum DeriveScheme {
    */
   DeriveResourceAccountAddress = 255,
 }
+
+export type WaitForTransactionOptions = {
+  timeoutSecs?: number;
+  checkSuccess?: boolean;
+  indexerVersionCheck?: boolean;
+};
+/**
+ * Account input type to generate an account using Legacy
+ * Ed25519 or MultiEd25519 keys or without a specified `scheme`.
+ * If `scheme` is not specified, we default to ED25519
+ * In this case `legacy` is always true
+ */
+export type GenerateAccountWithLegacyKey = {
+  scheme?: SigningSchemeInput.Ed25519 | SigningSchemeInput.MultiEd25519;
+  legacy: true;
+};
+
+/**
+ * Account input type to generate an account using Unified
+ * Secp256k1Ecdsa key
+ * In this case `legacy` is always false
+ */
+export type GenerateAccountWithUnifiedKey = {
+  scheme: SigningSchemeInput.Secp256k1Ecdsa | SigningSchemeInput.Ed25519;
+  legacy?: false;
+};
+
+/**
+ * Unify GenerateAccount type for Legacy and Unified keys
+ */
+export type GenerateAccount = GenerateAccountWithLegacyKey | GenerateAccountWithUnifiedKey;

package/src/version.ts

@@ -6,4 +6,4 @@
  *
  * hardcoded for now, we would want to have it injected dynamically
  */
-export const VERSION = "0.0.0";
+export const VERSION = "2.0.0";