api.entities.Portfolio.Portfolio - PolymeshAssociation/polymesh-sdk GitHub Wiki
api/entities/Portfolio.Portfolio
Represents a base Portfolio for a specific Identity in the Polymesh blockchain
-
Entity
<UniqueIdentifiers
,HumanReadable
>↳
Portfolio
- exists
- getAssetBalances
- getCollections
- getCustodian
- getTransactionHistory
- isCustodiedBy
- isEqual
- isOwnedBy
- moveFunds
- quitCustody
- setCustodian
- toHuman
- generateUuid
- unserialize
• owner: Identity
Identity of the Portfolio's owner
api/entities/Portfolio/index.ts:83
• uuid: string
▸ Abstract
exists(): Promise
<boolean
>
Determine whether this Entity exists on chain
Promise
<boolean
>
▸ 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
[]>
api/entities/Portfolio/index.ts:149
▸ getCollections(args?
): Promise
<PortfolioCollection
[]>
Retrieve the NFTs held in this portfolio
Name | Type |
---|---|
args? |
Object |
args.collections |
(string | NftCollection )[] |
Promise
<PortfolioCollection
[]>
api/entities/Portfolio/index.ts:228
▸ getCustodian(): Promise
<Identity
>
Retrieve the custodian Identity of this Portfolio
Promise
<Identity
>
Note
if no custodian is set, the owner Identity is returned
api/entities/Portfolio/index.ts:369
▸ 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.ticker? |
string |
ticker involved in the transaction |
Promise
<HistoricSettlement
[]>
Note
uses the middlewareV2
api/entities/Portfolio/index.ts:411
▸ 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
>
api/entities/Portfolio/index.ts:133
▸ isEqual(entity
): boolean
Determine whether this Entity is the same as another one
Name | Type |
---|---|
entity |
Entity <unknown , unknown > |
boolean
▸ 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
>
api/entities/Portfolio/index.ts:120
▸ 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
api/entities/Portfolio/index.ts:347
▸ 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
api/entities/Portfolio/index.ts:360
▸ 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
api/entities/Portfolio/index.ts:334
▸ toHuman(): HumanReadable
Return the Portfolio ID and owner DID
api/entities/Portfolio/index.ts:541
▸ Static
generateUuid<Identifiers
>(identifiers
): string
Generate the Entity's UUID from its identifying properties
Name |
---|
Identifiers |
Name | Type |
---|---|
identifiers |
Identifiers |
string
▸ Static
unserialize<Identifiers
>(serialized
): Identifiers
Unserialize a UUID into its Unique Identifiers
Name |
---|
Identifiers |
Name | Type | Description |
---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers