This repo contains smart contracts and Node JS scripts, which allows to execute massive TON distributions.
$ node --version
v10.21.0
$ npm install
The contract source is available at /contracts/airdrop.sol. To deploy contract you need to specify the following attributes:
- Refund address
- List of amounts
- List of receivers
- Refund lock duration in seconds
Important: Attributes are specified at the creation step and can't be changed later.
Recommended size for addresses amount - 100 addresses.
This address will be used in case you need to return your TONs. The contract has the refund() method which refunds all contract's balance to the refund address.
This parameters describes the amount of seconds that should pass since the contract creation. Only after that refund function can be executed.
Bellow you can find the detailed description for each action, required for distribution process.
This pair will be used for contract creation. The keys will be automatically written in the keys.json file.
$ node examples/generate-keys.js
New keys written in the keys.json
{ public:
'266c96f4a194cbacdb1329a37ddc285f237ad32d01ff1a9532d127e62123a53e',
secret:
'a2a2de9256ed927cbc639ece41a63b857a5f93ec16a31b439cb57060f44ff14a' }
Be careful: running the script again will rewrite the previous keys. Do this if you need to deploy another instance of the contract.
You need to edit the config.yaml file or create new file with YAML configuration. Basic layout is already provided in config.yaml:
addresses_and_amounts_csv: 'validators.csv'
refund_destination: '0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c'
keys: 'keys.json'
refund_lock_duration_in_seconds: 10000
contractAddress: ''All the scripts bellow supports the --config flag with the path to the configuration (config.yaml by default).
The csv file should include 2 columns: first one is raw addresses and the second one is amount in nanograms. Also, there should be no header line:
0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c,100
0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c,123
0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c,1000000
0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c,10000000000
$ node examples/pre-deploy.js
Future address of the contract will be: 0:be3cdd3cdda63901cdcd9ced1d3e50d7f1d8207b2711cfda4e4b4899434c2a77
Use this address for wallet: UQC-PN083aY5Ac3NnO0dPlDX8dggeycRz9pOS0iZQ0wqdyya
Use any wallet (for example Broxus wallet) to send TONs. The amount of TONs depends on the amount of provided pairs (receiver, amount). For 1 pair 0.1 TON is enough.
After the TONs were received by the contract, you can deploy the contract.
$ node examples/deploy.js
Contract deployed at 0:be3cdd3cdda63901cdcd9ced1d3e50d7f1d8207b2711cfda4e4b4899434c2a77
Important At this step, specify the contract address at the contractAddress field at configuration file.
You can verify that the attributes are correct by calling the list of getter functions in contract. The script bellow just automates this process.
$ node examples/get-contract-details.js
Contract balance: 69361999
Total amount: 100
Sufficient balance
Refund address: 0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c
Refund lock ends at: Wed Jul 15 2020 23:49:13 GMT+0300 (Moscow Standard Time)
List of receivers and amounts with distribution status:
0 false '0:28861a9d4a9c9766e1129f7323e01ba0c98c33d5414c0036b8194282ff7abc5c' 100
After you make sure that everything is correct, you should send the necessary amount of TONs to the contract. This also can be done with Broxus wallet.
The important thing that each pair of (address, amount) will take part in distribution only once. So in any case, no address will receive the amount twice.
$ node examples/distribute.js
Called successfully
If you need to refund some TONs you can use the following script:
$ node examples/refund.js
Called successfully
The contract have been tested for
- Refund case
- Distribute case
- Double distribute case
- Distribute and refund case