Skip to content
This repository has been archived by the owner on Jul 6, 2022. It is now read-only.

Commit

Permalink
Merge a3c83ed into ede81a7
Browse files Browse the repository at this point in the history
  • Loading branch information
@onigiri-x
onigiri-x committed Oct 1, 2019
2 parents ede81a7 + a3c83ed commit 35ac55f
Show file tree
Hide file tree
Showing 21 changed files with 496 additions and 976 deletions.
1 change: 1 addition & 0 deletions .eslintignore
View file
Expand Up @@ -2,6 +2,7 @@ lib/*
docs/*
scripts/*
sandbox.ts
sandboxSample.ts
test_utils/*
examples/*
webpack.*
188 changes: 64 additions & 124 deletions examples/blacklistTransferManager.ts
View file
@@ -1,131 +1,66 @@
import { RedundantSubprovider, RPCSubprovider, Web3ProviderEngine } from '@0x/subproviders';
import ModuleFactoryWrapper from '../src/contract_wrappers/modules/module_factory_wrapper';
import { ApiConstructorParams, PolymathAPI } from '../src/PolymathAPI';
import { ModuleName, ModuleType } from '../src';
import { PolymathAPI } from '../src/PolymathAPI';
import { ModuleName } from '../src';
import { BigNumber, BlacklistTransferManagerEvents_3_0_0 } from '@polymathnetwork/abi-wrappers';

// This file acts as a valid sandbox for using a blacklist restriction transfer manager module on an unlocked node (like ganache)
window.addEventListener('load', async () => {
// Setup the redundant provider
const providerEngine = new Web3ProviderEngine();
providerEngine.addProvider(new RedundantSubprovider([new RPCSubprovider('http://127.0.0.1:8545')]));
providerEngine.start();
const params: ApiConstructorParams = {
provider: providerEngine,
polymathRegistryAddress: '<Deployed Polymath Registry address>',
};

// Instantiate the API
const polymathAPI = new PolymathAPI(params);

// Get some poly tokens in your account and the security token
import { AddingModuleOpts, addModule, moduleInstancesLookup } from './modules';
import { addInvestorsToWhitelist } from './addInvestorsToWhitelist';
import { issueTokenToInvestors } from './issueTokenToInvestor';

/**
* This method adds a BlacklistTM module and uses it. Requires that a valid security token has already been generated.
* @param polymathAPI The polymathAPI instance.
* @param ticker Ticker symbol.
*/
export const blacklistTransferManager = async (polymathAPI: PolymathAPI, ticker: string) => {
const myAddress = await polymathAPI.getAccount();
await polymathAPI.getPolyTokens({ amount: new BigNumber(1000000), address: myAddress });

// Prompt to setup your ticker and token name
const ticker = prompt('Ticker', '');
const tokenName = prompt('Token Name', '');

// Double check available
await polymathAPI.securityTokenRegistry.tickerAvailable({
ticker: ticker!,
});
// Get the ticker fee and approve the security token registry to spend
const tickerFee = await polymathAPI.securityTokenRegistry.getTickerRegistrationFee();
await polymathAPI.polyToken.approve({
spender: await polymathAPI.securityTokenRegistry.address(),
value: tickerFee,
});
// Register a ticker
await polymathAPI.securityTokenRegistry.registerTicker({
ticker: ticker!,
tokenName: tokenName!,
});
// Get the st launch fee and approve the security token registry to spend
const securityTokenLaunchFee = await polymathAPI.securityTokenRegistry.getSecurityTokenLaunchFee();
await polymathAPI.polyToken.approve({
spender: await polymathAPI.securityTokenRegistry.address(),
value: securityTokenLaunchFee,
});

await polymathAPI.securityTokenRegistry.generateNewSecurityToken({
name: tokenName!,
ticker: ticker!,
tokenDetails: 'details',
divisible: true,
treasuryWallet: myAddress,
protocolVersion: '0',
});

console.log('Security Token Generated');

const moduleName = ModuleName.BlacklistTransferManager;

const modules = await polymathAPI.moduleRegistry.getModulesByType({
moduleType: ModuleType.TransferManager,
});

const instances: Promise<ModuleFactoryWrapper>[] = [];
modules.map(address => {
instances.push(polymathAPI.moduleFactory.getModuleFactory(address));
});
const resultInstances = await Promise.all(instances);

const names: Promise<string>[] = [];
resultInstances.map(instanceFactory => {
names.push(instanceFactory.name());
});
const resultNames = await Promise.all(names);

const index = resultNames.indexOf(moduleName);

// Create a Security Token Instance
const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);

// Get General TM Address to whitelist transfers
const generalTMAddress = (await tickerSecurityTokenInstance.getModulesByName({
moduleName: ModuleName.GeneralTransferManager,
}))[0];
const generalTM = await polymathAPI.moduleFactory.getModuleInstance({
name: ModuleName.GeneralTransferManager,
address: generalTMAddress,
});

await tickerSecurityTokenInstance.addModule({
moduleName,
address: modules[index],
const options: AddingModuleOpts = {
archived: false,
});
label: 'TM Label',
};
await addModule(
polymathAPI,
{
ticker,
moduleName: ModuleName.BlacklistTransferManager,
},
options,
);

// Declare some random beneficiaries to work with later on
const randomBeneficiaries = [
'0x3444444444444444444444444444444444444444',
'0x5544444444444444444444444444444444444444',
'0x6644444444444444444444444444444444444444',
];

