@polymeshassociation/polymesh-sdk / api/entities/DefaultPortfolio

Defined in: api/entities/DefaultPortfolio.ts:10

Represents the default Portfolio for an Identity

• Portfolio

owner: Identity

Defined in: api/entities/Portfolio/index.ts:90

Identity of the Portfolio's owner

Portfolio.owner

uuid: string

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

Portfolio.uuid

exists(): Promise<boolean>

Defined in: api/entities/DefaultPortfolio.ts:21

Determine whether this Portfolio exists on chain

Promise<boolean>

Portfolio.exists

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

Defined in: api/entities/Portfolio/index.ts:231

Retrieve the balances of all fungible assets in this Portfolio

Parameter	Type	Description
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)

Promise<PortfolioBalance[]>

Portfolio.getAssetBalances

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

Defined in: api/entities/Portfolio/index.ts:310

Retrieve the NFTs held in this portfolio

Parameter	Type	Description
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)

Promise<PortfolioCollection[]>

Portfolio.getCollections

getCustodian(): Promise<Identity>

Defined in: api/entities/Portfolio/index.ts:427

Retrieve the custodian Identity of this Portfolio

Promise<Identity>

if no custodian is set, the owner Identity is returned

Portfolio.getCustodian

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

Defined in: api/entities/Portfolio/index.ts:469

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

Parameter	Type	Description
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

Promise<HistoricSettlement[]>

uses the middlewareV2

Portfolio.getTransactionHistory

isAssetPreApproved(asset): Promise<boolean>

Defined in: api/entities/Portfolio/index.ts:168

Returns whether or not this Portfolio has pre-approved a particular asset

Parameter	Type
asset	string | BaseAsset

Promise<boolean>

Portfolio.isAssetPreApproved

isCustodiedBy(args?): Promise<boolean>

Defined in: api/entities/Portfolio/index.ts:154

Return whether an Identity is the Portfolio custodian

Parameter	Type	Description
args?	{ identity: string | Identity; }	-
args.identity?	string | Identity	optional, defaults to the signing Identity

Promise<boolean>

Portfolio.isCustodiedBy

isEqual(entity): boolean

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

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

Portfolio.isEqual

isOwnedBy(args?): Promise<boolean>

Defined in: api/entities/Portfolio/index.ts:141

Return whether an Identity is the Portfolio owner

Parameter	Type	Description
args?	{ identity: string | Identity; }	-
args.identity?	string | Identity	defaults to the signing Identity

Promise<boolean>

Portfolio.isOwnedBy

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

Defined in: api/entities/Portfolio/index.ts:402

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

Parameter	Type
args	MoveFundsParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

required role:

• Portfolio Custodian

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

Portfolio.moveFunds

preApproveAsset(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Portfolio/index.ts:415

Pre-approves receiving an asset for this Portfolio. Receiving this asset in a settlement will not require manual affirmation

Parameter	Type
args	{ asset: string | BaseAsset; }
args.asset	string | BaseAsset
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

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

Portfolio.preApproveAsset

preApprovedAssets(paginationOpts?): Promise<ResultSet<Asset>>

Defined in: api/entities/Portfolio/index.ts:193

Returns a list of all assets this Portfolio has pre-approved. These assets will not require affirmation when being received in settlements

Parameter	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<Asset>>

Portfolio.preApprovedAssets

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

Defined in: api/entities/Portfolio/index.ts:410

Returns the custody of the portfolio to the portfolio owner unilaterally

Parameter	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

required role:

• Portfolio Custodian

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

Portfolio.quitCustody

removeAssetPreApproval(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Portfolio/index.ts:420

Removes pre-approval of an asset for this Portfolio

Parameter	Type
args	{ asset: string | BaseAsset; }
args.asset	string | BaseAsset
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

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

Portfolio.removeAssetPreApproval

toHuman(): HumanReadable

Defined in: api/entities/Portfolio/index.ts:544

Return the Portfolio ID and owner DID

HumanReadable

Portfolio.toHuman

static generateUuid<Identifiers>(identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

Portfolio.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

Portfolio.unserialize

Defined in: api/entities/DefaultPortfolio.ts:3

did: string

Defined in: api/entities/DefaultPortfolio.ts:4