Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • Methods
  • create
  • delete
  • getCustodiedPortfolios
  • getPortfolio
  • getPortfolios

Was this helpful?

  1. Classes

Portfolios

PreviousPortfolioNextRequirements

Last updated 3 years ago

Was this helpful?

Handles all Portfolio related functionality on the Identity side

Hierarchy

  • Namespace‹›

    ↳ Portfolios

Index

Properties

Methods

Properties

Protected context

Inherited from void

Protected parent

Inherited from void

Methods

create

Create a new Portfolio for the Identity

Parameters:

▪ args: object

Name

Type

name

string

delete

Delete a Portfolio by ID

note required role:

  • Portfolio Custodian

Parameters:

▪ args: object

Name

Type

portfolio

getCustodiedPortfolios

note supports pagination

Parameters:

Name

Type

paginationOpts?

getPortfolio

Retrieve a numbered Portfolio or the default Portfolio if Portfolio ID is not passed

Parameters:

▪ args: object

Name

Type

portfolioId

BigNumber

getPortfolios

▸ getPortfolios(): Promise‹[]›

Retrieve all the Portfolios owned by this Identity

Returns: Promise‹[]›

• context:

Defined in

• parent:

Defined in

▸ create(args: object): Promise‹‹››

Defined in

note this method is of type , which means you can call create.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ delete(args: object): Promise‹‹void››

Defined in

note this method is of type , which means you can call delete.checkAuthorization on it to see whether the Current Account has the required permissions to run it

BigNumber |

Returns: Promise‹‹void››

▸ getCustodiedPortfolios(paginationOpts?: ): Promise‹‹ | ››

Defined in

Retrieve all Portfolios custodied by this Identity. This only includes portfolios owned by a different Identity but custodied by this one. To fetch Portfolios owned by this Identity, use

Returns: Promise‹‹ | ››

▸ getPortfolio(): Promise‹›

Defined in

Returns: Promise‹›

▸ getPortfolio(args: object): Promise‹›

Defined in

Returns: Promise‹›

Defined in

Context
src/api/entities/Namespace.ts:11
Identity
src/api/entities/Namespace.ts:9
TransactionQueue
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:165
ProcedureMethod
TransactionQueue
NumberedPortfolio
TransactionQueue
src/api/entities/Identity/Portfolios.ts:178
ProcedureMethod
TransactionQueue
PaginationOptions
ResultSet
DefaultPortfolio
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:81
ResultSet
DefaultPortfolio
NumberedPortfolio
DefaultPortfolio
src/api/entities/Identity/Portfolios.ts:128
DefaultPortfolio
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:129
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:50
Identity
context
parent
create
delete
getCustodiedPortfolios
getPortfolio
getPortfolios
getPortfolios
NumberedPortfolio
PaginationOptions