Skip to main content
Version: 29.0.x

Class: DefaultPortfolio

Defined in: src/api/entities/DefaultPortfolio.ts:12

Represents the default Portfolio for an Identity

Extends​

Properties​

owner​

owner: Identity

Defined in: src/api/entities/Portfolio/index.ts:71

Identity of the Portfolio's owner

Inherited from​

Portfolio.owner

uuid​

uuid: string

Defined in: src/api/entities/Entity.ts:46

Inherited from​

Portfolio.uuid

Methods​

exists()​

exists(): Promise<boolean>

Defined in: src/api/entities/DefaultPortfolio.ts:23

Determine whether this Portfolio exists on chain

Returns​

Promise<boolean>

Overrides​

Portfolio.exists

getAssetBalances()​

getAssetBalances(args?: object): Promise<PortfolioBalance[]>

Defined in: src/api/entities/Portfolio/index.ts:133

Retrieve the balances of all fungible assets in this Portfolio

Parameters​

ParameterTypeDescription

args?

{ assets: (string | FungibleAsset)[]; }

‐

args.assets?

(string | FungibleAsset)[]

array of FungibleAssets (or tickers) for which to fetch balances (optional, all balances are retrieved if not passed)

Returns​

Promise<PortfolioBalance[]>

Inherited from​

Portfolio.getAssetBalances

getCollections()​

getCollections(args?: object): Promise<PortfolioCollection[]>

Defined in: src/api/entities/Portfolio/index.ts:212

Retrieve the NFTs held in this portfolio

Parameters​

ParameterTypeDescription

args?

{ collections: (string | NftCollection)[]; }

‐

args.collections?

(string | NftCollection)[]

array of NftCollection (or tickers) for which to fetch holdings (optional, all holdings are retrieved if not passed)

Returns​

Promise<PortfolioCollection[]>

Inherited from​

Portfolio.getCollections

getCustodian()​

getCustodian(): Promise<Identity>

Defined in: src/api/entities/Portfolio/index.ts:333

Retrieve the custodian Identity of this Portfolio

Returns​

Promise<Identity>

Note​

if no custodian is set, the owner Identity is returned

Inherited from​

Portfolio.getCustodian

getTransactionHistory()​

getTransactionHistory(filters: object): Promise<HistoricSettlement[]>

Defined in: src/api/entities/Portfolio/index.ts:375

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

Parameters​

ParameterTypeDescription

filters

{ account?: string; assetId?: string; ticker?: string; }

‐

filters.account?

string

Account involved in the settlement

filters.assetId?

string

‐

filters.ticker?

string

ticker involved in the transaction

Returns​

Promise<HistoricSettlement[]>

Note​

uses the middlewareV2

Inherited from​

Portfolio.getTransactionHistory

isCustodiedBy()​

isCustodiedBy(args?: object): Promise<boolean>

Defined in: src/api/entities/Portfolio/index.ts:117

Return whether an Identity is the Portfolio custodian

Parameters​

ParameterTypeDescription

args?

{ identity: string | Identity; }

‐

args.identity?

string | Identity

optional, defaults to the signing Identity

Returns​

Promise<boolean>

Inherited from​

Portfolio.isCustodiedBy

isEqual()​

isEqual(entity: Entity<unknown, unknown>): boolean

Defined in: src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters​

ParameterType

entity

Entity<unknown, unknown>

Returns​

boolean

Inherited from​

Portfolio.isEqual

isOwnedBy()​

isOwnedBy(args?: object): Promise<boolean>

Defined in: src/api/entities/Portfolio/index.ts:104

Return whether an Identity is the Portfolio owner

Parameters​

ParameterTypeDescription

args?

{ identity: string | Identity; }

‐

args.identity?

string | Identity

defaults to the signing Identity

Returns​

Promise<boolean>

Inherited from​

Portfolio.isOwnedBy

moveFunds()​

moveFunds(args: MoveFundsParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Portfolio/index.ts:318

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

Parameters​

ParameterType

args

MoveFundsParams

opts?

ProcedureOpts

Returns​

Promise<GenericPolymeshTransaction<void, void>>

Note​

required role:

  • Portfolio Custodian

Note​

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

Inherited from​

Portfolio.moveFunds

quitCustody()​

quitCustody(opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Portfolio/index.ts:326

Returns the custody of the portfolio to the portfolio owner unilaterally

Parameters​

ParameterType

opts?

ProcedureOpts

Returns​

Promise<GenericPolymeshTransaction<void, void>>

Note​

required role:

  • Portfolio Custodian

Note​

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

Inherited from​

Portfolio.quitCustody

toHuman()​

toHuman(): HumanReadable

Defined in: src/api/entities/Portfolio/index.ts:450

Return the Portfolio ID and owner DID

Returns​

HumanReadable

Inherited from​

Portfolio.toHuman

generateUuid()​

static generateUuid<Identifiers>(identifiers: Identifiers): string

Defined in: src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters​

Type Parameter

Identifiers

Parameters​

ParameterTypeDescription

identifiers

Identifiers

Returns​

string

Inherited from​

Portfolio.generateUuid

unserialize()​

static unserialize<Identifiers>(serialized: string): Identifiers

Defined in: src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters​

Type Parameter

Identifiers

Parameters​

ParameterTypeDescription

serialized

string

UUID to unserialize

Returns​

Identifiers

Inherited from​

Portfolio.unserialize