@ar.io/sdk 3.24.0 → 4.0.0-alpha.1

package/lib/types/common/ant-registry.d.ts

@@ -1,51 +1,53 @@
-import { AoANTRegistryRead, AoANTRegistryWrite } from '../types/ant-registry.js';
-import { AoMessageResult, ProcessConfiguration, WithSigner } from '../types/index.js';
-import { AOProcess } from './index.js';
-import { ILogger } from './logger.js';
-type ANTRegistryProcessConfig = Required<ProcessConfiguration> & {
-    strict?: boolean;
-    hyperbeamUrl?: string;
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { Address, Commitment, TransactionSigner } from '@solana/kit';
+import type { SolanaRpc } from '../solana/types.js';
+import type { ANTRegistryRead, ANTRegistryWrite } from '../types/ant-registry.js';
+import type { ILogger } from './logger.js';
+/**
+ * Read-only config for `ANTRegistry.init`.
+ *
+ * Reads the per-user paginated ACL on-chain (ADR-012): a head `AclConfig`
+ * PDA + N `AclPage` PDAs holding `(asset, role)` tuples for ANTs the user
+ * owns or controls. See `src/solana/ant-registry-readable.ts`.
+ */
+export type ANTRegistryReadConfig = {
+    rpc: SolanaRpc;
+    commitment?: Commitment;
     logger?: ILogger;
-};
-type ANTRegistryNoSigner = ANTRegistryProcessConfig;
-type ANTRegistryWithSigner = WithSigner<ANTRegistryProcessConfig>;
-export declare class ANTRegistry {
-    static init(): AoANTRegistryRead;
-    static init(config: ANTRegistryNoSigner): AoANTRegistryRead;
-    static init(config: ANTRegistryWithSigner): AoANTRegistryWrite;
-}
-export declare class AoANTRegistryReadable implements AoANTRegistryRead {
-    protected process: AOProcess;
-    private hyperbeamUrl;
-    private checkHyperBeamPromise;
-    private logger;
-    constructor(config?: ANTRegistryProcessConfig & {
-        logger?: ILogger;
-    });
     /**
-     * Check if the process is HyperBeam compatible. If so, we'll use the HyperBeam node to fetch the state.
-     *
-     * @returns {Promise<boolean>} True if the process is HyperBeam compatible, false otherwise.
+     * Override the ario-ant program ID. Required against any cluster other
+     * than mainnet — devnet, localnet, and the Surfpool harness all deploy
+     * programs at addresses derived from per-cluster keypair files. Source
+     * from `migration/localnet/out/localnet.env` (`ARIO_ANT_PROGRAM_ID`) on
+     * localnet.
      */
-    private checkHyperBeamCompatibility;
-    accessControlList({ address, }: {
-        address: string;
-    }): Promise<{
-        Owned: string[];
-        Controlled: string[];
-    }>;
-    getAntsForAddress({ address, }: {
-        address: string;
-    }): Promise<{
-        Owned: string[];
-        Controlled: string[];
-    }>;
-}
-export declare class AoANTRegistryWriteable extends AoANTRegistryReadable implements AoANTRegistryWrite {
-    private signer;
-    constructor({ signer, ...config }: WithSigner<ANTRegistryProcessConfig>);
-    register({ processId, }: {
-        processId: string;
-    }): Promise<AoMessageResult>;
+    antProgramId?: Address;
+};
+/**
+ * Writeable config — adds a signer used as rent payer on
+ * `register_acl_config` / `add_acl_page` and as the authoriser on any
+ * bundled write tx. See `src/solana/ant-registry-writeable.ts` for the
+ * preflight resolvers used by `add_controller`, `remove_controller`,
+ * `transfer`, and the spawn / ex-controller workflow helpers.
+ */
+export type ANTRegistryWriteConfig = ANTRegistryReadConfig & {
+    signer: TransactionSigner;
+};
+export declare class ANTRegistry {
+    static init(config: ANTRegistryWriteConfig): Promise<ANTRegistryWrite>;
+    static init(config: ANTRegistryReadConfig): Promise<ANTRegistryRead>;
 }
-export {};