Skip to content
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.

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

docs: modify max holder percentage docs #192

Merged
merged 6 commits into from Jan 15, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/procedures/ModifyMaxHolderPercentage.ts
Expand Up @@ -8,9 +8,19 @@ import {
} from '../types';
import { PolymathError } from '../PolymathError';

/**
* Procedure that modifies the maximum percentage that an individual token holder can hold
*/
export class ModifyMaxHolderPercentage extends Procedure<ModifyMaxHolderPercentageProcedureArgs> {
public type = ProcedureType.ModifyMaxHolderPercentage;

/**
* Modify the number of security tokens (expressed in percentage) that an investor can hold as maximum
*
* Note that this procedure will fail if:
* - The security token symbol doesn't exist
* - The security token has disabled the PercentageOwnershipRestrictions feature
*/
public async prepareTransactions() {
const { symbol, maxHolderPercentage } = this.args;
const { contractWrappers } = this.context;
Expand Down