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 Optional _id
  • Protected context
  • owner
  • uuid
  • Methods
  • getCustodian
  • getTokenBalances
  • getTransactionHistory
  • isCustodiedBy
  • isEqual
  • isOwnedBy
  • moveFunds
  • setCustodian
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

DefaultPortfolio

PreviousCurrentIdentityNextDefaultTrustedClaimIssuer

Last updated 3 years ago

Was this helpful?

Represents the default Portfolio for an Identity

Hierarchy

↳

↳ DefaultPortfolio

Index

Properties

Methods

Properties

Protected Optional _id

• _id? : BigNumber

internal Portfolio identifier (unused for default Portfolio)

Protected context

owner

identity of the Portfolio's owner

uuid

• uuid: string

Methods

getCustodian

Retrieve the custodian Identity of this Portfolio

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

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›

moveFunds

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

note required role:

  • Portfolio Custodian

Parameters:

Name

Type

args

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

Parameters:

Name

Type

args

Static generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

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

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Inherited from .

Defined in

• context:

Inherited from .

Defined in

• owner:

Inherited from .

Defined in

Inherited from .

Defined in

▸ getCustodian(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

▸ 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: ‹unknown›): boolean

Inherited from .

Defined in

‹unknown›

Inherited from .

Defined in

▸ moveFunds(args: ): Promise‹‹void››

Inherited from .

Defined in

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

Returns: Promise‹‹void››

▸ setCustodian(args: ): Promise‹‹void››

Inherited from .

Defined in

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

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Portfolio/index.ts:59
Context
src/api/entities/Entity.ts:48
Identity
src/api/entities/Portfolio/index.ts:54
src/api/entities/Entity.ts:46
Identity
src/api/entities/Portfolio/index.ts:220
Identity
PortfolioBalance
src/api/entities/Portfolio/index.ts:119
PortfolioBalance
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:255
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:103
Entity
src/api/entities/Entity.ts:61
src/api/entities/Portfolio/index.ts:87
MoveFundsParams
TransactionQueue
src/api/entities/Portfolio/index.ts:211
ProcedureMethod
TransactionQueue
SetCustodianParams
TransactionQueue
src/api/entities/Portfolio/index.ts:198
ProcedureMethod
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Portfolio
_id
context
owner
uuid
getCustodian
getTokenBalances
getTransactionHistory
isCustodiedBy
isEqual
isOwnedBy
moveFunds
setCustodian
generateUuid
unserialize
Entity
MoveFundsParams
SetCustodianParams
Portfolio
CheckpointSchedule
Portfolio
CheckpointSchedule
Portfolio
Portfolio
Portfolio
Portfolio
CheckpointSchedule
Portfolio
Portfolio
Portfolio
CheckpointSchedule
CheckpointSchedule
_id
owner
getCustodian
getTokenBalances
getTransactionHistory
isCustodiedBy
isOwnedBy
moveFunds
setCustodian
context
uuid
isEqual
generateUuid
unserialize