Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cycles prop tests #2178

Merged
merged 15 commits into from
Nov 13, 2024
Merged

Cycles prop tests #2178

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
defb2e8
first pass at cycles prop tests
bdemann Oct 17, 2024
ff3eaf7
finish cycles tests
bdemann Oct 17, 2024
64b9054
add to cycles
bdemann Oct 18, 2024
a5701ff
update payment to cycles
bdemann Nov 1, 2024
5e48c15
update principals to be class variables
bdemann Nov 4, 2024
f29647d
pr fixes
bdemann Nov 4, 2024
513875c
send cycles by chunk
bdemann Nov 4, 2024
5ef1af9
make sure chunk size is never 0 for none zero sends
bdemann Nov 4, 2024
1c6348a
update chunk reception to accept all cycles
bdemann Nov 4, 2024
015ef27
pr fixes
bdemann Nov 5, 2024
9720797
Merge branch 'main' into cycles_prop_tests
bdemann Nov 6, 2024
09850a0
use ternary
bdemann Nov 13, 2024
a04afac
Merge branch 'main' into cycles_prop_tests
bdemann Nov 13, 2024
3108d04
use more explicit condition
bdemann Nov 13, 2024
f3c107b
fix undefined problems
bdemann Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions tests/property/ic_api/cycles/src/cycles/index.ts
View file
Open in desktop
lastmjs marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,10 @@ function acceptCycles(
): CyclesResult {
const startingCanisterBalance = canisterBalance();
const initialAvailable = msgCyclesAvailable();

const effectiveNumChunks = numChunks ?? 1n;

const requestedAmount = receiveAmount ?? initialAvailable;

const chunkSize =
requestedAmount > 0n
? bigintMax(1n, requestedAmount / effectiveNumChunks)
: 0n;

const accepted = acceptCyclesRecursive(chunkSize, requestedAmount, 0n);

const accepted = acceptCyclesStrategy(
lastmjs marked this conversation as resolved.
Show resolved Hide resolved
receiveAmount ?? initialAvailable,
numChunks
);
const finalAvailable = msgCyclesAvailable();
const endingCanisterBalance = canisterBalance();
const cyclesRefunded = 0n; // This will always be 0 in the cycles canister
Expand All @@ -62,7 +54,18 @@ function acceptCycles(
};
}

function acceptCyclesRecursive(
function acceptCyclesStrategy(
lastmjs marked this conversation as resolved.
Show resolved Hide resolved
receiveAmount: bigint,
numChunks?: bigint
): bigint {
if (numChunks === undefined) {
return msgCyclesAccept(receiveAmount);
}
const chunkSize = bigintMax(1n, receiveAmount / numChunks);
return acceptCyclesChunk(chunkSize, receiveAmount, 0n);
}

function acceptCyclesChunk(
chunkSize: bigint,
totalToAccept: bigint,
accumulatedCycles: bigint
Expand All @@ -76,7 +79,7 @@ function acceptCyclesRecursive(
}

const newlyAccepted = msgCyclesAccept(chunkSize);
return acceptCyclesRecursive(
return acceptCyclesChunk(
chunkSize,
totalToAccept,
accumulatedCycles + newlyAccepted
Expand Down
12 changes: 6 additions & 6 deletions tests/property/ic_api/cycles/src/intermediary/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ export default class {
this.cyclesPrincipal,
'receiveVariableCycles',
{
returnIdlType: CyclesResult,
cycles: amountToSend,
paramIdlTypes: [IDL.Nat64],
args: [amountToAccept]
returnIdlType: CyclesResult,
args: [amountToAccept],
cycles: amountToSend
}
);
return { ...result, cyclesRefunded: msgCyclesRefunded() };
Expand All @@ -50,10 +50,10 @@ export default class {
this.cyclesPrincipal,
'receiveCyclesByChunk',
{
returnIdlType: CyclesResult,
cycles: amount,
paramIdlTypes: [IDL.Nat64],
args: [numChunks]
returnIdlType: CyclesResult,
args: [numChunks],
cycles: amount
}
);
return { ...result, cyclesRefunded: msgCyclesRefunded() };
Expand Down
10 changes: 5 additions & 5 deletions tests/property/ic_api/cycles/test/tests.ts
View file
Open in desktop
lastmjs marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ import { defaultPropTestParams, expect, it, Test } from 'azle/test';
import fc from 'fast-check';

import { CyclesResult } from '../src/types';
import { _SERVICE } from './dfx_generated/intermediary/intermediary.did';
import { _SERVICE as Actor } from './dfx_generated/intermediary/intermediary.did';

export function getTests(): Test {
return () => {
it('should send all cycles from intermediary to cycles canister and receive none back', async () => {
const intermediaryCanister =
await getCanisterActor<_SERVICE>('intermediary');
await getCanisterActor<Actor>('intermediary');
await fc.assert(
fc.asyncProperty(fc.bigInt(0n, 10_000_000n), async (amount) => {
const result =
Expand All @@ -22,7 +22,7 @@ export function getTests(): Test {

it('should send a portion of the cycles from intermediary to cycles canister and receive the rest back', async () => {
const intermediaryCanister =
await getCanisterActor<_SERVICE>('intermediary');
await getCanisterActor<Actor>('intermediary');
await fc.assert(
fc.asyncProperty(
fc.bigInt(0n, 10_000_000n),
Expand All @@ -47,7 +47,7 @@ export function getTests(): Test {

it('should receive all cycles back to the intermediary if none are received by the cycles canister', async () => {
const intermediaryCanister =
await getCanisterActor<_SERVICE>('intermediary');
await getCanisterActor<Actor>('intermediary');
await fc.assert(
fc.asyncProperty(fc.bigInt(0n, 10_000_000n), async (amount) => {
const result =
Expand All @@ -60,7 +60,7 @@ export function getTests(): Test {

it('should send cycles in chunks from intermediary to cycles canister', async () => {
const intermediaryCanister =
await getCanisterActor<_SERVICE>('intermediary');
await getCanisterActor<Actor>('intermediary');
await fc.assert(
fc.asyncProperty(
fc.bigInt(0n, 10_000_000n),
Expand Down