@moveindustries/ts-sdk 5.1.4

package/dist/esm/internal/ans.d.mts

@@ -0,0 +1,365 @@
+import { M as MovementConfig, s as AccountAddressInput, aG as InputGenerateTransactionOptions, c5 as PaginationArgs, c8 as OrderByArg, c9 as WhereArg, t as AccountAddress, ag as SimpleTransaction } from '../accountAddress-CNXtapt1.mjs';
+import { GetANSNameResponse } from '../types/indexer.mjs';
+import { CurrentAptosNamesBoolExp } from '../types/generated/types.mjs';
+import { A as Account } from '../Ed25519Account-DsqenvLJ.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../core/common.mjs';
+import '../types/generated/operations.mjs';
+
+/**
+ * This file contains the underlying implementations for exposed API surface in
+ * the {@link api/name}. By moving the methods out into a separate file,
+ * other namespaces and processes can access these methods without depending on the entire
+ * name namespace and without having a dependency cycle error.
+ * @group Implementation
+ */
+
+declare const VALIDATION_RULES_DESCRIPTION: string;
+/**
+ * Validate if a given fragment is a valid ANS segment.
+ * This function checks the length and character constraints of the fragment to ensure it meets the ANS standards.
+ *
+ * @param fragment - A fragment of a name, either the domain or subdomain.
+ * @returns A boolean indicating if the fragment is a valid fragment.
+ * @group Implementation
+ */
+declare function isValidANSSegment(fragment: string): boolean;
+/**
+ * Checks if an ANS name is valid or not.
+ *
+ * @param name - A string of the domain name, which can include or exclude the .apt suffix.
+ * @group Implementation
+ */
+declare function isValidANSName(name: string): {
+    domainName: string;
+    subdomainName?: string;
+};
+/**
+ * Policy for determining how subdomains expire in relation to their parent domain.
+ * @group Implementation
+ */
+declare enum SubdomainExpirationPolicy {
+    Independent = 0,
+    FollowsDomain = 1
+}
+/**
+ * Determine if a given ANS name is considered active based on its expiration dates.
+ * Domains are active if their expiration date is in the future, while subdomains may
+ * follow their parent's expiration policy (1) or expire independently (0).
+ * If the subdomain is expiring independently, it can expire before their parent, but not after.
+ *
+ * @param name - An ANS name returned from one of the functions of the SDK.
+ * @returns A boolean indicating whether the contract considers the name active or not.
+ * @group Implementation
+ */
+declare function isActiveANSName(name: GetANSNameResponse[0]): boolean;
+declare const LOCAL_ANS_ACCOUNT_PK: string;
+declare const LOCAL_ANS_ACCOUNT_ADDRESS: string;
+/**
+ * Retrieve the owner address of a specified domain or subdomain.
+ *
+ * @param args - The arguments for retrieving the owner address.
+ * @param args.movementConfig - The Movement configuration object.
+ * @param args.name - The name of the domain or subdomain to query.
+ * @returns The account address of the owner, or undefined if not found.
+ * @group Implementation
+ */
+declare function getOwnerAddress(args: {
+    movementConfig: MovementConfig;
+    name: string;
+}): Promise<AccountAddress | undefined>;
+/**
+ * Parameters for registering a name in the Movement network.
+ *
+ * @param movementConfig - Configuration settings for the Movement network.
+ * @param sender - The account initiating the name registration.
+ * @param name - The name to be registered.
+ * @param expiration - The expiration policy for the name registration.
+ * @param transferable - Whether the name can be transferred to another owner.
+ * @param toAddress - The address that will be set as the owner_address of the name.
+ * @param targetAddress - The address that this name will resolve to.
+ * @group Implementation
+ */
+interface RegisterNameParameters {
+    movementConfig: MovementConfig;
+    sender: Account;
+    name: string;
+    expiration: {
+        policy: "domain";
+        years?: 1;
+    } | {
+        policy: "subdomain:follow-domain";
+    } | {
+        policy: "subdomain:independent";
+        expirationDate: number;
+    };
+    transferable?: boolean;
+    toAddress?: AccountAddressInput;
+    targetAddress?: AccountAddressInput;
+    options?: InputGenerateTransactionOptions;
+}
+/**
+ * Registers a domain or subdomain with the specified parameters. This function ensures that the provided names and expiration
+ * policies are valid before proceeding with the registration process.
+ *
+ * @param args - The parameters required for registering a name.
+ * @param args.movementConfig - The configuration settings for Movement.
+ * @param args.expiration - The expiration details for the registration.
+ * @param args.name - The name to be registered, which can be a domain or subdomain.
+ * @param args.sender - The account details of the sender initiating the registration.
+ * @param args.targetAddress - The target address for the registration, which is the address the name will resolve to.
+ * @param args.toAddress - The address that will be set as the owner_address in records, defaults to sender if not provided.
+ * @param args.options - Additional options for the registration process.
+ * @param args.transferable - Indicates whether the registered name is transferable to another account.
+ *
+ * @throws Error if the provided expiration policy is invalid for subdomains.
+ * @throws Error if the domain does not exist.
+ * @throws Error if the subdomain expiration time exceeds the domain expiration time.
+ *
+ * @returns A transaction object representing the registration process.
+ * @group Implementation
+ */
+declare function registerName(args: RegisterNameParameters): Promise<SimpleTransaction>;
+/**
+ * Retrieves the expiration time of a specified domain or subdomain in epoch milliseconds.
+ *
+ * @param args - The arguments for the function.
+ * @param args.movementConfig - The configuration object for Movement.
+ * @param args.name - The name of the domain or subdomain to check.
+ * @returns The expiration time in epoch milliseconds, or undefined if an error occurs.
+ * @group Implementation
+ */
+declare function getExpiration(args: {
+    movementConfig: MovementConfig;
+    name: string;
+}): Promise<number | undefined>;
+/**
+ * Retrieves the primary name associated with a given account address.
+ * This function helps in obtaining the complete domain name by combining the subdomain and domain names.
+ *
+ * @param args - The arguments for retrieving the primary name.
+ * @param args.movementConfig - The Movement configuration object.
+ * @param args.address - The account address for which to retrieve the primary name.
+ * @returns The primary name as a string, or undefined if no domain name exists.
+ * @group Implementation
+ */
+declare function getPrimaryName(args: {
+    movementConfig: MovementConfig;
+    address: AccountAddressInput;
+}): Promise<string | undefined>;
+/**
+ * Sets the primary name for the specified account, allowing for the association of a domain or subdomain with the account.
+ * If no name is provided, it clears the existing primary name.
+ *
+ * @param args - The arguments for setting the primary name.
+ * @param args.movementConfig - The Movement configuration object.
+ * @param args.sender - The account that is sending the transaction.
+ * @param args.name - The name to set as the primary name. If omitted, the function will clear the primary name.
+ * @param args.options - Optional transaction generation options.
+ * @returns A transaction object representing the operation.
+ * @group Implementation
+ */
+declare function setPrimaryName(args: {
+    movementConfig: MovementConfig;
+    sender: Account;
+    name?: string;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Retrieves the target address associated with a given domain name and subdomain name.
+ * The target address is different from the owner address - it's the address this name
+ * resolves to, which may be different from who owns the name.
+ *
+ * @param args - The arguments for retrieving the target address.
+ * @param args.movementConfig - The Movement configuration object.
+ * @param args.name - The name of the domain, which may include a subdomain.
+ * @returns The target address as an AccountAddress, or undefined if not found.
+ * @group Implementation
+ */
+declare function getTargetAddress(args: {
+    movementConfig: MovementConfig;
+    name: string;
+}): Promise<AccountAddress | undefined>;
+/**
+ * Sets the target address for a specified domain and subdomain in the Movement network.
+ * This function helps to associate a given address with a domain name, allowing for easier access and management of resources.
+ *
+ * @param args - The arguments for setting the target address.
+ * @param args.movementConfig - The configuration settings for the Movement network.
+ * @param args.sender - The account that is sending the transaction.
+ * @param args.name - The name of the domain or subdomain to be set.
+ * @param args.address - The address to be associated with the domain or subdomain.
+ * @param args.options - Optional parameters for generating the transaction.
+ *
+ * @returns A transaction object representing the set target address operation.
+ * @group Implementation
+ */
+declare function setTargetAddress(args: {
+    movementConfig: MovementConfig;
+    sender: Account;
+    name: string;
+    address: AccountAddressInput;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Retrieves the active Movement name associated with the specified domain and subdomain.
+ *
+ * @param args - The parameters for the function.
+ * @param args.movementConfig - The configuration object for Movement.
+ * @param args.name - The name to look up, which includes the domain and optional subdomain.
+ * @returns The active Movement name if it exists; otherwise, returns undefined.
+ * @group Implementation
+ */
+declare function getName(args: {
+    movementConfig: MovementConfig;
+    name: string;
+}): Promise<GetANSNameResponse[0] | undefined>;
+/**
+ * Options for querying names, including pagination, ordering, and filtering criteria.
+ *
+ * @param options - Pagination and filtering options for the query.
+ * @group Implementation
+ */
+interface QueryNamesOptions {
+    options?: PaginationArgs & OrderByArg<GetANSNameResponse[0]> & WhereArg<CurrentAptosNamesBoolExp>;
+}
+/**
+ * Arguments for retrieving account names based on the specified account address.
+ *
+ * @param accountAddress - The address of the account for which names are to be retrieved.
+ * @group Implementation
+ */
+interface GetAccountNamesArgs extends QueryNamesOptions {
+    accountAddress: AccountAddressInput;
+}
+/**
+ * Retrieves all the current Movement names owned by an account. This uses the
+ * owner_address field, not the registered_address field.
+ *
+ * @param args - The arguments for retrieving account names.
+ * @param args.movementConfig - The configuration object for Movement.
+ * @param args.options - Optional parameters for querying account names.
+ * @param args.options.limit - The maximum number of names to retrieve.
+ * @param args.options.offset - The number of names to skip before starting to collect the result set.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.accountAddress - The address of the account for which to retrieve names.
+ *
+ * @returns An array of sanitized Movement names associated with the specified account address.
+ * @group Implementation
+ */
+declare function getAccountNames(args: {
+    movementConfig: MovementConfig;
+} & GetAccountNamesArgs): Promise<GetANSNameResponse>;
+/**
+ * Arguments for retrieving the domains associated with a specific account.
+ *
+ * @param accountAddress - The address of the account for which to fetch domains.
+ * @group Implementation
+ */
+interface GetAccountDomainsArgs extends QueryNamesOptions {
+    accountAddress: AccountAddressInput;
+}
+/**
+ * Retrieves the list of top-level domains owned by a specified account,
+ * using the owner_address field.
+ *
+ * @param args - The arguments for retrieving account domains.
+ * @param args.movementConfig - The Movement configuration object.
+ * @param args.options - Optional parameters for the query.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the result set.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.options.where.owner_address - The address of the account whose domains are being queried.
+ * @param args.options.where.expiration_timestamp - The minimum expiration timestamp for the domains.
+ * @param args.options.where.subdomain - The specific subdomain to filter by.
+ *
+ * @returns An array of sanitized domain names owned by the specified account.
+ * @group Implementation
+ */
+declare function getAccountDomains(args: {
+    movementConfig: MovementConfig;
+} & GetAccountDomainsArgs): Promise<GetANSNameResponse>;
+/**
+ * Arguments for retrieving subdomains associated with a specific account.
+ *
+ * @param accountAddress - The address of the account for which to fetch subdomains.
+ * @group Implementation
+ */
+interface GetAccountSubdomainsArgs extends QueryNamesOptions {
+    accountAddress: AccountAddressInput;
+}
+/**
+ * Retrieves a list of subdomains owned by a specified account address, determined
+ * by the owner_address field.
+ *
+ * @param args - The arguments for retrieving account subdomains.
+ * @param args.movementConfig - The configuration object for Movement.
+ * @param args.options - Optional parameters for the query.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the result set.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.options.where.owner_address - The address of the account to filter by.
+ * @param args.options.where.expiration_timestamp - The expiration timestamp to filter by.
+ * @param args.options.where.subdomain - The subdomain condition to filter by.
+ * @param args.accountAddress - The address of the account whose subdomains are being queried.
+ * @group Implementation
+ */
+declare function getAccountSubdomains(args: {
+    movementConfig: MovementConfig;
+} & GetAccountSubdomainsArgs): Promise<GetANSNameResponse>;
+/**
+ * Arguments for retrieving subdomains associated with a specific domain.
+ *
+ * @param domain - The domain for which to fetch subdomains.
+ * @group Implementation
+ */
+interface GetDomainSubdomainsArgs extends QueryNamesOptions {
+    domain: string;
+}
+/**
+ * Retrieve the active subdomains associated with a specified domain,
+ * regardless of who is in possession of the domain.
+ *
+ * This function queries by domain name only, not by owner, so it will return
+ * all subdomains of a domain even if they're owned by different accounts.
+ *
+ * @param args - The arguments for retrieving subdomains.
+ * @param args.movementConfig - The configuration settings for Movement.
+ * @param args.options - Optional parameters for the query.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the results.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.domain - The domain for which to retrieve subdomains.
+ *
+ * @returns An array of active subdomain names.
+ * @group Implementation
+ */
+declare function getDomainSubdomains(args: {
+    movementConfig: MovementConfig;
+} & GetDomainSubdomainsArgs): Promise<GetANSNameResponse>;
+/**
+ * Renews a domain for a specified duration. This function allows you to extend the registration of a domain for one year.
+ *
+ * @param args - The parameters required to renew the domain.
+ * @param args.movementConfig - The configuration settings for Movement.
+ * @param args.sender - The account that is sending the renewal transaction.
+ * @param args.name - The name of the domain to renew.
+ * @param args.years - The number of years to renew the domain for. Currently, only 1 year renewals are supported. (optional, default is 1)
+ * @param args.options - Additional options for generating the transaction. (optional)
+ * @throws Error if the name contains a subdomain or if the years parameter is not equal to 1.
+ * @group Implementation
+ */
+declare function renewDomain(args: {
+    movementConfig: MovementConfig;
+    sender: Account;
+    name: string;
+    years?: 1;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+
+export { type GetAccountDomainsArgs, type GetAccountNamesArgs, type GetAccountSubdomainsArgs, type GetDomainSubdomainsArgs, LOCAL_ANS_ACCOUNT_ADDRESS, LOCAL_ANS_ACCOUNT_PK, type RegisterNameParameters, SubdomainExpirationPolicy, VALIDATION_RULES_DESCRIPTION, getAccountDomains, getAccountNames, getAccountSubdomains, getDomainSubdomains, getExpiration, getName, getOwnerAddress, getPrimaryName, getTargetAddress, isActiveANSName, isValidANSName, isValidANSSegment, registerName, renewDomain, setPrimaryName, setTargetAddress };

package/dist/esm/internal/ans.mjs

@@ -0,0 +1,2 @@
+import{bd as a,cd as b,dd as c,ed as d,fd as e,gd as f,hd as g,id as h,jd as i,kd as j,ld as k,md as l,nd as m,od as n,pd as o,qd as p,rd as q,sd as r,td as s,ud as t}from"../chunk-47V7UGV5.mjs";import"../chunk-A5L76YP7.mjs";import"../chunk-YFFYA5U3.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-G3MHXDYA.mjs";import"../chunk-RUIFVDWM.mjs";import"../chunk-WVDICMU4.mjs";import"../chunk-2KDUIZKB.mjs";import"../chunk-OOOAVIMQ.mjs";import"../chunk-V3O2SBO4.mjs";import"../chunk-D6HPXGEP.mjs";import"../chunk-5HXLZHDW.mjs";import"../chunk-7TTTMBAK.mjs";import"../chunk-GOXRBEIJ.mjs";import"../chunk-2QTV4AOE.mjs";import"../chunk-PHRRBT44.mjs";import"../chunk-VEZCMPUG.mjs";import"../chunk-CHWDP6AR.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-ZP4DWSQA.mjs";import"../chunk-NUB6KE73.mjs";import"../chunk-I6YGBK5S.mjs";import"../chunk-S4D2KBYN.mjs";import"../chunk-CRCE7R4D.mjs";import"../chunk-NQUZ4UHR.mjs";import"../chunk-NMFJJOGW.mjs";import"../chunk-5ZKA765G.mjs";import"../chunk-FJRPU2NH.mjs";import"../chunk-UL777LTI.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-SYXDZA4K.mjs";import"../chunk-R2G23RIY.mjs";import"../chunk-MEWW7VTQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ANTEUWH6.mjs";import"../chunk-KPJGWDSQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-PZ233FIY.mjs";import"../chunk-VW3WBAAD.mjs";import"../chunk-PCESRJYO.mjs";import"../chunk-KDMSOCZY.mjs";export{g as LOCAL_ANS_ACCOUNT_ADDRESS,f as LOCAL_ANS_ACCOUNT_PK,d as SubdomainExpirationPolicy,a as VALIDATION_RULES_DESCRIPTION,q as getAccountDomains,p as getAccountNames,r as getAccountSubdomains,s as getDomainSubdomains,j as getExpiration,o as getName,h as getOwnerAddress,k as getPrimaryName,m as getTargetAddress,e as isActiveANSName,c as isValidANSName,b as isValidANSSegment,i as registerName,t as renewDomain,l as setPrimaryName,n as setTargetAddress};
+//# sourceMappingURL=ans.mjs.map

package/dist/esm/internal/ans.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/internal/coin.d.mts

@@ -0,0 +1,31 @@
+import { M as MovementConfig, s as AccountAddressInput, c3 as AnyNumber, dr as MoveStructId, aG as InputGenerateTransactionOptions, ag as SimpleTransaction } from '../accountAddress-CNXtapt1.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../core/common.mjs';
+
+/**
+ * Generates a transaction to transfer coins from one account to another.
+ * This function allows you to specify the sender, recipient, amount, and coin type for the transaction.
+ *
+ * @param args - The parameters for the transaction.
+ * @param args.movementConfig - The Movement configuration object.
+ * @param args.sender - The address of the account sending the coins.
+ * @param args.recipient - The address of the account receiving the coins.
+ * @param args.amount - The amount of coins to transfer.
+ * @param args.coinType - (Optional) The type of coin to transfer, defaults to Movement Coin if not specified.
+ * @param args.options - (Optional) Options for generating the transaction.
+ * @group Implementation
+ */
+declare function transferCoinTransaction(args: {
+    movementConfig: MovementConfig;
+    sender: AccountAddressInput;
+    recipient: AccountAddressInput;
+    amount: AnyNumber;
+    coinType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+
+export { transferCoinTransaction };

package/dist/esm/internal/coin.mjs

@@ -0,0 +1,2 @@
+import{wd as a}from"../chunk-47V7UGV5.mjs";import"../chunk-A5L76YP7.mjs";import"../chunk-YFFYA5U3.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-G3MHXDYA.mjs";import"../chunk-RUIFVDWM.mjs";import"../chunk-WVDICMU4.mjs";import"../chunk-2KDUIZKB.mjs";import"../chunk-OOOAVIMQ.mjs";import"../chunk-V3O2SBO4.mjs";import"../chunk-D6HPXGEP.mjs";import"../chunk-5HXLZHDW.mjs";import"../chunk-7TTTMBAK.mjs";import"../chunk-GOXRBEIJ.mjs";import"../chunk-2QTV4AOE.mjs";import"../chunk-PHRRBT44.mjs";import"../chunk-VEZCMPUG.mjs";import"../chunk-CHWDP6AR.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-ZP4DWSQA.mjs";import"../chunk-NUB6KE73.mjs";import"../chunk-I6YGBK5S.mjs";import"../chunk-S4D2KBYN.mjs";import"../chunk-CRCE7R4D.mjs";import"../chunk-NQUZ4UHR.mjs";import"../chunk-NMFJJOGW.mjs";import"../chunk-5ZKA765G.mjs";import"../chunk-FJRPU2NH.mjs";import"../chunk-UL777LTI.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-SYXDZA4K.mjs";import"../chunk-R2G23RIY.mjs";import"../chunk-MEWW7VTQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ANTEUWH6.mjs";import"../chunk-KPJGWDSQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-PZ233FIY.mjs";import"../chunk-VW3WBAAD.mjs";import"../chunk-PCESRJYO.mjs";import"../chunk-KDMSOCZY.mjs";export{a as transferCoinTransaction};
+//# sourceMappingURL=coin.mjs.map

package/dist/esm/internal/coin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}