Skip to content

Add deploy script for HighloadWalletV3 contract #20

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

Merged
4 commits merged into from
Jan 25, 2026
Merged

Add deploy script for HighloadWalletV3 contract #20

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48d0c19
Add deploy script for HighloadWalletV3 contract
Jan 25, 2026
35fc0fa
Update scripts/deploy.ts
Jan 25, 2026
2289c8f
Update scripts/deploy.ts
Jan 25, 2026
f8011ad
Update scripts/deploy.ts
Jan 25, 2026
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
146 changes: 146 additions & 0 deletions scripts/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
/**
* Template deploy script for HighloadWalletV3 (keypair-based sender)
*
* Behavior:
* - Loads compiled code cell from wrappers/compiled.ts
* - Builds data cell using highloadWalletV3ConfigToCell
* - Computes the contract address and prints it
* - Determines deploy amount:
* - If DEPLOY_VALUE env var is set, use it
* - Otherwise try to call a TonClient estimate function (if available at runtime)
* - If estimation fails, fallback to DEPLOY_FALLBACK (default 0.1 TON)
* - Apply DEPLOY_SAFE_MARGIN (default 1.5)
* - Prints the chosen amount and exits unless CONFIRM_DEPLOY=true
* - The actual SEND DEPLOY block is marked with TODO: implement using your wallet/provider
*
* Safety:
* - Does not send funds unless CONFIRM_DEPLOY=true to avoid accidental deploys from CI
* - Does not contain any secret key; expects SECRET_KEY_BASE64 or a secret manager to be used
*/

import 'dotenv/config';
import { toNano, contractAddress } from '@ton/core';
import { HighloadWalletV3Code } from '../wrappers/compiled';
import { highloadWalletV3ConfigToCell } from '../wrappers/HighloadWalletV3';

const RPC_URL = process.env.RPC_URL || 'https://net.ton.dev';
const SECRET_KEY_BASE64 = process.env.SECRET_KEY_BASE64 || '';
const WORKCHAIN = Number(process.env.WORKCHAIN || 0);

// Default subwallet id for HighloadWalletV3 as per the HighloadWalletV3 specification.
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No validation for TIMEOUT value. The Number() conversion could result in NaN if the environment variable is not a valid number, which would cause issues when creating the config cell. Consider adding validation:

const timeout = Number(process.env.TIMEOUT || 3600);
if (isNaN(timeout)) {
    throw new Error('TIMEOUT must be a valid number');
}
const TIMEOUT = timeout;

Copilot uses AI. Check for mistakes.
// Can be overridden via the SUBWALLET_ID environment variable if needed.
const HIGHLOAD_WALLET_V3_DEFAULT_SUBWALLET_ID = 0x10ad;
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No validation for DEPLOY_SAFE_MARGIN value. If the environment variable contains a non-numeric value or negative number, Number() will return NaN or a negative value, which could cause unexpected behavior in calculations. Consider adding validation:

const margin = Number(process.env.DEPLOY_SAFE_MARGIN || '1.5');
if (isNaN(margin) || margin < 0) {
    throw new Error('DEPLOY_SAFE_MARGIN must be a non-negative number');
}
const DEPLOY_SAFE_MARGIN = margin;

Copilot uses AI. Check for mistakes.

const SUBWALLET_ID = Number(process.env.SUBWALLET_ID || HIGHLOAD_WALLET_V3_DEFAULT_SUBWALLET_ID);
const TIMEOUT = Number(process.env.TIMEOUT || 3600);
const DEPLOY_VALUE_ENV = process.env.DEPLOY_VALUE || '';
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'any' type for the 'init' parameter reduces type safety. Consider defining a proper interface or using a type from '@ton/core' library, such as:

async function estimateDeployAmount(init: { code: Cell; data: Cell }): Promise<bigint>

This provides better type checking and IDE support.

Copilot uses AI. Check for mistakes.
const DEPLOY_SAFE_MARGIN = Number(process.env.DEPLOY_SAFE_MARGIN || '1.5');
const DEPLOY_FALLBACK = process.env.DEPLOY_FALLBACK || '0.1';
const CONFIRM_DEPLOY = process.env.CONFIRM_DEPLOY === 'true'; // must be explicitly set to "true" to send

