@ar.io/sdk 4.0.0-solana.8 → 4.0.0

package/lib/types/types/ant.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { z } from 'zod';
-import { AoMessageResult, AoWriteAction, UpgradeAntProgressEvent, WalletAddress } from './common.js';
+import { MessageResult, UpgradeAntProgressEvent, WalletAddress, WriteAction } from './common.js';
 /**
  * example error:
  *  {
@@ -28,7 +28,7 @@ import { AoMessageResult, AoWriteAction, UpgradeAntProgressEvent, WalletAddress
       },
  */
 export declare const ArweaveTxIdSchema: z.ZodEffects<z.ZodString, string, string>;
-export declare const AOAddressSchema: z.ZodString;
+export declare const WalletAddressSchema: z.ZodString;
 export declare const IntegerStringSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const AntDescriptionSchema: z.ZodString;
 export declare const AntKeywordsSchema: z.ZodArray<z.ZodString, "many">;
@@ -46,26 +46,26 @@ export declare const AntRecordSchema: z.ZodObject<{
     transactionId: string;
     ttlSeconds: number;
     targetProtocol: number;
+    owner?: string | undefined;
     description?: string | undefined;
     priority?: number | undefined;
-    owner?: string | undefined;
     displayName?: string | undefined;
     logo?: string | undefined;
     keywords?: string[] | undefined;
 }, {
     transactionId: string;
     ttlSeconds: number;
+    owner?: string | undefined;
     description?: string | undefined;
     targetProtocol?: number | undefined;
     priority?: number | undefined;
-    owner?: string | undefined;
     displayName?: string | undefined;
     logo?: string | undefined;
     keywords?: string[] | undefined;
 }>;
