@ar.io/sdk 1.2.0-alpha.9 → 1.2.0

package/lib/esm/utils/graphql/processes.js

@@ -14,15 +14,15 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+import { EventEmitter } from 'eventemitter3';
 import { pLimit } from 'plimit-lit';
 import { ANT } from '../../common/ant.js';
 import { IO } from '../../common/io.js';
 import { ioDevnetProcessId } from '../../constants.js';
-// throttle the requests to avoid rate limiting
-const throttle = pLimit(50);
 export const getANTProcessesOwnedByWallet = async ({ address, contract = IO.init({
     processId: ioDevnetProcessId,
 }), }) => {
+    const throttle = pLimit(50);
     // get the record names of the registry - TODO: this may need to be paginated
     const uniqueContractProcessIds = await contract
         .getArNSRecords()
@@ -30,14 +30,93 @@ export const getANTProcessesOwnedByWallet = async ({ address, contract = IO.init
         .filter((record) => record.processId !== undefined)
         .map((record) => record.processId));
     // check the contract owner and controllers
-    const ownedOrControlledByWallet = await Promise.all(uniqueContractProcessIds.filter(async (processId) => throttle(async () => {
+    const ownedOrControlledByWallet = await Promise.all(uniqueContractProcessIds.map(async (processId) => throttle(async () => {
         const ant = ANT.init({
             processId,
         });
-        const owner = await ant.getOwner();
-        const controllers = await ant.getControllers();
-        return owner === address || controllers.includes(address);
+        const { Owner, Controllers } = await ant.getState();
+        if (Owner === address || Controllers.includes(address)) {
+            return processId;
+        }
+        return;
     })));
+    if (ownedOrControlledByWallet.length === 0) {
+        return [];
+    }
     // TODO: insert gql query to find ANT processes owned by wallet given wallet not currently in the registry
     return [...new Set(ownedOrControlledByWallet)];
 };
+function timeout(ms, promise) {
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => {
+            reject(new Error('Timeout'));
+        }, ms);
+        promise
+            .then((value) => {
+            clearTimeout(timer);
+            resolve(value);
+        })
+            .catch((err) => {
+            clearTimeout(timer);
+            reject(err);
+        });
+    });
+}
+export class ArNSEventEmitter extends EventEmitter {
+    contract;
+    timeoutMs; // timeout for each request to 3 seconds
+    throttle;
+    constructor({ contract = IO.init({
+        processId: ioDevnetProcessId,
+    }), timeoutMs = 60_000, concurrency = 30, }) {
+        super();
+        this.contract = contract;
+        this.timeoutMs = timeoutMs;
+        this.throttle = pLimit(concurrency);
+    }
+    async fetchProcessesOwnedByWallet({ address }) {
+        const uniqueContractProcessIds = {};
+        await timeout(this.timeoutMs, this.contract.getArNSRecords().catch((e) => {
+            this.emit('error', `Error getting ArNS records: ${e}`);
+            return {};
+        })).then((records) => {
+            if (!records)
+                return;
+            Object.entries(records).forEach(([name, record]) => {
+                if (record.processId === undefined) {
+                    return;
+                }
+                if (uniqueContractProcessIds[record.processId] === undefined) {
+                    uniqueContractProcessIds[record.processId] = {
+                        state: undefined,
+                        names: {},
+                    };
+                }
+                uniqueContractProcessIds[record.processId].names[name] = record;
+            });
+        });
+        const idCount = Object.keys(uniqueContractProcessIds).length;
+        // check the contract owner and controllers
+        this.emit('progress', 0, idCount);
+        await Promise.all(Object.keys(uniqueContractProcessIds).map(async (processId, i) => this.throttle(async () => {
+            if (uniqueContractProcessIds[processId].state !== undefined) {
+                this.emit('progress', i + 1, idCount);
+                return;
+            }
+            const ant = ANT.init({
+                processId,
+            });
+            const state = (await timeout(this.timeoutMs, ant.getState()).catch((e) => {
+                this.emit('error', `Error getting state for process ${processId}: ${e}`);
+                return undefined;
+            }));
+            if (state?.Owner === address ||
+                state?.Controllers.includes(address)) {
+                uniqueContractProcessIds[processId].state = state;
+                this.emit('process', processId, uniqueContractProcessIds[processId]);
+            }
+            this.emit('progress', i + 1, idCount);
+        })));
+        this.emit('end', uniqueContractProcessIds);
+    }
+}

package/lib/esm/utils/index.js

@@ -19,3 +19,4 @@ export * from './http-client.js';
 export * from './smartweave.js';
 export * from './graphql/index.js';
 export * from './ao.js';
+export * from './json.js';

package/lib/esm/utils/json.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export function safeDecode(data) {
+    try {
+        return JSON.parse(data);
+    }
+    catch (e) {
+        return data;
+    }
+}

package/lib/esm/version.js

@@ -15,4 +15,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '1.2.0-alpha.9';
+export const version = '1.2.0';

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

@@ -15,12 +15,13 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { ANTRecord } from '../contract-state.js';
-import { AoANTRead, AoANTWrite, ProcessConfiguration } from '../io.js';
+import { AoANTRead, AoANTState, AoANTWrite, ProcessConfiguration } from '../io.js';
 import { AoMessageResult, WalletAddress, WithSigner } from '../types.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class AoANTReadable implements AoANTRead {
     protected process: AOProcess;
     constructor(config: Required<ProcessConfiguration>);
+    getState(): Promise<AoANTState>;
     getInfo(): Promise<{
         Name: string;
         Ticker: string;

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

@@ -16,7 +16,7 @@
  */
 import Arweave from 'arweave';
 import { ArNSReservedNameData, EpochDistributionData, EpochObservations, WeightedObserver } from '../contract-state.js';
-import { AoArNSNameData, AoEpochData, AoGateway, AoIORead, AoIOWrite, EpochInput } from '../io.js';
+import { AoArNSNameData, AoEpochData, AoEpochSettings, AoGateway, AoIORead, AoIOWrite, EpochInput } from '../io.js';
 import { mIOToken } from '../token.js';
 import { AoMessageResult, ContractSigner, JoinNetworkParams, ProcessConfiguration, TransactionId, UpdateGatewaySettingsParams, WalletAddress, WithSigner, WriteOptions } from '../types.js';
 import { AOProcess } from './contracts/ao-process.js';
@@ -43,6 +43,13 @@ export declare class IOReadable implements AoIORead {
     protected process: AOProcess;
     private arweave;
     constructor(config?: ProcessConfiguration, arweave?: Arweave);
+    getInfo(): Promise<{
+        Name: string;
+        Ticker: string;
+        Logo: string;
+        Denomination: number;
+    }>;
+    getEpochSettings(params?: EpochInput): Promise<AoEpochSettings>;
     getEpoch(epoch?: EpochInput): Promise<AoEpochData>;
     getArNSRecord({ name, }: {
         name: string;
@@ -66,18 +73,18 @@ export declare class IOReadable implements AoIORead {
     getObservations(epoch?: EpochInput): Promise<EpochObservations>;
     getDistributions(epoch?: EpochInput): Promise<EpochDistributionData>;
     getTokenCost(params: {
-        intent: 'BuyRecord';
+        intent: 'Buy-Record';
         purchaseType: 'permabuy' | 'lease';
         years: number;
         name: string;
     }): Promise<number>;
     getTokenCost(params: {
-        intent: 'ExtendLease';
+        intent: 'Extend-Lease';
         years: number;
         name: string;
     }): Promise<number>;
     getTokenCost(params: {
-        intent: 'IncreaseUndernameLimit';
+        intent: 'Increase-Undername-Limit';
         quantity: number;
         name: string;
     }): Promise<number>;

package/lib/types/constants.d.ts

@@ -20,8 +20,10 @@ export declare const FQDN_REGEX: RegExp;
 export declare const SORT_KEY_REGEX: RegExp;
 export declare const ARNS_TESTNET_REGISTRY_TX: string;
 export declare const ARNS_DEVNET_REGISTRY_TX = "_NctcA2sRy1-J4OmIQZbYFPM17piNcbdBPH2ncX2RL8";
+export declare const IO_DEVNET_PROCESS_ID = "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc";
 export declare const ioDevnetProcessId = "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc";
+export declare const IO_TESTNET_PROCESS_ID = "agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA";
 export declare const MIO_PER_IO = 1000000;
-export declare const AOS_MODULE_ID = "9afQ1PLf2mrshqCTZEzzJTR2gWaC9zNPnYgYEqg1Pt4";
-export declare const ANT_LUA_ID = "obPBMsBWmG5q2qODj3y-zdKiuhZaJC_nuBaQRvORKkU";
+export declare const AOS_MODULE_ID = "cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk";
+export declare const ANT_LUA_ID = "3OlGzE5mrsN2GsxCYM0Tae1KzWepGOr5a94deOWmApM";
 export declare const DEFAULT_SCHEDULER_ID = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";

package/lib/types/io.d.ts

@@ -31,8 +31,6 @@ export type ProcessConfiguration = {
     processId?: string;
 };
 export type EpochInput = {
-    blockHeight: BlockHeight;
-} | {
     epochIndex: AoEpochIndex;
 } | {
     timestamp: Timestamp;
@@ -58,6 +56,13 @@ export interface AOContract {
     }>;
 }
 export interface AoIORead {
+    getInfo(): Promise<{
+        Ticker: string;
+        Name: string;
+        Logo: string;
+        Denomination: number;
+    }>;
+    getEpochSettings(params?: EpochInput): Promise<AoEpochSettings>;
     getGateway({ address, }: {
         address: WalletAddress;
     }): Promise<AoGateway | undefined>;
@@ -81,7 +86,7 @@ export interface AoIORead {
     getObservations(epoch?: EpochInput): Promise<EpochObservations>;
     getDistributions(epoch?: EpochInput): Promise<EpochDistributionData>;
     getTokenCost({ intent, purchaseType, years, name, quantity, }: {
-        intent: 'BuyRecord' | 'ExtendLease' | 'IncreaseUndernameLimit';
+        intent: 'Buy-Record' | 'Extend-Lease' | 'Increase-Undername-Limit';
         purchaseType?: 'permabuy' | 'lease';
         years?: number;
         name?: string;
@@ -134,6 +139,7 @@ export interface AoIOWrite extends AoIORead {
     }, options?: WriteOptions): Promise<AoMessageResult>;
 }
 export interface AoANTRead {
+    getState(): Promise<AoANTState>;
     getInfo(): Promise<{
         Name: string;
         Ticker: string;
@@ -208,6 +214,14 @@ export type AoArNSLeaseData = AoArNSBaseNameData & {
     type: 'lease';
     endTimestamp: number;
 };
+export type AoEpochSettings = {
+    epochZeroStartTimestamp: Timestamp;
+    durationMs: number;
+    prescribedNameCount: number;
+    rewardPercentage: number;
+    maxObservers: number;
+    distributionDelayMs: number;
+};
 export type AoEpochData = {
     epochIndex: AoEpochIndex;
     startHeight: BlockHeight;
@@ -244,3 +258,15 @@ export type AoGateway = {
     operatorStake: number;
     status: 'joined' | 'leaving';
 };
+export type AoANTState = {
+    Name: string;
+    Ticker: string;
+    Denomination: number;
+    Owner: WalletAddress;
+    Controllers: WalletAddress[];
+    Records: Record<string, ANTRecord>;
+    Balances: Record<WalletAddress, number>;
+    Logo: string;
+    TotalSupply: number;
+    Initialized: boolean;
+};

package/lib/types/utils/graphql/processes.d.ts

@@ -1,5 +1,35 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { EventEmitter } from 'eventemitter3';
 import { AoIORead, ProcessId, WalletAddress } from '../../types.js';
 export declare const getANTProcessesOwnedByWallet: ({ address, contract, }: {
     address: WalletAddress;
     contract?: AoIORead;
 }) => Promise<ProcessId[]>;
+export declare class ArNSEventEmitter extends EventEmitter {
+    protected contract: AoIORead;
+    private timeoutMs;
+    private throttle;
+    constructor({ contract, timeoutMs, concurrency, }: {
+        contract?: AoIORead;
+        timeoutMs?: number;
+        concurrency?: number;
+    });
+    fetchProcessesOwnedByWallet({ address }: {
+        address: WalletAddress;
+    }): Promise<void>;
+}

package/lib/types/utils/index.d.ts

@@ -19,3 +19,4 @@ export * from './http-client.js';
 export * from './smartweave.js';
 export * from './graphql/index.js';
 export * from './ao.js';
+export * from './json.js';

package/lib/types/utils/json.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export declare function safeDecode<R = unknown>(data: any): R;

package/lib/types/version.d.ts

@@ -14,4 +14,4 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-export declare const version = "1.2.0-alpha.8";
+export declare const version = "1.2.0-alpha.21";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "1.2.0-alpha.9",
+  "version": "1.2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -68,7 +68,12 @@
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
     "test": "yarn test:unit && yarn test:integration",
+    "test:cjs": "cd ./tests/e2e/cjs && yarn && yarn test",
+    "test:esm": "cd ./tests/e2e/esm && yarn && yarn test",
+    "test:web": "cd ./tests/e2e/web && yarn && yarn test",
     "test:unit": "jest --config=jest.config.mjs",
+    "test:link": "yarn build && yarn link",
+    "test:e2e": "yarn test:link && yarn test:cjs && yarn test:esm && yarn test:web",
     "test:integration": "jest --config=jest.integration.config.mjs --runInBand",
     "test:docker": "docker-compose up --exit-code-from test-runner --build",
     "prepare": "husky install",
@@ -123,6 +128,7 @@
     "axios": "1.7.2",
     "axios-retry": "^4.3.0",
     "bunyan": "^1.8.15",
+    "eventemitter3": "^5.0.1",
     "plimit-lit": "^3.0.1",
     "warp-contracts": "1.4.45"
   },