Merge pull request #84 from ardriveapp/PE-701_merge_down_master

PE-707: Adjust estimator for byteCountForWinston and export chunk estimator

Author: fedellen

README.md

@@ -1,18 +1,9 @@
-# Version 1.0 Is Coming!
-
-Version 0.x will be retired in favor of a major version update whose enhacements include:
-
--   Improved type safety
--   More user-friendly ArDrive and ArFS APIs
--   Excision of database-related code
--   Excision of file-sync-related code
-
-We believe these improvements will promote extensibility and decouple key building blocks from unnecessary dependencies. Engage with the community in [Discord](https://discord.gg/7RuTBckX) for more information.
-
 # ardrive-core-js
 
 ArDrive Core is a TypeScript library that contains the essential back end application features to support the ArDrive CLI and Desktop apps, such as file management, Permaweb upload/download, wallet management, and other common functions.
 
+Engage with the community in [Discord](https://discord.gg/7RuTBckX) for more information.
+
 ## Development Environment Setup
 
 We use nvm to manage our Node engine version and, if necessary, to install an npm version that we can then use to install Yarn.

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ardrive-core-js",
-	"version": "1.0.1",
+	"version": "1.0.2",
 	"description": "ArDrive Core contains the essential back end application features to support the ArDrive CLI and Desktop apps, such as file management, Permaweb upload/download, wallet management and other common functions.",
 	"main": "./lib/exports.js",
 	"types": "./lib/exports.d.ts",

src/exports.ts

@@ -40,6 +40,7 @@ export * from './community/verto_contract_oracle';
 // Pricing
 export * from './pricing/ar_data_price';
 export * from './pricing/ar_data_price_estimator';
+export * from './pricing/ar_data_price_chunk_estimator';
 export * from './pricing/ar_data_price_oracle_estimator';
 export * from './pricing/arweave_oracle';
 export * from './pricing/data_price_regression';

src/pricing/ar_data_price_chunk_estimator.test.ts

@@ -2,7 +2,7 @@ import { GatewayOracle } from './gateway_oracle';
 import type { ArweaveOracle } from './arweave_oracle';
 import { expect } from 'chai';
 import { SinonStubbedInstance, stub } from 'sinon';
-import { ArDriveCommunityTip, W, AR, ByteCount } from '../types';
+import { W, AR, ByteCount, ArDriveCommunityTip } from '../types';
 import { ARDataPriceChunkEstimator } from './ar_data_price_chunk_estimator';
 
 describe('ARDataPriceChunkEstimator class', () => {
@@ -60,12 +60,18 @@ describe('ARDataPriceChunkEstimator class', () => {
 		• 1 chunk of bytes: base fee + marginal chunk fee
 		• 1 chunk of bytes plus 1 byte: base fee + (marginal chunk fee * 2)
 		• 2 chunks of bytes: base fee + (marginal chunk fee * 2)
+		• 5 chunks of bytes: base fee + (marginal chunk fee * 2) + 1
+		• 10 chunks of bytes: base fee + (marginal chunk fee * 2) + 2
 		 */
 		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(0))}`).to.equal('102');
 		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(1))}`).to.equal('1102');
 		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(chunkSize))}`).to.equal('1102');
 		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(chunkSize + 1))}`).to.equal('2102');
 		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(chunkSize * 2))}`).to.equal('2102');
+		// Extra winston for 5th chunk
+		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(chunkSize * 5))}`).to.equal('5103');
+		// Two extra winston for 10th chunk
+		expect(`${await calculator.getBaseWinstonPriceForByteCount(new ByteCount(chunkSize * 10))}`).to.equal('10104');
 	});
 
 	describe('getByteCountForWinston function', () => {
@@ -78,6 +84,11 @@ describe('ARDataPriceChunkEstimator class', () => {
 			• Base fee + marginal chunk price Winston: chunksize bytes
 			• Base fee + marginal chunk price + 1 Winston: chunksize bytes
 			• Base fee + (2 * marginal chunk price) Winston: 2 * chunksize bytes
+			• Base fee + (5 * marginal chunk price) + 1 Winston: 5 * chunksize bytes
+			• Base fee + (10 * marginal chunk price) + 2 Winston: 10 * chunksize bytes
+			• Base fee + (10 * marginal chunk price) + 1 Winston: 9 * chunksize bytes
+			• Base fee + (8000 * marginal chunk price) + 1599 Winston: 7999 * chunksize bytes
+			• Base fee + (8000 * marginal chunk price) + 1600 Winston: 8000 * chunksize bytes
 			*/
 			expect((await calculator.getByteCountForWinston(W(0))).equals(new ByteCount(0))).to.be.true;
 			expect((await calculator.getByteCountForWinston(W(1))).equals(new ByteCount(0))).to.be.true;
@@ -98,6 +109,40 @@ describe('ARDataPriceChunkEstimator class', () => {
 					new ByteCount(2 * chunkSize)
 				)
 			).to.be.true;
+			expect(
+				// Add one extra winston for the 5th chunk
+				(await calculator.getByteCountForWinston(W(baseFee + 2 + 5 * marginalFeePerChunk + 1))).equals(
+					new ByteCount(5 * chunkSize)
+				)
+			).to.be.true;
+
+			expect(
+				// Add two extra winston for the 10th chunk
+				(await calculator.getByteCountForWinston(W(baseFee + 2 + 10 * marginalFeePerChunk + 2))).equals(
+					new ByteCount(10 * chunkSize)
+				)
+			).to.be.true;
+
+			expect(
+				// But expect 9 chunks when only 1 extra winston is added
+				(await calculator.getByteCountForWinston(W(baseFee + 2 + 10 * marginalFeePerChunk + 1))).equals(
+					new ByteCount(9 * chunkSize)
+				)
+			).to.be.true;
+
+			expect(
+				// Expect winston for 8000 chunks but only 1599 extra winston to equal 7999 chunks
+				(await calculator.getByteCountForWinston(W(baseFee + 2 + 8000 * marginalFeePerChunk + 1599))).equals(
+					new ByteCount(7999 * chunkSize)
+				)
+			).to.be.true;
+
+			expect(
+				// But 1600 extra winston will return 8000 chunks
+				(await calculator.getByteCountForWinston(W(baseFee + 2 + 8000 * marginalFeePerChunk + 1600))).equals(
+					new ByteCount(8000 * chunkSize)
+				)
+			).to.be.true;
 		});
 
 		it('makes two oracle calls after the first price estimation request', async () => {

src/pricing/ar_data_price_chunk_estimator.ts

@@ -1,7 +1,7 @@
 import { GatewayOracle } from './gateway_oracle';
 import type { ArweaveOracle } from './arweave_oracle';
 import { AbstractARDataPriceAndCapacityEstimator } from './ar_data_price_estimator';
-import { ArDriveCommunityTip, AR, ByteCount, Winston, W } from '../types';
+import { AR, ByteCount, Winston, W, ArDriveCommunityTip } from '../types';
 
 const byteCountOfChunk = new ByteCount(Math.pow(2, 10) * 256); // 256 KiB
 
@@ -91,13 +91,14 @@ export class ARDataPriceChunkEstimator extends AbstractARDataPriceAndCapacityEst
 
 		const numberOfChunksToUpload = Math.ceil(byteCount.valueOf() / byteCountOfChunk.valueOf());
 
-		// Every 5th chunk, arweave.net pricing adds 1 winston
-		const mysteriousExtraWinston = W(Math.floor(numberOfChunksToUpload / 5));
+		// Every 5th chunk, arweave.net pricing adds 1 Winston, which they define as a
+		// mining reward as a proportion of the estimated transaction storage costs
+		const minerFeeShareResidual = W(Math.floor(numberOfChunksToUpload / 5));
 
 		const predictedPrice = this.pricingInfo.perChunkWinstonPrice
 			.times(numberOfChunksToUpload)
 			.plus(this.pricingInfo.baseWinstonPrice)
-			.plus(mysteriousExtraWinston);
+			.plus(minerFeeShareResidual);
 
 		return predictedPrice;
 	}
@@ -118,17 +119,22 @@ export class ARDataPriceChunkEstimator extends AbstractARDataPriceAndCapacityEst
 				throw Error('Failed to generate pricing model!');
 			}
 		}
+		const { oneChunkWinstonPrice, baseWinstonPrice, perChunkWinstonPrice } = this.pricingInfo;
 
-		if (winston.isGreaterThanOrEqualTo(this.pricingInfo.oneChunkWinstonPrice)) {
-			// TODO: TEST THIS UPDATED ALGO!
-			const numberOfChunks = +winston
-				.minus(this.pricingInfo.baseWinstonPrice)
-				.dividedBy(+this.pricingInfo.perChunkWinstonPrice, 'ROUND_DOWN');
+		if (winston.isGreaterThanOrEqualTo(oneChunkWinstonPrice)) {
+			const winstonToSpend = winston.minus(baseWinstonPrice);
 
-			return new ByteCount(+byteCountOfChunk * numberOfChunks);
+			const fifthChunks = winstonToSpend
+				.dividedBy(perChunkWinstonPrice.toString(), 'ROUND_DOWN')
+				.dividedBy(5, 'ROUND_DOWN');
+			const actualWinstonToSpend = winstonToSpend.minus(fifthChunks);
+
+			const numChunks = actualWinstonToSpend.dividedBy(perChunkWinstonPrice.toString(), 'ROUND_DOWN');
+
+			return new ByteCount(+numChunks.times(byteCountOfChunk.toString()));
 		}
 
-		// Return 0 if winston price given does not cover the base winston price for a 1 byte transaction
+		// Return 0 if winston price given does not cover the base winston price for a 1 chunk transaction
 		return new ByteCount(0);
 	}
 
@@ -150,7 +156,6 @@ export class ARDataPriceChunkEstimator extends AbstractARDataPriceAndCapacityEst
 			}
 		}
 
-		// TODO: CHANGE AND/OR TEST THIS ALGO
 		return super.getByteCountForAR(arPrice, { minWinstonFee, tipPercentage });
 	}
 }