feat: Generate a random contract key pair if one is not set

Author: Kok Kek

src/cli/actions/compile/generator/generateTypeScript.ts

@@ -28,7 +28,7 @@ ${payloadClass}
 }
 
 function getImports (name: string): string {
-  return `import { type CompiledContractConfig, Contract, type ContractOptions, type ResultOfCall, ZERO } from 'vendee'
+  return `import { type CompiledContractConfig, Contract, type ContractOptions, type ResultOfCall } from 'vendee'
 import { type KeyPair, type ResultOfProcessMessage } from '@eversdk/core'
 import ${name}Content from './${name}Content'`
 }
@@ -66,12 +66,12 @@ function getContractClass (name: string, abi: AbiContract): string {
   private readonly _call: ${name}Calls
   private readonly _run: ${name}Runs
   private readonly _payload: ${name}Payload
-  constructor (config: CompiledContractConfig, options: ContractOptions = {}) {
+  constructor (config: CompiledContractConfig = {}, options: ContractOptions = {}) {
     if (config.address === undefined)
       super({
         abi: ${name}Content.abi,
         initialData: config.initialData ?? {},
-        keys: config.keys ?? ZERO.keys,
+        keys: config.keys,
         tvc: ${name}Content.tvc
       }, options)
     else

src/cli/actions/giver/printContract.ts

@@ -47,9 +47,9 @@ export async function printContract (contract: Contract): Promise<void> {
  *   '1,234,567,890.123,456,789'
 */
 export function prettifyBalance (balance: bigint): string {
-  const integerPartOfNumber = balance / B
+  const integerPartOfNumber = balance / BigInt(B)
   const integerPartOfNumberText = integerPartOfNumber.toLocaleString()
-  const fractionalPartOfNumber = balance % B + B
+  const fractionalPartOfNumber = balance %  BigInt(B) + BigInt(B)
   const fractionalPartOfNumberText = fractionalPartOfNumber.toLocaleString(
     'en',
     { maximumFractionDigits: 10 }

src/cli/actions/giver/validate.ts

@@ -17,7 +17,7 @@ export function validate (options: SendOptions): {
 
   return {
     to: options.to,
-    value: BigInt(parseFloat(options.value) * parseFloat(B.toString()))
+    value: BigInt(parseFloat(options.value) * B)
   }
 }
 

src/contract/constants.ts

@@ -1,18 +1,11 @@
 import { x0 } from '../utils/hex'
 
 export const error = {
-  noKeys: new Error('Contract key pair is undefined'),
   noClient: new Error('SDK client is undefined'),
   noTvc: new Error('Contract tvc is undefined'),
   noGiver: new Error('Contract giver is undefined'),
   contractAlreadyDeployed: new Error('Contract already deployed')
 }
 export const ZERO256 = '0000000000000000000000000000000000000000000000000000000000000000'
-export const ZERO = {
-  keys: {
-    public: ZERO256,
-    secret: ZERO256
-  },
-  address: `0:${ZERO256}`,
-  uint256: x0(ZERO256)
-}
+export const ZERO_ADDRESS = `0:${ZERO256}`
+export const ZERO_UINT256 = x0(ZERO256)

src/contract/index.ts

@@ -8,6 +8,7 @@ import { type Giver } from '../giver'
 import { Global } from '../global'
 import { error } from './constants'
 import { createPayload } from './payload'
+import { generateRandomKeyPair } from '../keys'
 
 export enum AccountType {
   notFound = '-1',
@@ -18,13 +19,9 @@ export enum AccountType {
 }
 
 export type CompiledContractConfig = {
-  address: string
-  initialData?: Record<string, any>
-  keys?: KeyPair
-} | {
   address?: string
   initialData?: Record<string, any>
-  keys: KeyPair
+  keys?: KeyPair
 }
 
 export type ContractOptions = {
@@ -44,42 +41,42 @@ export class Contract {
   }
 
   private readonly initialData?: Record<string, any>
-  private readonly keys?: KeyPair
   private readonly tvc?: string
 
   private readonly client?: TonClient
   private readonly giver?: Giver
 
   private _address?: string
+  private _keys?: KeyPair
   private _lastTransactionLogicTime: string
 
   constructor (
     config: {
       address: string
+      keys?: KeyPair
       abi?: AbiContract
       initialData?: Record<string, any>
       tvc?: string
-      keys?: KeyPair
     } | {
       address?: string
+      keys?: KeyPair
       abi: AbiContract
       initialData: Record<string, any>
       tvc: string
-      keys: KeyPair
     },
     options: {
       client?: TonClient
       giver?: Giver
     } = {}
   ) {
     this._address = config.address
+    this._keys = config.keys
     this._lastTransactionLogicTime = '0'
     this.abi = {
       type: 'Contract',
       value: config.abi ?? {}
     }
     this.initialData = config.initialData ?? {}
-    this.keys = config.keys
     this.tvc = config.tvc
 
     this.client = options.client ?? Global.client
@@ -102,17 +99,14 @@ export class Contract {
     if (this.client === undefined)
       throw error.noClient
 
-    if (this.keys === undefined)
-      throw error.noKeys
-
     if (this.tvc === undefined)
       throw new Error('Contract tvc is undefined')
 
     this._address = (await this.client.abi.encode_message({
       abi: this.abi,
       signer: {
         type: 'Keys',
-        keys: this.keys
+        keys: await this.keys()
       },
       deploy_set: {
         tvc: this.tvc,
@@ -122,6 +116,27 @@ export class Contract {
     return this._address
   }
 
+  /**
+   * Generates a random key pair if no keys are given. Next time returns the already generated key pair
+   * @example
+   *   const contract = new Contract(...)
+   *   const address = await contract.keyPair()
+   * @return
+   *   '0:97b53be2604579e89bd0077a5456456857792eb2ff09849d14321fc2c167f29e'
+   */
+  public async keys (): Promise<KeyPair> {
+    if (this._keys !== undefined)
+      return this._keys
+
+    if (this.client === undefined)
+      throw error.noClient
+
+    if (this.tvc === undefined)
+      throw new Error('Contract tvc is undefined')
+
+    return this._keys = await generateRandomKeyPair(this.client)
+  }
+
   /**
    * Return contract balance
    * @example
@@ -250,13 +265,6 @@ export class Contract {
     if (this.client === undefined)
       throw error.noClient
 
-    ////////////////
-    // Check keys //
-    ////////////////
-    const keysPair = keys ?? this.keys
-    if (keysPair === undefined)
-      throw error.noKeys
-
     ///////////////////////////////
     // Generate external message //
     ///////////////////////////////
@@ -265,7 +273,7 @@ export class Contract {
         abi: this.abi,
         signer: {
           type: 'Keys',
-          keys: keysPair
+          keys: keys ?? await this.keys()
         },
         address: await this.address(),
         call_set: {
@@ -321,9 +329,6 @@ export class Contract {
     if (this.client === undefined)
       throw error.noClient
 
-    if (this.keys === undefined)
-      throw error.noKeys
-
     if (this.tvc === undefined)
       throw error.noTvc
 
@@ -368,7 +373,7 @@ export class Contract {
         abi: this.abi,
         signer: {
           type: 'Keys',
-          keys: this.keys
+          keys: await this.keys()
         },
         deploy_set: {
           tvc: this.tvc,

src/contract/samples/GiverV2/index.ts

@@ -1,7 +1,6 @@
 import { GiverV2Content } from './GiverV2Content'
 import { type CompiledContractConfig, Contract, type ContractOptions, type ResultOfCall } from '../../index'
 import { type KeyPair } from '@eversdk/core'
-import { ZERO } from '../../constants'
 
 type SendTransactionIn = {
   dest: string
@@ -30,7 +29,7 @@ export class GiverV2 extends Contract {
       super({
         abi: GiverV2Content.abi,
         initialData: config.initialData ?? {},
-        keys: config.keys ?? ZERO.keys,
+        keys: config.keys,
         tvc: GiverV2Content.tvc
       }, options)
     else

src/contract/samples/GiverV3/index.ts

@@ -1,7 +1,6 @@
 import { GiverV3Content } from './GiverV3Content'
 import { type CompiledContractConfig, Contract, type ContractOptions, type ResultOfCall } from '../../index'
 import { type KeyPair } from '@eversdk/core'
-import { ZERO } from '../../constants'
 
 type SendTransactionIn = {
   dest: string
@@ -30,7 +29,7 @@ export class GiverV3 extends Contract {
       super({
         abi: GiverV3Content.abi,
         initialData: config.initialData ?? {},
-        keys: config.keys ?? ZERO.keys,
+        keys: config.keys,
         tvc: GiverV3Content.tvc
       }, options)
     else

src/contract/samples/SafeMultisigWallet/index.ts

@@ -1,7 +1,6 @@
 import { SafeMultisigWalletContent } from './SafeMultisigWalletContent'
 import { type CompiledContractConfig, Contract, type ContractOptions, type ResultOfCall } from '../../index'
 import { type KeyPair, type ResultOfProcessMessage } from '@eversdk/core'
-import { ZERO } from '../../constants'
 
 type DeployIn = {
   owners: string[] | number[] | bigint[]
@@ -108,7 +107,7 @@ export class SafeMultisigWallet extends Contract {
       super({
         abi: SafeMultisigWalletContent.abi,
         initialData: config.initialData ?? {},
-        keys: config.keys ?? ZERO.keys,
+        keys: config.keys,
         tvc: SafeMultisigWalletContent.tvc
       }, options)
     else

src/index.ts

@@ -7,7 +7,7 @@ import { type Config } from './cli/config/types'
 // Contract //
 //////////////
 import { AccountType, type CompiledContractConfig, type ContractOptions, type ResultOfCall, Contract } from './contract'
-import { ZERO256, ZERO } from './contract/constants'
+import { ZERO256, ZERO_ADDRESS, ZERO_UINT256 } from './contract/constants'
 import { createPayload, createTransferPayload } from './contract/payload'
 import { GiverV2 } from './contract/samples/GiverV2'
 import { GiverV2Content } from './contract/samples/GiverV2/GiverV2Content'
@@ -56,7 +56,8 @@ export {
   type ResultOfCall,
   Contract,
   ZERO256,
-  ZERO,
+  ZERO_ADDRESS,
+  ZERO_UINT256,
   createPayload,
   createTransferPayload,
   GiverV2,

src/keys/index.ts

@@ -7,7 +7,7 @@ import { type KeyPair, type TonClient } from '@eversdk/core'
 /**
  * Wrapper for crypto.generate_random_sign_keys()
  * @example
- *   await createRandomKeyPair('/home/user/keys/GiverV2.keys.json')
+ *   await createRandomKeyPair()
  * @return
  *   {
  *     public: '61d08f0f1aa152095b6b2e19f31bf09d84a5ae6037be9247d0e54a3926d46593',
@@ -76,7 +76,7 @@ export async function generateOrReadKeys (file: string, client?: TonClient): Pro
  * @param directory Keys relative path e.g. `./keys`
  * @param client SDK client
  * @example
- *   namedKeys('/home/user/keys/GiverV2.keys.json')
+ *   namedKeys('root')
  * @return
  *   {
  *     public: '61d08f0f1aa152095b6b2e19f31bf09d84a5ae6037be9247d0e54a3926d46593',

src/utils/suffixes.ts

@@ -1,5 +1,5 @@
 export const Q = BigInt(1_000_000_000_000_000)
-export const T = BigInt(1_000_000_000_000)
-export const B = BigInt(1_000_000_000)
-export const M = BigInt(1_000_000)
-export const K = BigInt(1_000)
+export const T = 1_000_000_000_000
+export const B = 1_000_000_000
+export const M = 1_000_000
+export const K = 1_000