Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected Optional _id
  • Protected context
  • id
  • owner
  • uuid
  • Methods
  • createdAt
  • createdAtV2
  • exists
  • getAssetBalances
  • getCustodian
  • getName
  • getTransactionHistory
  • getTransactionHistoryV2
  • isCustodiedBy
  • isEqual
  • isOwnedBy
  • modifyName
  • moveFunds
  • quitCustody
  • setCustodian
  • toHuman
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

NumberedPortfolio

PreviousNetworkNextOffering

Last updated 2 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

• context: Context


id

• id: BigNumber

Portfolio identifier number


owner

Identity of the Portfolio's owner


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


createdAtV2

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

note uses the middlewareV2

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›


getAssetBalances

Retrieve the balances of all Assets in this Portfolio

Parameters:

Name
Type

args?

undefined | object


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›


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?

BigNumber

page size

start?

BigNumber

page offset

ticker?

undefined | string

ticker involved in the transaction


getTransactionHistoryV2

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

note uses the middlewareV2

Parameters:

â–ªDefault value filters: object= {}

Name
Type
Description

account?

undefined | string

Account involved in the settlement

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

Determine 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›


modifyName

Rename portfolio

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

args

opts?


moveFunds

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

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

args

opts?


quitCustody

Returns the custody of the portfolio to the portfolio owner unilaterally

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

opts?


setCustodian

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

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

args

opts?


toHuman

Return the Portfolio ID and owner DID


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

Inherited from .

Defined in

Defined in

• owner:

Inherited from .

Defined in

Inherited from .

Defined in

▸ createdAt(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

▸ createdAtV2(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

Overrides .

Defined in

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

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getCustodian(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

Defined in

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

Inherited from .

Defined in

Returns: Promise‹‹››

▸ getTransactionHistoryV2(filters: object): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

Inherited from .

Defined in

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Inherited from .

Defined in

▸ modifyName(args: , opts?: ): Promise‹‹››

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹››

▸ moveFunds(args: , opts?: ): Promise‹‹void››

Inherited from .

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹void››

▸ quitCustody(opts?: ): Promise‹‹void››

Inherited from .

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹void››

▸ setCustodian(args: , opts?: ): Promise‹‹››

Inherited from .

Defined in

note this will create an which has to be accepted by the targetIdentity. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹››

â–¸ toHuman():

Inherited from .

Overrides .

Defined in

Returns:

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Portfolio/index.ts:83
src/api/entities/Entity.ts:48
src/api/entities/NumberedPortfolio.ts:49
Identity
src/api/entities/Portfolio/index.ts:78
src/api/entities/Entity.ts:46
EventIdentifier
src/api/entities/NumberedPortfolio.ts:114
EventIdentifier
EventIdentifier
src/api/entities/NumberedPortfolio.ts:141
EventIdentifier
src/api/entities/NumberedPortfolio.ts:167
PortfolioBalance
src/api/entities/Portfolio/index.ts:144
PortfolioBalance
Identity
src/api/entities/Portfolio/index.ts:274
Identity
src/api/entities/NumberedPortfolio.ts:83
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:319
ResultSet
HistoricSettlement
HistoricSettlement
src/api/entities/Portfolio/index.ts:421
HistoricSettlement
src/api/entities/Portfolio/index.ts:128
Entity
src/api/entities/Entity.ts:61
src/api/entities/Portfolio/index.ts:115
RenamePortfolioParams
ProcedureOpts
TransactionQueue
NumberedPortfolio
src/api/entities/NumberedPortfolio.ts:76
ProcedureMethod
modifyName.checkAuthorization
TransactionQueue
NumberedPortfolio
MoveFundsParams
ProcedureOpts
TransactionQueue
src/api/entities/Portfolio/index.ts:252
ProcedureMethod
moveFunds.checkAuthorization
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/Portfolio/index.ts:265
NoArgsProcedureMethod
quitCustody.checkAuthorization
TransactionQueue
SetCustodianParams
ProcedureOpts
TransactionQueue
AuthorizationRequest
src/api/entities/Portfolio/index.ts:239
ProcedureMethod
setCustodian.checkAuthorization
TransactionQueue
AuthorizationRequest
HumanReadable
src/api/entities/Portfolio/index.ts:540
HumanReadable
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Portfolio
_id
context
id
owner
uuid
createdAt
createdAtV2
exists
getAssetBalances
getCustodian
getName
getTransactionHistory
getTransactionHistoryV2
isCustodiedBy
isEqual
isOwnedBy
modifyName
moveFunds
quitCustody
setCustodian
toHuman
generateUuid
unserialize
Entity
RenamePortfolioParams
ProcedureOpts
MoveFundsParams
ProcedureOpts
ProcedureOpts
SetCustodianParams
ProcedureOpts
Portfolio
CheckpointSchedule
Portfolio
CheckpointSchedule
Entity
Portfolio
Portfolio
Portfolio
Portfolio
Portfolio
CheckpointSchedule
Portfolio
Portfolio
Portfolio
Portfolio
Authorization Request
Account
Identity
Portfolio
Entity
CheckpointSchedule
CheckpointSchedule
authorizations.getReceived
authorizations.getOne
exists
toHuman
context
uuid
isEqual
generateUuid
unserialize
_id
owner
getAssetBalances
getCustodian
getTransactionHistory
getTransactionHistoryV2
isCustodiedBy
isOwnedBy
moveFunds
quitCustody
setCustodian
toHuman