@ar.io/sdk 3.2.0 → 3.3.0-alpha.2

package/lib/esm/utils/arweave.js

@@ -1,19 +1,5 @@
-/**
- * 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 { ARWEAVE_TX_REGEX } from '../constants.js';
+import { ARIO_TESTNET_PROCESS_ID, ARWEAVE_TX_REGEX } from '../constants.js';
+import { parseAoEpochData } from './ao.js';
 export const validateArweaveId = (id) => {
     return ARWEAVE_TX_REGEX.test(id);
 };
@@ -37,3 +23,50 @@ export const paginationParamsToTags = (params) => {
     ];
     return pruneTags(tags);
 };
+/**
+ * Get the epoch with distribution data for the current epoch
+ * @param arweave - The Arweave instance
+ * @returns The epoch with distribution data
+ */
+export const getEpochDataFromGql = async ({ arweave, epochIndex, processId = ARIO_TESTNET_PROCESS_ID, }) => {
+    // fetch from gql
+    const query = epochDistributionNoticeGqlQuery({ epochIndex, processId });
+    const response = await arweave.api.post('graphql', query);
+    // parse the nodes to get the id
+    if (response.data.data.transactions?.edges?.length === 0) {
+        return undefined;
+    }
+    const id = response.data.data.transactions.edges[0].node.id;
+    // fetch the transaction from arweave
+    const transaction = await arweave.api.get(id);
+    const data = transaction.data;
+    // assert it is the correct type
+    return parseAoEpochData(data);
+};
+export const epochDistributionNoticeGqlQuery = ({ epochIndex, processId = ARIO_TESTNET_PROCESS_ID, }) => {
+    // write the query
+    const gqlQuery = JSON.stringify({
+        query: `
+      query {
+        transactions(
+          tags: [
+            { name: "From-Process", values: ["${processId}"] }
+            { name: "Action", values: ["Epoch-Distribution-Notice"] }
+            { name: "Epoch-Index", values: ["${epochIndex}"] }
+            { name: "Data-Protocol", values: ["ao"] }
+          ],
+          owners: ["fcoN_xJeisVsPXA-trzVAuIiqO3ydLQxM-L4XbrQKzY"],
+          first: 1,
+          sort: HEIGHT_DESC
+        ) {
+          edges {
+            node {
+              id
+            }
+          }
+        }
+      }
+    `,
+    });
+    return gqlQuery;
+};

package/lib/esm/version.js

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

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

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

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