// Add all address in the whitelist including myAddress
const kycInvestorMultiData = {
investors: randomBeneficiaries.concat(myAddress),
canSendAfter: [new Date(), new Date(), new Date(), new Date()],
canReceiveAfter: [new Date(), new Date(), new Date(), new Date()],
expiryTime: [new Date(2021, 10), new Date(2021, 10), new Date(2021, 10), new Date(2021, 10)],
};
await addInvestorsToWhitelist(polymathAPI, ticker, kycInvestorMultiData);

// Issue tokens to the investors
const issueMultiParams = {
investors: [myAddress],
values: [new BigNumber(1000)],
};
await issueTokenToInvestors(polymathAPI, ticker, issueMultiParams);

const blacklistTMAddress = (await tickerSecurityTokenInstance.getModulesByName({
const blacklistTM = (await moduleInstancesLookup(polymathAPI, {
ticker,
moduleName: ModuleName.BlacklistTransferManager,
}))[0];

const blacklistTM = await polymathAPI.moduleFactory.getModuleInstance({
name: ModuleName.BlacklistTransferManager,
address: blacklistTMAddress,
});

const randomBeneficiary1 = '0x2222222222222222222222222222222222222222';
const randomBeneficiary2 = '0x3333333333333333333333333333333333333333';

await generalTM.modifyKYCDataMulti({
investors: [myAddress, randomBeneficiary1, randomBeneficiary2],
canReceiveAfter: [new Date(), new Date(), new Date()],
canSendAfter: [new Date(), new Date(), new Date()],
expiryTime: [new Date(2035, 1), new Date(2035, 1), new Date(2035, 1)],
});

await tickerSecurityTokenInstance.issueMulti({
investors: [myAddress, randomBeneficiary1, randomBeneficiary2],
values: [new BigNumber(100), new BigNumber(100), new BigNumber(100)],
});
const tickerSecurityTokenInstance = await polymathAPI.tokenFactory.getSecurityTokenInstanceFromTicker(ticker!);

// Subscribe to event of addblacklisttype
await blacklistTM.subscribeAsync({
eventName: BlacklistTransferManagerEvents_3_0_0.AddBlacklistType,
indexFilterValues: {},
callback: async (error, log) => {
callback: async (error: any, log: any) => {
if (error) {
console.log(error);
} else {
Expand All @@ -134,7 +69,7 @@ window.addEventListener('load', async () => {
},
});

await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary2, value: new BigNumber(10) });
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiaries[2], value: new BigNumber(10) });
console.log(' No blacklist, 10 tokens transferred to randomBeneficiary2');

const startTime = new Date(Date.now() + 10000);
Expand All @@ -156,7 +91,7 @@ window.addEventListener('load', async () => {

// Try out transfer 10 above lockup, will fail
try {
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary2, value: new BigNumber(10) });
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiaries[2], value: new BigNumber(10) });
} catch (e) {
console.log('Transfer of 10 tokens during blacklist period amount fails as expected');
}
Expand All @@ -165,7 +100,7 @@ window.addEventListener('load', async () => {
await sleep(10000);

// Blacklist now over
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary2, value: new BigNumber(10) });
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiaries[2], value: new BigNumber(10) });
console.log('10 more tokens transferred to randomBeneficiary2');

const newStartTime = new Date(Date.now() + 10000);
Expand All @@ -175,28 +110,33 @@ window.addEventListener('load', async () => {
blacklistNames: testBlacklistNames,
startTimes: [newStartTime, newStartTime, newStartTime],
endTimes: [newEndTime, newEndTime, newEndTime],
repeatPeriodTimes: [1, 2, 3]
repeatPeriodTimes: [1, 2, 3],
});
console.log('Many more example blacklists created');

await blacklistTM.addMultiInvestorToBlacklistMulti({blacklistNames: testBlacklistNames, userAddresses: [myAddress, randomBeneficiary1, randomBeneficiary2]});
await blacklistTM.addMultiInvestorToBlacklistMulti({
blacklistNames: testBlacklistNames,
userAddresses: [myAddress, randomBeneficiaries[1], randomBeneficiaries[2]],
});
console.log('Multi investors added to multi blacklists');

await sleep(15000);

// Try out transfer 10 during blacklist, will fail
try {
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary2, value: new BigNumber(10) });
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiaries[2], value: new BigNumber(10) });
} catch (e) {
console.log('Transfer of 10 tokens during new blacklist period amount fails as expected');
}

await blacklistTM.deleteInvestorFromAllBlacklistMulti({investors: [myAddress, randomBeneficiary1, randomBeneficiary2]});
await blacklistTM.deleteInvestorFromAllBlacklistMulti({
investors: [myAddress, randomBeneficiaries[1], randomBeneficiaries[2]],
});
console.log('Multi investors deleted from all blacklists they are part of');

// Transfer out more tokens now that the investor has been removed from the new blacklist
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiary2, value: new BigNumber(10) });
await tickerSecurityTokenInstance.transfer({ to: randomBeneficiaries[2], value: new BigNumber(10) });
console.log('10 more tokens were successfully transferred to randomBeneficiary2');

tickerSecurityTokenInstance.unsubscribeAll();
});
};

0 comments on commit 35ac55f

Please sign in to comment.