api/entities/NumberedPortfolio.NumberedPortfolio

Represents a numbered (non-default) Portfolio for an Identity

• Portfolio

  ↳ NumberedPortfolio

• id
• owner
• uuid

• createdAt
• exists
• getAssetBalances
• getCollections
• getCustodian
• getName
• getTransactionHistory
• isCustodiedBy
• isEqual
• isOwnedBy
• modifyName
• moveFunds
• quitCustody
• setCustodian
• toHuman
• generateUuid
• unserialize

• id: BigNumber

Portfolio identifier number

api/entities/NumberedPortfolio.ts:39

---

• owner: Identity

Identity of the Portfolio's owner

Portfolio.owner

api/entities/Portfolio/index.ts:77

---

• uuid: string

Portfolio.uuid

api/entities/Entity.ts:46

▸ createdAt(): Promise<null | EventIdentifier>

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

Promise<null | EventIdentifier>

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

api/entities/NumberedPortfolio.ts:101

---

▸ exists(): Promise<boolean>

Return whether this Portfolio exists

Promise<boolean>

Portfolio.exists

api/entities/NumberedPortfolio.ts:127

---

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

Retrieve the balances of all fungible assets in this Portfolio

Name	Type	Description
args?	Object	-
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

api/entities/Portfolio/index.ts:143

---

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

Retrieve the NFTs held in this portfolio

Name	Type
args?	Object
args.collections	(string | NftCollection)[]

Promise<PortfolioCollection[]>

Portfolio.getCollections

api/entities/Portfolio/index.ts:222

---

▸ getCustodian(): Promise<Identity>

Retrieve the custodian Identity of this Portfolio

Promise<Identity>

Note

if no custodian is set, the owner Identity is returned

Portfolio.getCustodian

api/entities/Portfolio/index.ts:370

---

▸ getName(): Promise<string>

Return the Portfolio name

Promise<string>

api/entities/NumberedPortfolio.ts:72

---

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

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

Name	Type	Description
filters	Object	-
filters.account?	string	Account involved in the settlement
filters.assetId?	string	-
filters.ticker?	string	ticker involved in the transaction

Promise<HistoricSettlement[]>

Note

uses the middlewareV2

Portfolio.getTransactionHistory

api/entities/Portfolio/index.ts:412

---

▸ isCustodiedBy(args?): Promise<boolean>

Return whether an Identity is the Portfolio custodian

Name	Type	Description
args?	Object	-
args.identity	string | Identity	optional, defaults to the signing Identity

Promise<boolean>

Portfolio.isCustodiedBy

api/entities/Portfolio/index.ts:127

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Portfolio.isEqual

api/entities/Entity.ts:61

---

▸ isOwnedBy(args?): Promise<boolean>

Return whether an Identity is the Portfolio owner

Name	Type	Description
args?	Object	-
args.identity	string | Identity	defaults to the signing Identity

Promise<boolean>

Portfolio.isOwnedBy

api/entities/Portfolio/index.ts:114

---

▸ modifyName(args, opts?): Promise<GenericPolymeshTransaction<NumberedPortfolio, NumberedPortfolio>>

Rename portfolio

Name	Type
args	RenamePortfolioParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<NumberedPortfolio, NumberedPortfolio>>

Note

Only the owner is allowed to rename the Portfolio.

Note

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

api/entities/NumberedPortfolio.ts:65

---

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

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

Name	Type
args	MoveFundsParams
opts?	ProcedureOpts

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

Portfolio.moveFunds

api/entities/Portfolio/index.ts:348

---

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

Returns the custody of the portfolio to the portfolio owner unilaterally

Name	Type
opts?	ProcedureOpts

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

Portfolio.quitCustody

api/entities/Portfolio/index.ts:361

---

▸ setCustodian(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

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

Name	Type
args	SetCustodianParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Note

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

Note

required role:

• Portfolio Custodian

Note

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

Portfolio.setCustodian

api/entities/Portfolio/index.ts:335

---

▸ toHuman(): HumanReadable

Return the Portfolio ID and owner DID

HumanReadable

Portfolio.toHuman

api/entities/Portfolio/index.ts:487

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Portfolio.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Portfolio.unserialize

api/entities/Entity.ts:23