@@ -1,3 +1,19 @@
+/**
+ * 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 Arweave from 'arweave';
 import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
 import { AoARIORead, AoARIOWrite, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
 import { mARIOToken } from '../types/token.js';
@@ -24,7 +40,10 @@ export declare class ARIO {
 export declare class ARIOReadable implements AoARIORead {
     protected process: AOProcess;
     protected epochSettings: AoEpochSettings | undefined;
-    constructor(config?: ProcessConfiguration);
+    protected arweave: Arweave;
+    constructor({ arweave, ...config }: ProcessConfiguration & {
+        arweave?: Arweave;
+    });
     getInfo(): Promise<{
         Name: string;
         Ticker: string;
@@ -36,9 +55,10 @@ export declare class ARIOReadable implements AoARIORead {
     }>;
     getTokenSupply(): Promise<AoTokenSupplyData>;
     private computeEpochIndexForTimestamp;
+    private computeCurrentEpochIndex;
     private computeEpochIndex;
     getEpochSettings(): Promise<AoEpochSettings>;
-    getEpoch(epoch?: EpochInput): Promise<AoEpochData>;
+    getEpoch(epoch?: EpochInput): Promise<AoEpochData | undefined>;
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
@@ -68,8 +88,8 @@ export declare class ARIOReadable implements AoARIORead {
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
-    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
-    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
+    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData | undefined>;
+    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData | undefined>;
     getTokenCost(params: {
         intent: 'Buy-Record';
         type: 'permabuy' | 'lease';
@@ -134,11 +154,13 @@ export declare class ARIOReadable implements AoARIORead {
 export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
     protected process: AOProcess;
     private signer;
-    constructor({ signer, ...config }: WithSigner<{
+    constructor({ signer, arweave, ...config }: WithSigner<{
         process?: AOProcess;
     } | {
         processId?: string;
-    }>);
+    }> & {
+        arweave?: Arweave;
+    });
     transfer({ target, qty, }: {
         target: string;
         qty: number | mARIOToken;

package/lib/types/constants.d.ts

@@ -24,6 +24,6 @@ export declare const arioDevnetProcessId = "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6
 export declare const ARIO_TESTNET_PROCESS_ID = "agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA";
 export declare const ANT_REGISTRY_ID = "i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc";
 export declare const MARIO_PER_ARIO = 1000000;
-export declare const AOS_MODULE_ID = "cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk";
+export declare const AOS_MODULE_ID = "tyojTpJ9fIva_7BjTA9ruGM4uk2vyTfhVUulnbVxR8I";
 export declare const ANT_LUA_ID = "16_FyX-V2QU0RPSh1GIaEETSaUjNb0oVjCFpVbAfQq4";
 export declare const DEFAULT_SCHEDULER_ID = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";

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

@@ -389,8 +389,8 @@ export interface AoARIORead {
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
-    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
-    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
+    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData | undefined>;
+    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData | undefined>;
     getTokenCost({ intent, type, years, name, quantity, }: AoTokenCostParams): Promise<number>;
     getCostDetails({ intent, type, years, name, quantity, fundFrom, }: AoGetCostDetailsParams): Promise<CostDetailsResult>;
     getRegistrationFees(): Promise<AoRegistrationFees>;

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

@@ -1,7 +1,7 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
 import { AoANTRecord } from '../types/ant.js';
-import { AoClient, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
+import { AoClient, AoEpochData, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
 export type SpawnANTState = {
     owner: WalletAddress;
     controllers: WalletAddress[];
@@ -15,16 +15,22 @@ export type SpawnANTState = {
 export type SpawnANTParams = {
     signer: AoSigner;
     module?: string;
-    luaCodeTxId?: string;
     ao?: AoClient;
     scheduler?: string;
     state?: SpawnANTState;
     stateContractTxId?: string;
     antRegistryId?: string;
     logger?: Logger;
+    /**
+     * @deprecated Compiled modules are now being used instead of luaCodeTxId
+     */
+    luaCodeTxId?: string;
+    /**
+     * @deprecated no longer in use due to compiled modules being preferred
+     */
     arweave?: Arweave;
 };
-export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, state, stateContractTxId, antRegistryId, logger, arweave, }: SpawnANTParams): Promise<string>;
+export declare function spawnANT({ signer, module, ao, scheduler, state, stateContractTxId, antRegistryId, logger, }: SpawnANTParams): Promise<string>;
 export declare function evolveANT({ signer, processId, luaCodeTxId, ao, logger, arweave, }: {
     signer: AoSigner;
     processId: string;
@@ -41,3 +47,7 @@ export declare function initANTStateForAddress({ owner, targetId, ttlSeconds, ke
     ttlSeconds?: number;
     owner: WalletAddress;
 }): SpawnANTState;
+/**
+ * Uses zod schema to parse the epoch data
+ */
+export declare function parseAoEpochData(value: unknown): AoEpochData;

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

@@ -1,5 +1,21 @@
+/**
+ * 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 Arweave from 'arweave';
 import { BlockHeight } from '../types/common.js';
-import { PaginationParams } from '../types/io.js';
+import { AoEpochData, PaginationParams } from '../types/io.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
 /**
@@ -18,3 +34,17 @@ export declare const paginationParamsToTags: <T>(params?: PaginationParams<T>) =
     name: string;
     value: string;
 }[];
+/**
+ * Get the epoch with distribution data for the current epoch
+ * @param arweave - The Arweave instance
+ * @returns The epoch with distribution data
+ */
+export declare const getEpochDataFromGql: ({ arweave, epochIndex, processId, }: {
+    arweave: Arweave;
+    epochIndex: number;
+    processId?: string;
+}) => Promise<AoEpochData | undefined>;
+export declare const epochDistributionNoticeGqlQuery: ({ epochIndex, processId, }: {
+    epochIndex: number;
+    processId?: string;
+}) => string;

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.2.0-alpha.3";
+export declare const version = "3.3.0-alpha.1";

package/package.json

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