Polymesh SDK API Reference
v5.0.0
v5.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
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • 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
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected Optional _id
  • Protected context
  • delete
  • id
  • modifyName
  • moveFunds
  • owner
  • setCustodian
  • uuid
  • Methods
  • createdAt
  • exists
  • getCustodian
  • getName
  • getTokenBalances
  • getTransactionHistory
  • isCustodiedBy
  • isEqual
  • isOwnedBy
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

NumberedPortfolio

PreviousMiddlewareNextOfferings

Last updated 3 years ago

Was this helpful?

Represents a numbered (non-default) Portfolio for an Identity

Hierarchy

↳

↳ NumberedPortfolio

Index

Properties

Methods

Properties

Protected Optional _id

• _id? : BigNumber

internal Portfolio identifier (unused for default Portfolio)

Protected context

delete

• delete: ProcedureMethod‹void, void›

Delete this Portfolio

note required role:

  • Portfolio Custodian

id

• id: BigNumber

portfolio identifier number

modifyName

Rename portfolio

note required role:

  • Portfolio Custodian

moveFunds

Moves funds from this Portfolio to another one owned by the same Identity

param portfolio (or portfolio ID) that will receive the funds. Optional, if no value is passed, the funds will be moved to the default Portfolio of this Portfolio's owner

param list of tokens (and their corresponding amounts) that will be moved

note required role:

  • Portfolio Custodian

owner

identity of the Portfolio's owner

setCustodian

Send an invitation to an Identity to assign it as custodian for this Portfolio

note this may create an AuthorizationRequest which has to be accepted by the corresponding Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

  • Portfolio Custodian

uuid

• uuid: string

Methods

createdAt

Retrieve the identifier data (block number, date and event index) of the event that was emitted when this portfolio was created

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

exists

▸ exists(): Promise‹boolean›

Return whether this Portfolio exists

Returns: Promise‹boolean›

getCustodian

Retrieve the custodian Identity of this Portfolio

note if no custodian is set, the owner Identity is returned

getName

▸ getName(): Promise‹string›

Return the Portfolio name

Returns: Promise‹string›

getTokenBalances

Retrieve the balances of all assets in this Portfolio

Parameters:

Name

Type

args?

undefined | object

getTransactionHistory

Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters

note supports pagination

note uses the middleware

Parameters:

â–ªDefault value filters: object= {}

Name

Type

Description

account?

undefined | string

account involved in the settlement

size?

undefined | number

page size

start?

undefined | number

page offset

ticker?

undefined | string

ticker involved in the transaction

isCustodiedBy

▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›

Return whether an Identity is the Portfolio custodian

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹boolean›

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

isOwnedBy

▸ isOwnedBy(args?: undefined | object): Promise‹boolean›

Return whether an Identity is the Portfolio owner

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹boolean›

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers: object

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Inherited from .

Defined in

• context:

Inherited from .

Defined in

Defined in

Defined in

• modifyName: ProcedureMethod‹, ›

Defined in

• moveFunds: ProcedureMethod‹, void›

Inherited from .

Defined in

• owner:

Inherited from .

Defined in

• setCustodian: ProcedureMethod‹, void›

Inherited from .

Defined in

Inherited from .

Defined in

▸ createdAt(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

Defined in

▸ getCustodian(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

Defined in

▸ getTokenBalances(args?: undefined | object): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getTransactionHistory(filters: object): Promise‹‹››

Inherited from .

Defined in

Returns: Promise‹‹››

Inherited from .

Defined in

▸ isEqual(entity: ‹object›): boolean

Inherited from .

Defined in

‹object›

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Portfolio/index.ts:59
Context
src/api/entities/Entity.ts:48
src/api/entities/NumberedPortfolio.ts:72
src/api/entities/NumberedPortfolio.ts:44
RenamePortfolioParams
NumberedPortfolio
src/api/entities/NumberedPortfolio.ts:80
MoveFundsParams
src/api/entities/Portfolio/index.ts:208
Identity
src/api/entities/Portfolio/index.ts:54
SetCustodianParams
src/api/entities/Portfolio/index.ts:196
src/api/entities/Entity.ts:46
EventIdentifier
src/api/entities/NumberedPortfolio.ts:108
EventIdentifier
src/api/entities/NumberedPortfolio.ts:132
Identity
src/api/entities/Portfolio/index.ts:215
Identity
src/api/entities/NumberedPortfolio.ts:85
PortfolioBalance
src/api/entities/Portfolio/index.ts:119
PortfolioBalance
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:250
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:103
Entity
src/api/entities/Entity.ts:61
src/api/entities/Portfolio/index.ts:87
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Portfolio
_id
context
delete
id
modifyName
moveFunds
owner
setCustodian
uuid
createdAt
exists
getCustodian
getName
getTokenBalances
getTransactionHistory
isCustodiedBy
isEqual
isOwnedBy
generateUuid
unserialize
Entity
Portfolio
CheckpointSchedule
Portfolio
Portfolio
Portfolio
CheckpointSchedule
Portfolio
Portfolio
Portfolio
Portfolio
CheckpointSchedule
Portfolio
CheckpointSchedule
CheckpointSchedule
context
uuid
isEqual
generateUuid
unserialize
_id
moveFunds
owner
setCustodian
getCustodian
getTokenBalances
getTransactionHistory
isCustodiedBy
isOwnedBy