Class: Portfolio
api/entities/Portfolio.Portfolio
Represents a Portfolio (default or numbered) for a specific Identity on the Polymesh blockchain
Hierarchy
-
Entity
<UniqueIdentifiers
,HumanReadable
>↳
Portfolio
Properties
owner
• owner: Identity
The Identity that owns this Portfolio
Defined in
api/entities/Portfolio/index.ts:69
uuid
• uuid: string
Inherited from
Defined in
Methods
exists
▸ Abstract
exists(): Promise
<boolean
>
Determine whether this Entity exists on chain
Returns
Promise
<boolean
>
Inherited from
Defined in
getAssetBalances
▸ getAssetBalances(args?
): Promise
<PortfolioBalance
[]>
Retrieve the balances of all fungible assets held in this Portfolio
Parameters
Name | Type | Description |
---|---|---|
args? | Object | - |
args.assets | (string | FungibleAsset )[] | Optional array of tickers or FungibleAsset instances to filter the results by. If not provided, all balances are returned |
Returns
Promise
<PortfolioBalance
[]>
An array of PortfolioBalance
objects representing total, locked, and free amounts for each asset
Defined in
api/entities/Portfolio/index.ts:133
getCollections
▸ getCollections(args?
): Promise
<PortfolioCollection
[]>
Retrieve all NFT holdings in this Portfolio
Parameters
Name | Type | Description |
---|---|---|
args? | Object | - |
args.collections | (string | NftCollection )[] | Optional array of tickers, asset IDs, or NftCollection instances to filter by. If not provided, returns all holdings |
Returns
Promise
<PortfolioCollection
[]>
An array of PortfolioCollection
objects, including held, locked, and free NFTs per collection
Defined in
api/entities/Portfolio/index.ts:214
getCustodian
▸ getCustodian(): Promise
<Identity
>
Retrieve the current custodian of this Portfolio's identity
Returns
Promise
<Identity
>
Note
If no custodian is explicitly assigned, the Portfolio owner is returned
Defined in
api/entities/Portfolio/index.ts:345
getTransactionHistory
▸ getTransactionHistory(filters?
): Promise
<HistoricSettlement
[]>
Retrieve the transaction history of this Portfolio, optionally filtered by account, ticker, or assetId
Parameters
Name | Type | Description |
---|---|---|
filters | Object | - |
filters.account? | string | (optional) Account address to filter transactions by |
filters.assetId? | string | (optional) Asset ID to filter by. Overrides ticker if both are present |
filters.ticker? | string | (optional) Asset ticker involved in the transaction |
Returns
Promise
<HistoricSettlement
[]>
Note
Uses the middlewareV2 GraphQL API
Defined in
api/entities/Portfolio/index.ts:388
isCustodiedBy
▸ isCustodiedBy(args?
): Promise
<boolean
>
Check whether a given Identity is the custodian of this Portfolio
Parameters
Name | Type | Description |
---|---|---|
args? | Object | - |
args.identity | string | Identity | Identity or DID string to compare. Defaults to the signing Identity |
Returns
Promise
<boolean
>
Defined in
api/entities/Portfolio/index.ts:115
isEqual
▸ isEqual(entity
): boolean
Determine whether this Entity is the same as another one
Parameters
Name | Type |
---|---|
entity | Entity <unknown , unknown > |
Returns
boolean
Inherited from
Defined in
isOwnedBy
▸ isOwnedBy(args?
): Promise
<boolean
>
Check whether a given Identity is the owner of this Portfolio
Parameters
Name | Type | Description |
---|---|---|
args? | Object | - |
args.identity | string | Identity | Identity or DID string to compare. Defaults to the signing Identity |
Returns
Promise
<boolean
>
Defined in
api/entities/Portfolio/index.ts:102
moveFunds
▸ moveFunds(args
, opts?
): Promise
<GenericPolymeshTransaction
<void
, void
>>
Move funds from this Portfolio to another Portfolio owned by the same Identity
Parameters
Name | Type |
---|---|
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
Defined in
api/entities/Portfolio/index.ts:323
quitCustody
▸ quitCustody(opts?
): Promise
<GenericPolymeshTransaction
<void
, void
>>
Unilaterally return custody of the Portfolio to its owner
Parameters
Name | Type |
---|---|
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
Defined in
api/entities/Portfolio/index.ts:336
toHuman
▸ toHuman(): HumanReadable
Convert this Portfolio's identifiers to a human-readable format
Returns
An object containing the owner DID and (if applicable) the Portfolio ID as strings
Overrides
Defined in
api/entities/Portfolio/index.ts:465
generateUuid
▸ Static
generateUuid<Identifiers
>(identifiers
): string
Generate the Entity's UUID from its identifying properties
Type parameters
Name |
---|
Identifiers |
Parameters
Name | Type |
---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static
unserialize<Identifiers
>(serialized
): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Name |
---|
Identifiers |
Parameters
Name | Type | Description |
---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers