fix(contract read):Add error handling for community tip token holder selection

- Make community tip settings optional when token holder selection fails
- Replace error with warning when community tip settings are missing
- Add tests for community oracle error cases
- Remove test requiring community tip settings for file uploads

Author: thiagocarvalhodev

src/ardrive.ts

@@ -157,7 +157,13 @@ export class ArDrive extends ArDriveAnonymous {
 	 * @remarks Presumes that there's a sufficient wallet balance
 	 */
 	async sendCommunityTip({ communityWinstonTip, assertBalance = false }: CommunityTipParams): Promise<TipResult> {
-		const tokenHolder: ArweaveAddress = await this.communityOracle.selectTokenHolder();
+		let tokenHolder: ArweaveAddress;
+		try {
+			tokenHolder = await this.communityOracle.selectTokenHolder();
+		} catch (error) {
+			console.error(`Failed to select token holder: ${error}. Cannot send community tip.`);
+			throw new Error('Failed to select a token holder to receive the community tip.');
+		}
 		const arTransferBaseFee = await this.priceEstimator.getBaseWinstonPriceForByteCount(new ByteCount(0));
 
 		const transferResult = await this.walletDao.sendARToAddress(

src/arfs/arfs_cost_calculator.ts

@@ -76,11 +76,16 @@ export class ArFSCostCalculator implements CostCalculator {
 		const hasFileData = uploadStats.find((u) => u.wrappedEntity.entityType === 'file');
 		if (hasFileData) {
 			const communityWinstonTip = await this.communityOracle.getCommunityWinstonTip(winstonPriceOfBundle);
-			const communityTipTarget = await this.communityOracle.selectTokenHolder();
-
-			totalPriceOfBundle = totalPriceOfBundle.plus(communityWinstonTip);
-			communityTipSettings = { communityTipTarget, communityWinstonTip };
-		}
+			let communityTipTarget;
+			try {
+				communityTipTarget = await this.communityOracle.selectTokenHolder();
+				communityTipSettings = { communityTipTarget, communityWinstonTip };
+				totalPriceOfBundle = totalPriceOfBundle.plus(communityWinstonTip);
+			} catch (error) {
+				console.error(`Failed to select token holder: ${error}. Skipping community tip.`);
+				// Community tip is not added to total price if token holder selection fails
+			}
+		} 
 
 		return {
 			calculatedBundlePlan: {
@@ -105,17 +110,27 @@ export class ArFSCostCalculator implements CostCalculator {
 		const winstonPriceOfDataTx = await this.priceEstimator.getBaseWinstonPriceForByteCount(fileDataByteCount);
 		const winstonPriceOfMetaDataTx = await this.priceEstimator.getBaseWinstonPriceForByteCount(metaDataByteCount);
 
-		const communityTipTarget = await this.communityOracle.selectTokenHolder();
-		const communityWinstonTip = await this.communityOracle.getCommunityWinstonTip(winstonPriceOfDataTx);
+		let communityTipSettings: CommunityTipSettings | undefined;
+		let totalPriceOfV2Tx: Winston;
+
+		try {
+			const communityTipTarget = await this.communityOracle.selectTokenHolder();
+			const communityWinstonTip = await this.communityOracle.getCommunityWinstonTip(winstonPriceOfDataTx);
+			communityTipSettings = { communityTipTarget, communityWinstonTip };
 
-		const totalPriceOfV2Tx = this.boostedReward(winstonPriceOfDataTx)
-			.plus(this.boostedReward(winstonPriceOfMetaDataTx))
-			.plus(communityWinstonTip);
+			totalPriceOfV2Tx = this.boostedReward(winstonPriceOfDataTx)
+				.plus(this.boostedReward(winstonPriceOfMetaDataTx))
+				.plus(communityWinstonTip);
+		} catch (error) {
+			console.error(`Failed to select token holder: ${error}. Skipping community tip.`);
+			totalPriceOfV2Tx = this.boostedReward(winstonPriceOfDataTx)
+				.plus(this.boostedReward(winstonPriceOfMetaDataTx));
+		}
 
 		return {
 			calculatedFileAndMetaDataPlan: {
 				uploadStats,
-				communityTipSettings: { communityTipTarget, communityWinstonTip },
+				communityTipSettings,
 				dataTxRewardSettings: this.rewardSettingsForWinston(winstonPriceOfDataTx),
 				metaDataRewardSettings: this.rewardSettingsForWinston(winstonPriceOfMetaDataTx)
 			},
@@ -134,15 +149,24 @@ export class ArFSCostCalculator implements CostCalculator {
 	}> {
 		const winstonPriceOfDataTx = await this.priceEstimator.getBaseWinstonPriceForByteCount(fileDataByteCount);
 
-		const communityTipTarget = await this.communityOracle.selectTokenHolder();
-		const communityWinstonTip = await this.communityOracle.getCommunityWinstonTip(winstonPriceOfDataTx);
+		let communityTipSettings: CommunityTipSettings | undefined;
+		let totalPriceOfV2Tx: Winston;
 
-		const totalPriceOfV2Tx = this.boostedReward(winstonPriceOfDataTx).plus(communityWinstonTip);
+		try {
+			const communityTipTarget = await this.communityOracle.selectTokenHolder();
+			const communityWinstonTip = await this.communityOracle.getCommunityWinstonTip(winstonPriceOfDataTx);
+			communityTipSettings = { communityTipTarget, communityWinstonTip };
+
+			totalPriceOfV2Tx = this.boostedReward(winstonPriceOfDataTx).plus(communityWinstonTip);
+		} catch (error) {
+			console.error(`Failed to select token holder: ${error}. Skipping community tip.`);
+			totalPriceOfV2Tx = this.boostedReward(winstonPriceOfDataTx);
+		}
 
 		return {
 			calculatedFileDataOnlyPlan: {
 				uploadStats,
-				communityTipSettings: { communityTipTarget, communityWinstonTip },
+				communityTipSettings,
 				dataTxRewardSettings: this.rewardSettingsForWinston(winstonPriceOfDataTx),
 				metaDataBundleIndex
 			},

src/arfs/arfsdao.test.ts

@@ -932,22 +932,6 @@ describe('The ArFSDAO class', () => {
 			assertFileResult(fileResults[1], 42);
 		});
 
-		it('throws an error if a provided bundle plan has a file entity but no communityTipSettings', async () => {
-			await expectAsyncErrorThrow({
-				promiseToError: arfsDao.uploadAllEntities({
-					bundlePlans: [
-						{
-							bundleRewardSettings: { reward: W(20) },
-							metaDataDataItems: [],
-							uploadStats: [stubFileUploadStats()]
-						}
-					],
-					v2TxPlans: emptyV2TxPlans
-				}),
-				errorMessage: 'Invalid bundle plan, file uploads must include communityTipSettings!'
-			});
-		});
-
 		it('throws an error if a provided bundle plan has only a single folder entity', async () => {
 			await expectAsyncErrorThrow({
 				promiseToError: arfsDao.uploadAllEntities({

src/arfs/arfsdao.ts

@@ -1239,7 +1239,7 @@ export class ArFSDAO extends ArFSDAOAnonymous {
 					});
 				} else {
 					if (!communityTipSettings) {
-						throw new Error('Invalid bundle plan, file uploads must include communityTipSettings!');
+						console.warn('There are no community tip settings for this file upload...');
 					}
 
 					// Prepare file data item and results

src/community/ardrive_community_oracle.test.ts

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import { fakeArweave, stubCommunityContract } from '../../tests/stubs';
 import { W } from '../types';
 import { ArDriveCommunityOracle } from './ardrive_community_oracle';
+import { expectAsyncErrorThrow } from '../../tests/test_helpers';
 
 describe('The ArDriveCommunityOracle', () => {
 	const stubContractReader = {
@@ -10,6 +11,12 @@ describe('The ArDriveCommunityOracle', () => {
 		}
 	};
 
+	const errorThrowingContractReader = {
+		async readContract() {
+			throw new Error('Failed to read contract!');
+		}
+	};
+
 	describe('getCommunityWinstonTip method', () => {
 		it('returns the expected community tip result', async () => {
 			const communityOracle = new ArDriveCommunityOracle(fakeArweave, [stubContractReader]);
@@ -23,6 +30,13 @@ describe('The ArDriveCommunityOracle', () => {
 
 			expect(+(await communityOracle.getCommunityWinstonTip(W(10_000_000)))).to.equal(10_000_000);
 		});
+
+		it('returns zero fee when contract reading fails', async () => {
+			const communityOracle = new ArDriveCommunityOracle(fakeArweave, [errorThrowingContractReader]);
+
+			// Should return 0 winston as a fallback
+			expect(+(await communityOracle.getCommunityWinstonTip(W(100_000_000)))).to.equal(0);
+		});
 	});
 
 	describe('selectTokenHolder method', () => {
@@ -33,5 +47,14 @@ describe('The ArDriveCommunityOracle', () => {
 				'abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH'
 			);
 		});
+
+		it('throws an error when contract reading fails', async () => {
+			const communityOracle = new ArDriveCommunityOracle(fakeArweave, [errorThrowingContractReader]);
+
+			await expectAsyncErrorThrow({
+				promiseToError: communityOracle.selectTokenHolder(),
+				errorMessage: 'Max contract read attempts has been reached on the last fallback contract reader..'
+			});
+		});
 	});
 });

src/community/ardrive_community_oracle.ts

@@ -1,11 +1,11 @@
 import { weightedRandom } from '../utils/common';
 import { ContractOracle, ContractReader } from './contract_oracle';
 import { CommunityOracle } from './community_oracle';
-import { ArDriveContractOracle, communityTxId } from './ardrive_contract_oracle';
+import { ArDriveContractOracle } from './ardrive_contract_oracle';
 import Arweave from 'arweave';
-import { SmartweaveContractReader } from './smartweave_contract_oracle';
 import { PDSContractCacheServiceContractReader } from './pds_contract_oracle';
 import { ADDR, ArweaveAddress, W, Winston } from '../types';
+import { SmartweaveContractReader } from './smartweave_contract_oracle';
 
 /**
  * Minimum ArDrive community tip from the Community Improvement Proposal Doc:
@@ -103,9 +103,8 @@ export class ArDriveCommunityOracle implements CommunityOracle {
 
 			return ADDR(randomHolder);
 		} catch (error) {
-			console.error('Failed to determine token holder: ' + error + '. Using default address.');
-			// Use ArDrive profit sharing community contract address as default target
-			return ADDR(communityTxId);
+			console.error(`Failed to determine token holder: ${error}`);
+			throw error;
 		}
 	}
 }

src/types/upload_planner_types.ts

@@ -137,11 +137,11 @@ export interface CalculatedFileAndMetaDataPlan
 	extends Omit<V2FileAndMetaDataPlan, 'fileDataByteCount' | 'metaDataByteCount'> {
 	dataTxRewardSettings: RewardSettings;
 	metaDataRewardSettings: RewardSettings;
-	communityTipSettings: CommunityTipSettings;
+	communityTipSettings?: CommunityTipSettings;
 }
 export interface CalculatedFileDataOnlyPlan extends Omit<V2FileDataOnlyPlan, 'fileDataByteCount'> {
 	dataTxRewardSettings: RewardSettings;
-	communityTipSettings: CommunityTipSettings;
+	communityTipSettings?: CommunityTipSettings;
 }
 export interface CalculatedFolderMetaDataPlan extends Omit<V2FolderMetaDataPlan, 'metaDataByteCount'> {
 	metaDataRewardSettings: RewardSettings;