@ar.io/sdk 3.4.0-alpha.2 → 3.4.0-alpha.3

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

@@ -161,6 +161,7 @@ export type AntReadOptions = {
     strict?: boolean;
 };
 export interface AoANTRead {
+    processId: string;
     getState(opts?: AntReadOptions): Promise<AoANTState>;
     getInfo(opts?: AntReadOptions): Promise<AoANTInfo>;
     getRecord({ undername }: {
@@ -179,67 +180,67 @@ export interface AoANTRead {
     getHandlers(): Promise<AoANTHandler[]>;
 }
 export interface AoANTWrite extends AoANTRead {
-    transfer({ target }: {
+    transfer: WriteAction<{
         target: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    addController({ controller, }: {
+    }>;
+    addController: WriteAction<{
         controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeController({ controller, }: {
+    }>;
+    removeController: WriteAction<{
         controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setRecord({ undername, transactionId, ttlSeconds, }: {
-        undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeRecord({ undername }: {
-        undername: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setBaseNameRecord({ transactionId, ttlSeconds, }: {
-        transactionId: string;
-        ttlSeconds: number;
-    }): Promise<AoMessageResult>;
-    setUndernameRecord({ undername, transactionId, ttlSeconds, }: {
+    }>;
+    /** @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@") */
+    setRecord: WriteAction<AoANTSetUndernameRecordParams>;
+    removeRecord: WriteAction<{
         undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }): Promise<AoMessageResult>;
-    removeUndernameRecord({ undername, }: {
+    }>;
+    setBaseNameRecord: WriteAction<AoANTSetBaseNameRecordParams>;
+    setUndernameRecord: WriteAction<AoANTSetUndernameRecordParams>;
+    removeUndernameRecord: WriteAction<{
         undername: string;
-    }): Promise<AoMessageResult>;
-    setTicker({ ticker }: {
+    }>;
+    setTicker: WriteAction<{
         ticker: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setDescription({ description }: {
+    }>;
+    setDescription: WriteAction<{
         description: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setKeywords({ keywords }: {
+    }>;
+    setKeywords: WriteAction<{
         keywords: string[];
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setName({ name }: {
+    }>;
+    setName: WriteAction<{
         name: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setLogo({ txId }: {
+    }>;
+    setLogo: WriteAction<{
         txId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    releaseName({ name, arioProcessId }: {
+    }>;
+    releaseName: WriteAction<{
         name: string;
         arioProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    reassignName({ name, arioProcessId, antProcessId, }: {
+    }>;
+    reassignName: WriteAction<{
         name: string;
         arioProcessId: string;
         antProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    approvePrimaryNameRequest({ name, address, arioProcessId, }: {
+    }>;
+    approvePrimaryNameRequest: WriteAction<{
         name: string;
-        address: WalletAddress;
+        address: string;
         arioProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removePrimaryNames({ names, arioProcessId, notifyOwners, }: {
+    }>;
+    removePrimaryNames: WriteAction<{
         names: string[];
         arioProcessId: string;
         notifyOwners?: boolean;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    }>;
 }
+/** utility type to ensure WriteOptions are appended to each parameter set */
+type WriteAction<P, R = AoMessageResult> = (params: P, options?: WriteOptions) => Promise<R>;
+export type AoANTSetBaseNameRecordParams = {
+    transactionId: string;
+    ttlSeconds: number;
+};
+export type AoANTSetUndernameRecordParams = AoANTSetBaseNameRecordParams & {
+    undername: string;
+};
+export {};

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.4.0-alpha.1";
+export declare const version = "3.4.0-alpha.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.4.0-alpha.2",
+  "version": "3.4.0-alpha.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"