types/index

Index

Enumerations

• ErrorCode

• Feature

• PolyTransactionTag

• ProcedureType

• SecurityTokenRole

• StoRole

• StoType

• TransactionSpeed

• TransactionStatus

• TransferStatusCode

Interfaces

• ApproveErc20ProcedureArgs

• AssignSecurityTokenRoleProcedureArgs

• AssignStoRoleProcedureArgs

• ControllerRedeemProcedureArgs

• ControllerTransferProcedureArgs

• CreateCheckpointProcedureArgs

• CreateDividendDistributionProcedureArgs

• CreateSecurityTokenProcedureArgs

• CustomCurrency

• DisableControllerProcedureArgs

• DisableFeatureProcedureArgs

• DividendTokenholderStatus

• EnableCountTransferManagerProcedureArgs

• EnableDividendManagerProcedureArgs

• EnableGeneralPermissionManagerProcedureArgs

• EnableGeneralTransferManagerProcedureArgs

• EnablePercentageTransferManagerProcedureArgs

• Fees

• FinalizeStoProcedureArgs

• FreezeIssuanceProcedureArgs

• FutureLowLevelMethod

• InvestInSimpleStoProcedureArgs

• InvestInTieredStoBaseProcedureArgs

• InvestWithStableCoinArgs

• IssuanceDataEntry

• IssueTokensProcedureArgs

• LaunchSimpleStoProcedureArgs

• LaunchTieredStoProcedureArgs

• ModifyDividendsDefaultExclusionListProcedureArgs

• ModifyMaxHolderCountProcedureArgs

• ModifyMaxHolderPercentageProcedureArgs

• ModifyPercentageExemptionsProcedureArgs

• ModifyTieredStoDataProcedureArgs

• ModifyTokenholderDataProcedureArgs

• PercentageWhitelistEntry

• Pojo

• PullDividendPaymentProcedureArgs

• PushDividendPaymentProcedureArgs

• ReclaimFundsProcedureArgs

• RemoveDocumentProcedureArgs

• ReserveSecurityTokenProcedureArgs

• RevokeKycProcedureArgs

• SetControllerProcedureArgs

• SetDividendsWalletProcedureArgs

• SetDocumentProcedureArgs

• SignDisableControllerAckProcedureArgs

• SignFreezeIssuanceAckProcedureArgs

• SignTransferDataProcedureArgs

• StoTier

• TaxWithholdingEntry

• ToggleAllowBeneficialInvestmentsProcedureArgs

• ToggleAllowPreIssuingProcedureArgs

• ToggleFreezeTransfersProcedureArgs

• TogglePauseStoProcedureArgs

• TokenholderBalance

• TokenholderDataEntry

• TransactionSpec

• TransferErc20ProcedureArgs

• TransferOwnershipProcedureArgs

• TransferReservationOwnershipProcedureArgs

• TransferSecurityTokensProcedureArgs

• UpdateDividendsTaxWithholdingListProcedureArgs

• WithdrawTaxesProcedureArgs

Type aliases

• InvestInTieredStoProcedureArgs

• LowLevelMethod

• MapMaybeResolver

• MaybeResolver

• Omit

• PostTransactionResolverArray

• ResolverArray

• SignatureRequest

Functions

• isInvestWithStableCoinArgs

• isPojo

• isStoType

Type aliases

InvestInTieredStoProcedureArgs

Ƭ InvestInTieredStoProcedureArgs: InvestInTieredStoBaseProcedureArgs & object | InvestWithStableCoinArgs

Defined in src/types/index.ts:652

Arguments for the InvestInTieredSto Procedure

LowLevelMethod

Ƭ LowLevelMethod: function

Defined in src/types/index.ts:1499

Transaction method from the contract-wrappers package

Type declaration:

▸ (args: A): Promise‹PolyResponse›

Parameters:

Name	Type
args	A

MapMaybeResolver

Ƭ MapMaybeResolver: object

Defined in src/types/index.ts:1550

Apply the MaybeResolver type to a tuple of types

Type declaration:

MaybeResolver

Ƭ MaybeResolver: PostTransactionResolver‹T, any› | T

Defined in src/types/index.ts:1545

Either a specific type or a Post Transaction Resolver that resolves to that type

Omit

Ƭ Omit: Pick‹T, Exclude‹keyof T, K››

Defined in src/types/index.ts:1492

Return the type that results from excluding a property from another type

PostTransactionResolverArray

Ƭ PostTransactionResolverArray: object

Defined in src/types/index.ts:1538

Transforms a tuple of types into an array of Post Transaction Resolvers. For each type in the tuple, the corresponding Post Transaction Resolver resolves to that type

Type declaration:

ResolverArray

Ƭ ResolverArray: object

Defined in src/types/index.ts:1529

Transforms a tuple of types into an array of resolver functions. For each type in the tuple, the corresponding resolver function returns that type wrapped in a promise

Type declaration:

SignatureRequest

Ƭ SignatureRequest: function

Defined in src/types/index.ts:1506

Signature request method from the contract-wrappers package

Type declaration:

▸ (args: A): Promise‹string›

Parameters:

Name	Type
args	A

Functions

isInvestWithStableCoinArgs

▸ isInvestWithStableCoinArgs(args: any): args is InvestWithStableCoinArgs

Defined in src/types/index.ts:690

Check whether the arguments are of type InvestWithStableCoinArgs

Parameters:

Name	Type
args	any

Returns: args is InvestWithStableCoinArgs

isPojo

▸ isPojo(pojo: any): pojo is Pojo

Defined in src/types/index.ts:1427

Check to see if an object is a Plain Old Javascript Object (POJO)

Parameters:

Name	Type
pojo	any

Returns: pojo is Pojo

isStoType

▸ isStoType(type: any): type is StoType

Defined in src/types/index.ts:58

Check if the argument is of type [[STOType]]

Parameters:

Name	Type
type	any

Returns: type is StoType