@ar.io/sdk 3.9.0-alpha.5 → 3.9.0-alpha.6

package/lib/cjs/common/io.js

@@ -84,10 +84,11 @@ class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+            const epochData = await (0, arweave_js_1.getEpochDataFromGqlWithCUFallback)({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return (0, arweave_js_1.removeEligibleRewardsFromEpochData)(epochData);
         }
@@ -211,7 +212,8 @@ class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+            const epochData = await (0, arweave_js_1.getEpochDataFromGqlWithCUFallback)({
+                ao: this.process.ao,
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
@@ -233,10 +235,11 @@ class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+            const epochData = await (0, arweave_js_1.getEpochDataFromGqlWithCUFallback)({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return epochData?.prescribedNames;
         }
@@ -256,10 +259,11 @@ class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+            const epochData = await (0, arweave_js_1.getEpochDataFromGqlWithCUFallback)({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return epochData?.observations;
         }
@@ -279,10 +283,11 @@ class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+            const epochData = await (0, arweave_js_1.getEpochDataFromGqlWithCUFallback)({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return epochData?.distributions;
         }
@@ -302,10 +307,11 @@ class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+            const epochData = await (0, arweave_js_1.getEpochDataFromGqlWithCUFallback)({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(epochData, params);
         }

package/lib/cjs/utils/arweave.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeEligibleRewardsFromEpochData = exports.sortAndPaginateEpochDataIntoEligibleDistributions = exports.epochDistributionNoticeGqlQuery = exports.getEpochDataFromGql = exports.paginationParamsToTags = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = void 0;
+exports.removeEligibleRewardsFromEpochData = exports.sortAndPaginateEpochDataIntoEligibleDistributions = exports.epochDistributionNoticeGqlQueryFallback = exports.epochDistributionNoticeGqlQuery = exports.getEpochDataFromGqlFallback = exports.getEpochDataFromGqlWithCUFallback = exports.getEpochDataFromGql = exports.paginationParamsToTags = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = void 0;
 const constants_js_1 = require("../constants.js");
 const io_js_1 = require("../types/io.js");
 const ao_js_1 = require("./ao.js");
@@ -69,6 +69,66 @@ const getEpochDataFromGql = async ({ arweave, epochIndex, processId = constants_
     return undefined;
 };
 exports.getEpochDataFromGql = getEpochDataFromGql;
+const getEpochDataFromGqlWithCUFallback = async ({ arweave, ao, epochIndex, processId = constants_js_1.ARIO_MAINNET_PROCESS_ID, }) => {
+    const gqlResult = await (0, exports.getEpochDataFromGql)({
+        arweave,
+        epochIndex,
+        processId,
+    });
+    if (gqlResult) {
+        return gqlResult;
+    }
+    const gqlFallbackResult = await (0, exports.getEpochDataFromGqlFallback)({
+        ao,
+        epochIndex,
+        processId,
+    });
+    if (gqlFallbackResult) {
+        return gqlFallbackResult;
+    }
+    return undefined;
+};
+exports.getEpochDataFromGqlWithCUFallback = getEpochDataFromGqlWithCUFallback;
+const getEpochDataFromGqlFallback = async ({ ao, epochIndex, processId = constants_js_1.ARIO_MAINNET_PROCESS_ID, gqlUrl = 'https://arweave-search.goldsky.com/graphql', }) => {
+    const query = (0, exports.epochDistributionNoticeGqlQueryFallback)({
+        epochIndex,
+        processId,
+    });
+    const response = await fetch(gqlUrl, {
+        method: 'POST',
+        body: query,
+        headers: {
+            'Content-Type': 'application/json',
+        },
+    });
+    const responseJson = (await response.json());
+    if (responseJson.data.transactions.edges.length === 0) {
+        return undefined;
+    }
+    for (const edge of responseJson.data.transactions.edges) {
+        const id = edge.node.id;
+        const messageResult = await ao
+            .result({
+            message: id,
+            process: processId,
+        })
+            .catch(() => undefined);
+        if (!messageResult) {
+            continue;
+        }
+        for (const message of messageResult.Messages) {
+            const data = JSON.parse(message.Data);
+            const tags = message.Tags;
+            // check if the message results include epoch-distribution-notice for the requested epoch index
+            if (tags.some((tag) => tag.name === 'Action' && tag.value === 'Epoch-Distribution-Notice') &&
+                tags.some((tag) => tag.name === 'Epoch-Index' && tag.value === epochIndex.toString())) {
+                return (0, ao_js_1.parseAoEpochData)(data);
+            }
+        }
+    }
+    return undefined;
+};
+exports.getEpochDataFromGqlFallback = getEpochDataFromGqlFallback;
 /**
  * Get the epoch with distribution data for the current epoch
  * @param arweave - The Arweave instance
@@ -104,6 +164,32 @@ const epochDistributionNoticeGqlQuery = ({ epochIndex, processId = constants_js_
     return gqlQuery;
 };
 exports.epochDistributionNoticeGqlQuery = epochDistributionNoticeGqlQuery;
+// fallback query if the distribution notice does not get cranked
+const epochDistributionNoticeGqlQueryFallback = ({ processId = constants_js_1.ARIO_MAINNET_PROCESS_ID, owners = ['OAb-n-ZugyN598kZNpfOy0ACelGVmwCQ0kYbgNGDUK8'], // ar.io team wallet ticks once a day
+ }) => {
+    return JSON.stringify({
+        query: `
+      query {
+        transactions(
+          tags: [
+            { name: "Action", values: ["Tick"] }
+          ],
+          first: 100,
+          owners: [${owners.map((a) => `"${a}"`).join(',')}],
+          recipients: ["${processId}"],
+          sort: HEIGHT_DESC
+        ) {
+          edges {
+            node {
+              id  
+            }
+          }
+        }
+      }
+    `,
+    });
+};
+exports.epochDistributionNoticeGqlQueryFallback = epochDistributionNoticeGqlQueryFallback;
 function sortAndPaginateEpochDataIntoEligibleDistributions(epochData, params) {
     const rewards = [];
     const sortBy = params?.sortBy ?? 'eligibleReward';

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.9.0-alpha.5';
+exports.version = '3.9.0-alpha.6';

package/lib/esm/common/io.js

@@ -1,7 +1,7 @@
 import { ARIO_MAINNET_PROCESS_ID } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/io.js';
 import { createAoSigner } from '../utils/ao.js';
-import { getEpochDataFromGql, paginationParamsToTags, pruneTags, removeEligibleRewardsFromEpochData, sortAndPaginateEpochDataIntoEligibleDistributions, } from '../utils/arweave.js';
+import { getEpochDataFromGqlWithCUFallback, paginationParamsToTags, pruneTags, removeEligibleRewardsFromEpochData, sortAndPaginateEpochDataIntoEligibleDistributions, } from '../utils/arweave.js';
 import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
@@ -80,10 +80,11 @@ export class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await getEpochDataFromGql({
+            const epochData = await getEpochDataFromGqlWithCUFallback({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return removeEligibleRewardsFromEpochData(epochData);
         }
@@ -207,7 +208,8 @@ export class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await getEpochDataFromGql({
+            const epochData = await getEpochDataFromGqlWithCUFallback({
+                ao: this.process.ao,
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
@@ -229,10 +231,11 @@ export class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await getEpochDataFromGql({
+            const epochData = await getEpochDataFromGqlWithCUFallback({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return epochData?.prescribedNames;
         }
@@ -252,10 +255,11 @@ export class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await getEpochDataFromGql({
+            const epochData = await getEpochDataFromGqlWithCUFallback({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return epochData?.observations;
         }
@@ -275,10 +279,11 @@ export class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await getEpochDataFromGql({
+            const epochData = await getEpochDataFromGqlWithCUFallback({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return epochData?.distributions;
         }
@@ -298,10 +303,11 @@ export class ARIOReadable {
         const epochIndex = await this.computeEpochIndex(epoch);
         const currentIndex = await this.computeCurrentEpochIndex();
         if (epochIndex !== undefined && epochIndex < currentIndex) {
-            const epochData = await getEpochDataFromGql({
+            const epochData = await getEpochDataFromGqlWithCUFallback({
                 arweave: this.arweave,
                 epochIndex: epochIndex,
                 processId: this.process.processId,
+                ao: this.process.ao,
             });
             return sortAndPaginateEpochDataIntoEligibleDistributions(epochData, params);
         }

package/lib/esm/utils/arweave.js

@@ -61,6 +61,64 @@ export const getEpochDataFromGql = async ({ arweave, epochIndex, processId = ARI
     }
     return undefined;
 };
+export const getEpochDataFromGqlWithCUFallback = async ({ arweave, ao, epochIndex, processId = ARIO_MAINNET_PROCESS_ID, }) => {
+    const gqlResult = await getEpochDataFromGql({
+        arweave,
+        epochIndex,
+        processId,
+    });
+    if (gqlResult) {
+        return gqlResult;
+    }
+    const gqlFallbackResult = await getEpochDataFromGqlFallback({
+        ao,
+        epochIndex,
+        processId,
+    });
+    if (gqlFallbackResult) {
+        return gqlFallbackResult;
+    }
+    return undefined;
+};
+export const getEpochDataFromGqlFallback = async ({ ao, epochIndex, processId = ARIO_MAINNET_PROCESS_ID, gqlUrl = 'https://arweave-search.goldsky.com/graphql', }) => {
+    const query = epochDistributionNoticeGqlQueryFallback({
+        epochIndex,
+        processId,
+    });
+    const response = await fetch(gqlUrl, {
+        method: 'POST',
+        body: query,
+        headers: {
+            'Content-Type': 'application/json',
+        },
+    });
+    const responseJson = (await response.json());
+    if (responseJson.data.transactions.edges.length === 0) {
+        return undefined;
+    }
+    for (const edge of responseJson.data.transactions.edges) {
+        const id = edge.node.id;
+        const messageResult = await ao
+            .result({
+            message: id,
+            process: processId,
+        })
+            .catch(() => undefined);
+        if (!messageResult) {
+            continue;
+        }
+        for (const message of messageResult.Messages) {
+            const data = JSON.parse(message.Data);
+            const tags = message.Tags;
+            // check if the message results include epoch-distribution-notice for the requested epoch index
+            if (tags.some((tag) => tag.name === 'Action' && tag.value === 'Epoch-Distribution-Notice') &&
+                tags.some((tag) => tag.name === 'Epoch-Index' && tag.value === epochIndex.toString())) {
+                return parseAoEpochData(data);
+            }
+        }
+    }
+    return undefined;
+};
 /**
  * Get the epoch with distribution data for the current epoch
  * @param arweave - The Arweave instance
@@ -95,6 +153,31 @@ export const epochDistributionNoticeGqlQuery = ({ epochIndex, processId = ARIO_M
     });
     return gqlQuery;
 };
+// fallback query if the distribution notice does not get cranked
+export const epochDistributionNoticeGqlQueryFallback = ({ processId = ARIO_MAINNET_PROCESS_ID, owners = ['OAb-n-ZugyN598kZNpfOy0ACelGVmwCQ0kYbgNGDUK8'], // ar.io team wallet ticks once a day
+ }) => {
+    return JSON.stringify({
+        query: `
+      query {
+        transactions(
+          tags: [
+            { name: "Action", values: ["Tick"] }
+          ],
+          first: 100,
+          owners: [${owners.map((a) => `"${a}"`).join(',')}],
+          recipients: ["${processId}"],
+          sort: HEIGHT_DESC
+        ) {
+          edges {
+            node {
+              id  
+            }
+          }
+        }
+      }
+    `,
+    });
+};
 export function sortAndPaginateEpochDataIntoEligibleDistributions(epochData, params) {
     const rewards = [];
     const sortBy = params?.sortBy ?? 'eligibleReward';

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.9.0-alpha.5';
+export const version = '3.9.0-alpha.6';

package/lib/types/common/contracts/ao-process.d.ts

@@ -2,7 +2,7 @@ import { AOContract, AoClient, AoSigner } from '../../types/index.js';
 import { ILogger } from '../logger.js';
 export declare class AOProcess implements AOContract {
     private logger;
-    private ao;
+    readonly ao: AoClient;
     readonly processId: string;
     constructor({ processId, ao, logger, }: {
         processId: string;

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import Arweave from 'arweave';
-import { BlockHeight } from '../types/common.js';
+import { AoClient, BlockHeight } from '../types/common.js';
 import { AoEligibleDistribution, AoEpochData, AoEpochDistributed, PaginationParams, PaginationResult } from '../types/io.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
@@ -46,6 +46,18 @@ export declare const getEpochDataFromGql: ({ arweave, epochIndex, processId, ret
     retries?: number;
     gqlUrl?: string;
 }) => Promise<AoEpochData<AoEpochDistributed> | undefined>;
+export declare const getEpochDataFromGqlWithCUFallback: ({ arweave, ao, epochIndex, processId, }: {
+    arweave: Arweave;
+    ao: AoClient;
+    epochIndex: number;
+    processId?: string;
+}) => Promise<AoEpochData<AoEpochDistributed> | undefined>;
+export declare const getEpochDataFromGqlFallback: ({ ao, epochIndex, processId, gqlUrl, }: {
+    ao: AoClient;
+    epochIndex: number;
+    processId?: string;
+    gqlUrl?: string;
+}) => Promise<AoEpochData<AoEpochDistributed> | undefined>;
 /**
  * Get the epoch with distribution data for the current epoch
  * @param arweave - The Arweave instance
@@ -58,5 +70,10 @@ export declare const epochDistributionNoticeGqlQuery: ({ epochIndex, processId,
     processId?: string | undefined;
     authorities?: string[] | undefined;
 }) => string;
+export declare const epochDistributionNoticeGqlQueryFallback: ({ processId, owners, }: {
+    epochIndex: number;
+    processId?: string;
+    owners?: string[];
+}) => string;
 export declare function sortAndPaginateEpochDataIntoEligibleDistributions(epochData?: AoEpochData, params?: PaginationParams<AoEligibleDistribution>): PaginationResult<AoEligibleDistribution>;
 export declare function removeEligibleRewardsFromEpochData(epochData?: AoEpochData): AoEpochData | undefined;

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.9.0-alpha.4";
+export declare const version = "3.9.0-alpha.5";

package/package.json

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