laconic-registry-cli/test/helpers.ts
Prathamesh Musale 86259b35a6
All checks were successful
Lint / lint (18.x) (push) Successful in 1m12s
Publish npm package to gitea / npm_publish (18.x) (release) Successful in 1m24s
Tests / cli_tests (18.x) (push) Successful in 9m15s
Add a config option and arg to set gas price for auto fees calculation (#81)
Part of [Create a public laconicd testnet](https://www.notion.so/Create-a-public-laconicd-testnet-896a11bdd8094eff8f1b49c0be0ca3b8)
Requires cerc-io/registry-sdk#22

Behaviour in different configuration scenarios:
- Gas set, fees set to `Xalnt`:

  ```bash
  # Example
  gas: 500000
  fees: 500000alnt
  gasPrice:
  ```

  - `gasPrice` config ignored
  - tx rejected if given `fees` < `gas` * `min-gas-price` set by the node
  - tx fails mid-execution if it runs out of given `gas`
- Fees not set, gas price set to `Xalnt`:

  ```bash
  # Example
  gas:
  fees:
  gasPrice: 1alnt
  ```

  - `gas` config ignored
  - uses `auto` fee calculation using gas estimation with [default multiplier](https://git.vdb.to/cerc-io/registry-sdk/src/branch/main/src/constants.ts) (`2`) value from `registry-sdk`
  - tx rejected if given `gasPrice` < `min-gas-price` set by the node
  - tx fails mid-execution if it runs out of calculated gas
- Fees set to a `X` (without `alnt` suffix), gas price set to `Yalnt`:

  ```bash
  # Example
  gas:
  fees: 1.8
  gasPrice: 1alnt
  ```

  - `gas` config ignored
  - uses `auto` fee calculation using gas estimation with `fees` as the multiplier
  - tx rejected if given `gasPrice` < `min-gas-price` set by the node
  - tx fails mid-execution if it runs out of calculated gas, can be retried with a higher gas estimation multiplier (`fees`)
- Fees and gas price both not set:

  ```bash
  # Example
  gas:
  fees:
  gasPrice:
  ```

  - `gas` config ignored
  - uses `auto` fee calculation using gas estimation
  - throws error:
    ```bash
    Gas price must be set in the client options when auto gas is used.
    ```

The provided config can be overridden with CLI args if required.

Co-authored-by: IshaVenikar <ishavenikar7@gmail.com>
Reviewed-on: #81
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
2024-09-06 09:44:47 +00:00

154 lines
3.9 KiB
TypeScript

import fs from 'fs';
import path from 'path';
import yaml from 'js-yaml';
import { SpawnSyncReturns, spawnSync } from 'child_process';
import { getConfig } from '../src/util';
export const CHAIN_ID = 'laconic_9000-1';
export const TOKEN_TYPE = 'alnt';
export const AUCTION_FEES = {
commit: 1000000,
reveal: 1000000,
minimumBid: 5000000
};
export const AUCTION_COMMIT_DURATION = 60; // 60s
export const AUCTION_REVEAL_DURATION = 60; // 60s
export function checkResultAndRetrieveOutput (result: SpawnSyncReturns<Buffer>): any {
expect(result.status).toBe(0);
const errorOutput = result.stderr.toString().trim();
expect(errorOutput).toBe('');
const output = result.stdout.toString().trim();
expect(output.length).toBeGreaterThan(0);
return JSON.parse(output);
}
export function createBond (quantity: number): { bondId: string } {
const result = spawnSync('laconic', ['registry', 'bond', 'create', '--type', TOKEN_TYPE, '--quantity', quantity.toString(), '--gas', '200000', '--fees', `200000${TOKEN_TYPE}`]);
const output = result.stdout.toString().trim();
return JSON.parse(output);
}
export function getBondObj (params: { id: string, owner: string, balance: number}): any {
return {
id: params.id,
owner: params.owner,
balance: [
{
type: TOKEN_TYPE,
quantity: params.balance
}
]
};
}
export function getAccountObj (params: { address: string, balance?: number }): any {
const balanceObj: any = { type: TOKEN_TYPE };
if (params.balance) {
balanceObj.quantity = params.balance;
}
return {
address: params.address,
balance: [balanceObj]
};
}
export function getRecordObj (recordFilePath: string, params: { bondId: string, recordId: string, names: any }): any {
const recordContent = yaml.load(fs.readFileSync(recordFilePath, 'utf8')) as any;
return {
id: params.recordId,
names: params.names,
bondId: params.bondId,
attributes: recordContent.record
};
}
export function getAuthorityObj (params: { owner: string, status: string, auction: any, bondId?: string }): any {
return {
ownerAddress: params.owner,
status: params.status,
bondId: params.bondId || '',
auction: params.auction
};
}
export function getAuctionObj (params: { owner: string, status?: string }): any {
return {
status: params.status || 'commit',
ownerAddress: params.owner,
commitFee: {
type: TOKEN_TYPE,
quantity: AUCTION_FEES.commit
},
revealFee: {
type: TOKEN_TYPE,
quantity: AUCTION_FEES.reveal
},
minimumBid: {
type: TOKEN_TYPE,
quantity: AUCTION_FEES.minimumBid
},
winnerAddress: ''
};
}
export function getBidObj (params: { bidder: string, status?: string }): any {
return {
bidderAddress: params.bidder,
status: params.status || 'commit',
commitFee: {
type: TOKEN_TYPE,
quantity: AUCTION_FEES.commit
},
revealFee: {
type: TOKEN_TYPE,
quantity: AUCTION_FEES.reveal
},
bidAmount: {
type: '',
quantity: 0
}
};
}
export async function delay (ms: number): Promise<any> {
return new Promise((resolve) => setTimeout(resolve, ms));
}
export function updateGasAndFeesConfig (gas?: string | null, fees?: string | null, gasPrice?: string | null): void {
const configFilePath = './config.yml';
const config = getConfig(path.resolve(configFilePath));
if (gas) {
config.services.registry.gas = gas;
} else if (gas === null) {
delete config.services.registry.gas;
}
if (fees) {
config.services.registry.fees = fees;
} else if (fees === null) {
delete config.services.registry.fees;
}
if (gasPrice) {
config.services.registry.gasPrice = gasPrice;
} else if (gasPrice === null) {
delete config.services.registry.gasPrice;
}
try {
fs.writeFileSync(configFilePath, yaml.dump(config), 'utf8');
} catch (e) {
console.error('Error writing config file:', e);
throw e;
}
}