async function estimateDeployAmount(init: any): Promise<bigint> {
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function accepts 'any' type for the init parameter, which bypasses type safety. Consider defining a proper interface or type for the init parameter, such as: { code: Cell, data: Cell } to ensure type safety and better IDE support.

Copilot uses AI. Check for mistakes.
// If user provided explicit value, use it
if (DEPLOY_VALUE_ENV) {
console.log('Using DEPLOY_VALUE from env:', DEPLOY_VALUE_ENV);
return toNano(DEPLOY_VALUE_ENV);
}

// Try to use TonClient dynamically (if installed and available at runtime)
try {
// dynamic require to avoid TypeScript type errors if library evolves
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { TonClient } = require('ton');
const client = new TonClient({ endpoint: RPC_URL });

Comment on lines +50 to +54
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using require() for dynamic import breaks the ESM module pattern used in the rest of the file. Consider using dynamic import() instead for consistency:

const { TonClient } = await import('ton');

This maintains ESM consistency and is more compatible with modern TypeScript/Node.js practices.

Suggested change
// dynamic require to avoid TypeScript type errors if library evolves
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { TonClient } = require('ton');
const client = new TonClient({ endpoint: RPC_URL });
// dynamic import to avoid TypeScript type errors if library evolves
const { TonClient } = await import('ton');
const client = new TonClient({ endpoint: RPC_URL });

Copilot uses AI. Check for mistakes.
// Try some common estimate API names in a safe way
if (typeof client.estimateFeesForDeploy === 'function') {
console.log('Estimating deploy fees with TonClient.estimateFeesForDeploy...');
const res = await client.estimateFeesForDeploy({ init });
const fee = BigInt(res?.totalFee ?? res?.fee ?? 0);
const withMargin = BigInt(Math.ceil(Number(fee) * DEPLOY_SAFE_MARGIN));
console.log('Estimated fee:', fee.toString(), 'with margin:', withMargin.toString());
return withMargin;
}

if (typeof client.estimateFees === 'function') {
console.log('Estimating deploy fees with TonClient.estimateFees...');
const res = await client.estimateFees({ init });
const fee = BigInt(res?.total ?? 0);
const withMargin = BigInt(Math.ceil(Number(fee) * DEPLOY_SAFE_MARGIN));
console.log('Estimated fee:', fee.toString(), 'with margin:', withMargin.toString());
return withMargin;
}

console.warn('TonClient found but no known estimate method present. Falling back.');
} catch (e) {
console.warn(
'Could not use TonClient to estimate fees (skipped). Error:',
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Precision loss when converting BigInt to Number. When converting fallback (a BigInt) to Number for multiplication, very large values could lose precision. The safer approach is to perform the multiplication in BigInt arithmetic directly:

const withMargin = (fallback * BigInt(Math.floor(DEPLOY_SAFE_MARGIN * 100))) / 100n;

This preserves BigInt precision throughout the calculation.

Copilot uses AI. Check for mistakes.
e instanceof Error ? e.message : String(e),
);
}

// Fallback to default conservative amount
console.log('Using fallback deploy value:', DEPLOY_FALLBACK, 'TON');
const fallback = toNano(DEPLOY_FALLBACK);
const withMargin = BigInt(Math.ceil(Number(fallback) * DEPLOY_SAFE_MARGIN));
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converting bigint to number for multiplication can cause precision loss for large values. Since fallback is already a bigint from toNano(), consider using BigInt arithmetic throughout: const withMargin = (fallback * BigInt(Math.floor(DEPLOY_SAFE_MARGIN * 1000))) / 1000n to maintain precision.

Copilot uses AI. Check for mistakes.
return withMargin;
}

async function main() {
console.log('RPC URL:', RPC_URL);
console.log('Workchain:', WORKCHAIN);

if (!SECRET_KEY_BASE64) {
console.warn('SECRET_KEY_BASE64 is not set. You will need to provide your secret key before sending real deploys. The script will still compute address and estimate amounts.');
}

// TODO: replace this placeholder with deriving the actual publicKey from your secret key
// For now we use a zeroed publicKey buffer as placeholder to compute address deterministically
const publicKeyPlaceholder = Buffer.alloc(32, 0);
Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a zeroed placeholder public key will result in computing an incorrect contract address. The address depends on the actual public key that will be used for deployment. This means the computed address will not match the actual deployed contract address if a different public key is used later, which could lead to funds being sent to the wrong address or deployment failures.

Copilot uses AI. Check for mistakes.

const data = highloadWalletV3ConfigToCell({
publicKey: publicKeyPlaceholder,
subwalletId: SUBWALLET_ID,
timeout: TIMEOUT,
});

Copy link

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Precision loss when converting BigInt to Number for display. For very large values (near the Number.MAX_SAFE_INTEGER limit), this conversion could lose precision. Consider using a string-based division or a dedicated BigInt formatting function for accurate display.

Copilot uses AI. Check for mistakes.
const init = { code: HighloadWalletV3Code, data };
const address = contractAddress(WORKCHAIN, init);

console.log('Computed contract address:', address.toString({ urlSafe: true, bounceable: true }));

const deployAmount = await estimateDeployAmount(init);
console.log('Resolved deploy amount (nano-tons):', deployAmount.toString());
console.log('In TON (approx):', (Number(deployAmount) / 1e9).toFixed(9));

if (!CONFIRM_DEPLOY) {
console.log('CONFIRM_DEPLOY is not set to true. Exiting before any network action.');
console.log('Set CONFIRM_DEPLOY=true and ensure SECRET_KEY_BASE64 is set to actually send the deploy.');
return;
}

// =====================
// TODO: SEND DEPLOY MESSAGE (KEYPAIR-BASED, Option A)
// =====================
// The following steps must be implemented using your chosen wallet/send approach:
// 1) Derive your keypair (publicKey, secretKey) from SECRET_KEY_BASE64 using the same crypto lib
// 2) Create a wallet/sender object or build an internal message that contains init (code+data)
// 3) Sign the message appropriately and send it to the network using a TonClient or your RPC provider
// 4) Wait for transaction confirmation and verify contract activation (code+data present)
//
// Example guidance (pseudocode):
// const key = Buffer.from(SECRET_KEY_BASE64, 'base64');
// const keyPair = deriveKeyPair(key);
// const client = new TonClient({ endpoint: RPC_URL });
// const sender = createSenderFromKey(keyPair);
// await highloadContract.sendDeploy(provider, sender, deployAmount);
//
// Important: do not commit secret keys in repo. Use secrets or a secure vault.

console.log('CONFIRM_DEPLOY was true but SEND DEPLOY is not implemented. Implement the TODO block to perform the actual deploy.');
}

main().catch((e) => {
console.error('Error:', e);
process.exit(1);
});