-export type AoANTRecord = z.infer<typeof AntRecordSchema>;
-export type ANTRecords = Record<string, AoANTRecord>;
-export type SortedANTRecord = AoANTRecord & {
+export type ANTRecord = z.infer<typeof AntRecordSchema>;
+export type ANTRecords = Record<string, ANTRecord>;
+export type SortedANTRecord = ANTRecord & {
     index: number;
 };
 export type SortedANTRecords = Record<string, SortedANTRecord>;
@@ -83,19 +83,19 @@ export declare const AntRecordsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     transactionId: string;
     ttlSeconds: number;
     targetProtocol: number;
+    owner?: string | undefined;
     description?: string | undefined;
     priority?: number | undefined;
-    owner?: string | undefined;
     displayName?: string | undefined;
     logo?: string | undefined;
     keywords?: string[] | undefined;
 }, {
     transactionId: string;
     ttlSeconds: number;
+    owner?: string | undefined;
     description?: string | undefined;
     targetProtocol?: number | undefined;
     priority?: number | undefined;
-    owner?: string | undefined;
     displayName?: string | undefined;
     logo?: string | undefined;
     keywords?: string[] | undefined;
@@ -124,19 +124,19 @@ export declare const AntStateSchema: z.ZodObject<{
         transactionId: string;
         ttlSeconds: number;
         targetProtocol: number;
+        owner?: string | undefined;
         description?: string | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
     }, {
         transactionId: string;
         ttlSeconds: number;
+        owner?: string | undefined;
         description?: string | undefined;
         targetProtocol?: number | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
@@ -157,9 +157,9 @@ export declare const AntStateSchema: z.ZodObject<{
         transactionId: string;
         ttlSeconds: number;
         targetProtocol: number;
+        owner?: string | undefined;
         description?: string | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
@@ -179,10 +179,10 @@ export declare const AntStateSchema: z.ZodObject<{
     Records: Record<string, {
         transactionId: string;
         ttlSeconds: number;
+        owner?: string | undefined;
         description?: string | undefined;
         targetProtocol?: number | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
@@ -192,23 +192,25 @@ export declare const AntStateSchema: z.ZodObject<{
     TotalSupply: number;
     Initialized: boolean;
 }>;
-export type AoANTState = z.infer<typeof AntStateSchema>;
-export type HyperBeamANTState = {
+export type ANTState = z.infer<typeof AntStateSchema>;
+/**
+ * Lightweight ANT view for portfolio/list rendering. Carries the config fields
+ * plus controllers and the apex (`@`) record — everything a names table needs —
+ * WITHOUT the full undername record set. Produced in bulk by
+ * `getANTSummaries(mints)` in a handful of `getMultipleAccounts` calls; fetch
+ * full undernames lazily via `getRecords`/`getState` when a name is opened.
+ */
+export type ANTSummary = {
+    processId: string;
     name: string;
     ticker: string;
+    logo: string;
     description: string;
     keywords: string[];
-    denomination: string;
-    owner: string;
-    controllers: string[];
-    records: Record<string, {
-        transactionid: string;
-        ttlseconds: number;
-    }>;
-    balances: Record<string, number>;
-    logo: string;
-    totalsupply: number;
-    initialized: boolean;
+    owner: WalletAddress;
+    controllers: WalletAddress[];
+    /** The apex (`@`) record — the name's primary target — if set. */
+    apexRecord?: ANTRecord;
 };
 export declare const SpawnANTStateSchema: z.ZodObject<{
     name: z.ZodString;
@@ -231,19 +233,19 @@ export declare const SpawnANTStateSchema: z.ZodObject<{
         transactionId: string;
         ttlSeconds: number;
         targetProtocol: number;
+        owner?: string | undefined;
         description?: string | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
     }, {
         transactionId: string;
         ttlSeconds: number;
+        owner?: string | undefined;
         description?: string | undefined;
         targetProtocol?: number | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
@@ -251,40 +253,40 @@ export declare const SpawnANTStateSchema: z.ZodObject<{
     balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
     logo: z.ZodEffects<z.ZodString, string, string>;
 }, "strip", z.ZodTypeAny, {
-    description: string;
     owner: string;
+    name: string;
+    description: string;
     logo: string;
     keywords: string[];
-    name: string;
     ticker: string;
     controllers: string[];
     records: Record<string, {
         transactionId: string;
         ttlSeconds: number;
         targetProtocol: number;
+        owner?: string | undefined;
         description?: string | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
     }>;
     balances: Record<string, number>;
 }, {
-    description: string;
     owner: string;
+    name: string;
+    description: string;
     logo: string;
     keywords: string[];
-    name: string;
     ticker: string;
     controllers: string[];
     records: Record<string, {
         transactionId: string;
         ttlSeconds: number;
+        owner?: string | undefined;
         description?: string | undefined;
         targetProtocol?: number | undefined;
         priority?: number | undefined;
-        owner?: string | undefined;
         displayName?: string | undefined;
         logo?: string | undefined;
         keywords?: string[] | undefined;
@@ -293,11 +295,11 @@ export declare const SpawnANTStateSchema: z.ZodObject<{
 }>;
 export type SpawnANTState = z.infer<typeof SpawnANTStateSchema>;
 export declare const AntReadHandlers: readonly ["balance", "balances", "totalSupply", "info", "controllers", "record", "records", "state"];
-export type AoANTReadHandler = (typeof AntReadHandlers)[number];
+export type ANTReadHandler = (typeof AntReadHandlers)[number];
 export declare const AntWriteHandlers: readonly ["_eval", "_default", "transfer", "addController", "removeController", "setRecord", "removeRecord", "setName", "setTicker", "setDescription", "setKeywords", "setLogo", "initializeState", "releaseName", "reassignName", "approvePrimaryName", "removePrimaryNames", "transferRecordOwnership"];
-export type AoANTWriteHandler = (typeof AntWriteHandlers)[number];
-export declare const AntHandlerNames: ("controllers" | "records" | "balances" | "balance" | "totalSupply" | "info" | "record" | "state" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName" | "approvePrimaryName" | "removePrimaryNames" | "transferRecordOwnership")[];
-export type AoANTHandler = AoANTWriteHandler | AoANTReadHandler;
+export type ANTWriteHandler = (typeof AntWriteHandlers)[number];
+export declare const AntHandlerNames: ("record" | "balance" | "controllers" | "records" | "balances" | "totalSupply" | "info" | "state" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName" | "approvePrimaryName" | "removePrimaryNames" | "transferRecordOwnership")[];
+export type ANTHandler = ANTWriteHandler | ANTReadHandler;
 export declare const AntHandlersSchema: z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>;
 export declare const AntInfoSchema: z.ZodObject<{
     Name: z.ZodString;
@@ -333,22 +335,30 @@ export declare const AntInfoSchema: z.ZodObject<{
     Handlers?: string[] | undefined;
     HandlerNames?: string[] | undefined;
 }>;
-export type AoANTInfo = z.infer<typeof AntInfoSchema>;
+export type ANTInfo = z.infer<typeof AntInfoSchema>;
 /**
  * @param state {object}
  * @returns {boolean}
  */
-export declare function isAoANTState(state: object): state is AoANTState;
+export declare function isANTState(state: object): state is ANTState;
 export type AntReadOptions = {
     strict?: boolean;
+    /**
+     * Include per-record metadata (`displayName`/`logo`/`description`/`keywords`)
+     * when reading undername records. Defaults to `false` — metadata requires a
+     * second `getProgramAccounts` scan per ANT and is only needed in detail/edit
+     * views, so list reads (`getState`/`getRecords`) skip it by default. Fetch a
+     * single record's metadata on demand via `getRecord`.
+     */
+    includeMetadata?: boolean;
 };
-export interface AoANTRead {
+export interface ANTRead {
     processId: string;
-    getState(opts?: AntReadOptions): Promise<AoANTState>;
-    getInfo(opts?: AntReadOptions): Promise<AoANTInfo>;
+    getState(opts?: AntReadOptions): Promise<ANTState>;
+    getInfo(opts?: AntReadOptions): Promise<ANTInfo>;
     getRecord({ undername }: {
         undername: string;
-    }, opts?: AntReadOptions): Promise<AoANTRecord | undefined>;
+    }, opts?: AntReadOptions): Promise<ANTRecord | undefined>;
     getRecords(opts?: AntReadOptions): Promise<SortedANTRecords>;
     getOwner(opts?: AntReadOptions): Promise<WalletAddress>;
     getControllers(): Promise<WalletAddress[]>;
@@ -359,7 +369,7 @@ export interface AoANTRead {
         address: WalletAddress;
     }, opts?: AntReadOptions): Promise<number>;
     getBalances(opts?: AntReadOptions): Promise<Record<WalletAddress, number>>;
-    getHandlers(): Promise<AoANTHandler[]>;
+    getHandlers(): Promise<ANTHandler[]>;
     getModuleId(opts?: {
         graphqlUrl?: string;
         retries?: number;
@@ -375,58 +385,71 @@ export interface AoANTRead {
         retries?: number;
     }): Promise<boolean>;
 }
-export interface AoANTWrite extends AoANTRead {
-    transfer: AoWriteAction<{
+export interface ANTWrite extends ANTRead {
+    /**
+     * Transfer ANT ownership to `target`.
+     *
+     * Note: ex-controllers are always cleared as part of the transfer. The
+     * Solana `ario-ant` contract clears `AntControllers` via inline reconcile,
+     * and the wrapped CPI also clears each ex-controller's paginated ACL
+     * entry in the same tx. Skipping cleanup would leave stale "I control
+     * this ANT" entries visible to frontends. This was an opt-in flag in
+     * the AO era; on Solana it is intrinsic to the transfer flow.
+     */
+    transfer: WriteAction<{
         target: WalletAddress;
-        removeControllers?: boolean;
     }>;
-    addController: AoWriteAction<{
+    addController: WriteAction<{
         controller: WalletAddress;
     }>;
-    removeController: AoWriteAction<{
+    removeController: WriteAction<{
         controller: WalletAddress;
     }>;
-    /** @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@") */
-    setRecord: AoWriteAction<AoANTSetUndernameRecordParams>;
+    /**
+     * @deprecated Use `setUndernameRecord` for undernames and
+     * `setBaseNameRecord` for the top-level name (`"@"`). This bridge
+     * accepts either shape so existing callers continue to type-check.
+     */
+    setRecord: WriteAction<ANTSetBaseNameRecordParams | ANTSetUndernameRecordParams>;
     /** @deprecated Use removeUndernameRecord instead for undernames */
-    removeRecord: AoWriteAction<{
+    removeRecord: WriteAction<{
         undername: string;
     }>;
-    setBaseNameRecord: AoWriteAction<AoANTSetBaseNameRecordParams>;
-    setUndernameRecord: AoWriteAction<AoANTSetUndernameRecordParams>;
-    removeUndernameRecord: AoWriteAction<{
+    setBaseNameRecord: WriteAction<ANTSetBaseNameRecordParams>;
+    setUndernameRecord: WriteAction<ANTSetUndernameRecordParams>;
+    removeUndernameRecord: WriteAction<{
         undername: string;
     }>;
-    setTicker: AoWriteAction<{
+    setTicker: WriteAction<{
         ticker: string;
     }>;
-    setDescription: AoWriteAction<{
+    setDescription: WriteAction<{
         description: string;
     }>;
-    setKeywords: AoWriteAction<{
+    setKeywords: WriteAction<{
         keywords: string[];
     }>;
-    setName: AoWriteAction<{
+    setName: WriteAction<{
         name: string;
     }>;
-    setLogo: AoWriteAction<{
+    setLogo: WriteAction<{
         txId: string;
     }>;
-    releaseName: AoWriteAction<{
+    releaseName: WriteAction<{
         name: string;
         arioProcessId: string;
     }>;
-    reassignName: AoWriteAction<{
+    reassignName: WriteAction<{
         name: string;
         arioProcessId: string;
         antProcessId: string;
     }>;
-    approvePrimaryNameRequest: AoWriteAction<{
+    approvePrimaryNameRequest: WriteAction<{
         name: string;
         address: string;
         arioProcessId: string;
     }>;
-    removePrimaryNames: AoWriteAction<{
+    removePrimaryNames: WriteAction<{
         names: string[];
         arioProcessId: string;
         notifyOwners?: boolean;
@@ -444,18 +467,18 @@ export interface AoANTWrite extends AoANTRead {
         reassignAffiliatedNames?: true;
     })): Promise<{
         forkedProcessId: string;
-        reassignedNames: Record<string, AoMessageResult>;
+        reassignedNames: Record<string, MessageResult>;
         failedReassignedNames: Record<string, {
             id?: string;
             error: Error;
         }>;
     }>;
-    transferRecord: AoWriteAction<{
+    transferRecord: WriteAction<{
         undername: string;
         recipient: string;
     }>;
 }
-export type AoANTSetBaseNameRecordParams = {
+export type ANTSetBaseNameRecordParams = {
     transactionId: string;
     ttlSeconds: number;
     /** Storage protocol: 0 = Arweave, 1 = IPFS. Defaults to 0 (Arweave). */
@@ -467,29 +490,6 @@ export type AoANTSetBaseNameRecordParams = {
     description?: string;
     keywords?: string[];
 };
-export type AoANTSetUndernameRecordParams = AoANTSetBaseNameRecordParams & {
+export type ANTSetUndernameRecordParams = ANTSetBaseNameRecordParams & {
     undername: string;
 };
-export interface AoANTVersionsRead {
-    getANTVersions(): Promise<Record<string, {
-        moduleId: string;
-        luaSourceId?: string;
-        notes?: string;
-        releaseTimestamp: number;
-    }>>;
-    getLatestANTVersion(): Promise<{
-        version: string;
-        moduleId: string;
-        luaSourceId?: string;
-        notes?: string;
-        releaseTimestamp: number;
-    }>;
-}
-export interface AoANTVersionsWrite extends AoANTVersionsRead {
-    addVersion: AoWriteAction<{
-        version: string;
-        moduleId: string;
-        luaSourceId?: string;
-        notes?: string;
-    }>;
-}

package/lib/types/types/common.d.ts

@@ -13,32 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ArconnectSigner, ArweaveSigner, EthereumSigner, InjectedEthereumSigner, Signer } from '@dha-team/arbundles';
-import { dryrun, message, monitor, result, results, spawn, unmonitor } from '@permaweb/aoconnect';
-import Arweave from 'arweave';
-import { SpawnANTState } from './ant.js';
-import { AoArNSPurchaseParams, AoBuyRecordParams } from './io.js';
-import { AoSigner } from './token.js';
+import { ArNSPurchaseParams, BuyRecordParams } from './io.js';
 export type BlockHeight = number;
 export type SortKey = string;
 export type Timestamp = number;
 export type WalletAddress = string;
 export type TransactionId = string;
 export type ProcessId = string;
-export type OptionalArweave<T = NonNullable<unknown>> = {
-    arweave?: Arweave;
-} & T;
-export type OptionalPaymentUrl<T = NonNullable<unknown>> = {
-    paymentUrl?: string;
-} & T;
-export type TurboArNSSigner = EthereumSigner | InjectedEthereumSigner | ArweaveSigner | ArconnectSigner | Window['arweaveWallet'];
-export type ContractSigner = Signer | Window['arweaveWallet'] | AoSigner;
-export type WithSigner<T = NonNullable<unknown>> = {
-    signer: ContractSigner;
-} & T;
-export type OptionalSigner<T = NonNullable<unknown>> = {
-    signer?: ContractSigner | undefined;
-} & T;
 export type ReadParameters<Input> = {
     functionName: string;
     inputs?: Input;
@@ -50,28 +31,32 @@ export type WriteOptions<K extends string = string, T = unknown> = {
     }[];
     onSigningProgress?: (name: K, payload: T) => void;
 };
-export type WriteParameters<Input> = WithSigner<Required<ReadParameters<Input>>>;
-export type AoMessageResult<T = Record<string, string | number | boolean | null>> = {
+/**
+ * Result envelope shared with the legacy AO message-pump shape. Solana
+ * transactions surface their signature via `id` and may include a typed
+ * `result` payload for handlers that return structured data.
+ */
+export type MessageResult<T = Record<string, string | number | boolean | null>> = {
     id: string;
     result?: T;
 };
-export type AoPrimaryNameRequest = {
+export type PrimaryNameRequest = {
     name: string;
     initiator: WalletAddress;
     startTimestamp: Timestamp;
     endTimestamp: Timestamp;
 };
-export type AoCreatePrimaryNameRequest = {
-    request: Omit<AoPrimaryNameRequest, 'initiator'> & {
+export type CreatePrimaryNameRequest = {
+    request: Omit<PrimaryNameRequest, 'initiator'> & {
         initiator: WalletAddress;
     };
-    newPrimaryName: AoPrimaryName;
+    newPrimaryName: PrimaryName;
     baseNameOwner: WalletAddress;
     fundingPlan: Record<string, unknown>;
     fundingResult: Record<string, unknown>;
     demandFactor: Record<string, unknown>;
 };
-export type AoPrimaryName = {
+export type PrimaryName = {
     owner: WalletAddress;
     processId: ProcessId;
     name: string;
@@ -81,7 +66,7 @@ export type AoPrimaryName = {
  * Users are allowed one free redelegation every seven epochs. Each additional
  * redelegation increases the fee by 10%, capping at a 60% redelegation fee
  */
-export type AoRedelegationFeeInfo = {
+export type RedelegationFeeInfo = {
     /** Percentage of redelegated stake that will be returned to the protocol on redelegation */
     redelegationFeeRate: number;
     /** Timestamp when the redelegation fee will reset to zero */
@@ -99,21 +84,12 @@ export interface HTTPClient {
         params?: object | I;
     }): Promise<K>;
 }
-export interface AoClient {
-    result: typeof result;
-    results: typeof results;
-    message: typeof message;
-    spawn: typeof spawn;
-    monitor: typeof monitor;
-    unmonitor: typeof unmonitor;
-    dryrun: typeof dryrun;
-}
 export type SpawnAntProgressEvent = {
     'spawning-ant': {
         moduleId: string;
         antRegistryId: string;
         version: string | undefined;
-        state: SpawnANTState | undefined;
+        state: unknown;
     };
     'verifying-state': {
         processId: ProcessId;
@@ -158,54 +134,22 @@ export type UpgradeAntProgressEvent = SpawnAntProgressEvent & {
     };
 };
 export type BuyArNSNameProgressEvents = SpawnAntProgressEvent & {
-    'buying-name': AoBuyRecordParams;
+    'buying-name': BuyRecordParams;
 };
 export type SetPrimaryNameProgressEvents = {
-    'requesting-primary-name': AoArNSPurchaseParams;
+    'requesting-primary-name': ArNSPurchaseParams;
     'request-already-exists': {
         name: string;
         initiator: WalletAddress;
     };
     'approving-request': {
-        request: AoPrimaryNameRequest;
+        request: PrimaryNameRequest;
         name: string;
         processId: ProcessId;
     };
 };
-export interface AOContract {
-    read<K>({ tags, retries, }: {
-        tags?: {
-            name: string;
-            value: string;
-        }[];
-        retries?: number;
-    }): Promise<K>;
-    send<K>({ tags, data, signer, }: {
-        tags: {
-            name: string;
-            value: string;
-        }[];
-        data: string | undefined;
-        signer: AoSigner;
-    }): Promise<{
-        id: string;
-        result?: K;
-    }>;
-}
 /** utility type to ensure WriteOptions are appended to each parameter set */
-export type AoWriteAction<P, R = AoMessageResult, K extends string = string, L = unknown> = (params: P, options?: WriteOptions<K, L>) => Promise<R>;
-export type DryRunResult = {
-    Output: any;
-    Messages: any[];
-    Spawns: any[];
-    Error?: any;
-};
-export type MessageResult = {
-    Output: any;
-    Messages: any[];
-    Spawns: any[];
-    Error?: any;
-};
+export type WriteAction<P, R = MessageResult, K extends string = string, L = unknown> = (params: P, options?: WriteOptions<K, L>) => Promise<R>;
 export type JSONValue = string | number | boolean | null | JSONValue[] | {
     [key: string]: JSONValue;
 };

package/lib/types/types/faucet.d.ts

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AoARIORead, AoARIOWrite } from './io.js';
-export type ARIOWithFaucet<T extends AoARIORead | AoARIOWrite> = T & {
+import { ARIORead, ARIOWrite } from './io.js';
+export type ARIOWithFaucet<T extends ARIORead | ARIOWrite> = T & {
     faucet: TokenFaucet;
 };
 export interface TokenFaucet {