# SetController

Procedure that sets the Controller of a Security Token. A Security Token's Controller can perform special functions reserved solely for them, such as forced transfers and redeeming (burning) tokens

## Type parameters

▪ **ReturnType**

## Hierarchy

* Procedure‹[SetControllerProcedureArgs](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)›

  ↳ **SetController**

## Index

### Constructors

* [constructor](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

### Properties

* [args](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)
* [context](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)
* [type](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

### Methods

* [addProcedure](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)
* [addSignatureRequest](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)
* [addTransaction](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)
* [prepare](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)
* [prepareTransactions](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

## Constructors

### constructor

\+ **new SetController**(`args`: [SetControllerProcedureArgs](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference), `context`: [Context](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)): [*SetController*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:40*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L40)

**Parameters:**

| Name      | Type                                                                                                                 |
| --------- | -------------------------------------------------------------------------------------------------------------------- |
| `args`    | [SetControllerProcedureArgs](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) |
| `context` | [Context](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)                    |

**Returns:** [*SetController*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

## Properties

### `Protected` args

• **args**: [*SetControllerProcedureArgs*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:34*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L34)

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:36*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L36)

### type

• **type**: [*ProcedureType*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) = ProcedureType.SetController

*Overrides void*

*Defined in* [*src/procedures/SetController.ts:11*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/SetController.ts#L11)

## Methods

### addProcedure

▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)‹A, R›): *(Anonymous function)*

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:91*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L91)

Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

**Type parameters:**

▪ **A**

▪ **R**: *any*

**Parameters:**

| Name   | Type                                                                                                           | Description                                                      |
| ------ | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `Proc` | [ProcedureClass](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue |

**Returns:** *(Anonymous function)*

whichever value is returned by the Procedure

### addSignatureRequest

▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](https://developers.polymath.network/classic-sdk/beta/_types_index_#signaturerequest)‹A›): *(Anonymous function)*

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:179*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L179)

Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

**Type parameters:**

▪ **A**

**Parameters:**

| Name      | Type                                                                                                       | Description                                                              |
| --------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `request` | [SignatureRequest](https://developers.polymath.network/classic-sdk/beta/_types_index_#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue |

**Returns:** *(Anonymous function)*

a PostTransactionResolver that resolves to the signed data

### addTransaction

▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](https://developers.polymath.network/classic-sdk/beta/_types_index_#lowlevelmethod)‹A› | [FutureLowLevelMethod](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)‹V, A›, `__namedParameters`: object): *(Anonymous function)*

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:137*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L137)

Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

**Type parameters:**

▪ **A**

▪ **R**: *any\[]*

▪ **V**: *any*

**Parameters:**

▪ **method**: [*LowLevelMethod*](https://developers.polymath.network/classic-sdk/beta/_types_index_#lowlevelmethod)*‹A› |* [*FutureLowLevelMethod*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)*‹V, A›*

A method (or future method) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time (for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run)

▪`Default value` **\_\_namedParameters**: *object*= {}

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Default                           |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `fees`      | undefined \| [Fees](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | -                                 |
| `resolvers` | object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | (\[] as unknown) as ResolverArray |
| `tag`       | undefined \| [Any](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [GetTokens](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ApproveErc20](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [TransferErc20](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ReserveSecurityToken](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [CreateSecurityToken](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [CreateCheckpoint](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [CreateErc20DividendDistribution](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetErc20TaxWithholding](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetEtherTaxWithholding](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetDefaultExcluded](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnableDividends](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnableCappedSto](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnableTieredSto](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnableGeneralPermissionManager](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnableGeneralTransferManager](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnableCountTransferManager](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [EnablePercentageTransferManager](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [DisableController](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [FreezeIssuance](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [DisableFeature](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ReclaimDividendFunds](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [WithdrawTaxWithholdings](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [PushDividendPayment](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [PullDividendPayment](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetDividendsWallet](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [AddDelegate](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ChangePermission](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ControllerTransfer](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ControllerRedeem](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [PauseSto](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [UnpauseSto](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [FinalizeSto](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetController](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetDocument](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [RemoveDocument](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyKycDataMulti](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyInvestorFlagMulti](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [IssueMulti](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [AllowPreMinting](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [RevokePreMinting](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ChangeAllowBeneficialInvestments](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyTimes](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyFunding](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyAddresses](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyTiers](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyLimits](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyOracles](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [BuyWithScRateLimited](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [BuyWithPolyRateLimited](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [BuyWithEthRateLimited](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [BuyTokens](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [BuyTokensWithPoly](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ChangeHolderCount](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ChangeHolderPercentage](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [ModifyWhitelistMulti](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [SetAllowPrimaryIssuance](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [TransferSecurityTokens](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [UnfreezeTransfers](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [FreezeTransfers](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [Signature](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [TransferReservationOwnership](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) \| [TransferOwnership](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference) | -                                 |

**Returns:** *(Anonymous function)*

a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed

### prepare

▸ **prepare**(): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)*‹Args, ReturnType››*

*Inherited from void*

*Defined in* [*src/procedures/Procedure.ts:52*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/Procedure.ts#L52)

Mandatory method that builds a list of transactions that will be run

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/classic-sdk/beta/external-modules/broken-reference)*‹Args, ReturnType››*

### prepareTransactions

▸ **prepareTransactions**(): *Promise‹void›*

*Overrides void*

*Defined in* [*src/procedures/SetController.ts:20*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/procedures/SetController.ts#L20)

Set the Controller address of the Security Token

Note this procedure will fail if:

* The supplied address is invalid
* The current wallet address is not the owner of the Security Token

**Returns:** *Promise‹void›*
