Polymesh SDK API Reference
v3.0.0
v3.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Claims
    • Compliance
    • Context
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • SecurityToken
    • Settlements
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • VenueType
  • Interfaces
    • AccountBalance
    • AccountData
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • CddProviderRole
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • MiddlewareConfig
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RegisterIdentityParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCustodianParams
    • SetTokenDocumentsParams
    • SimpleEnumTransactionArgument
    • TickerOwnerRole
    • TickerReservationDetails
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenHolderOptions
    • TokenHolderProperties
    • TokenIdentifier
    • TokenOwnerRole
    • TransferPolyXParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected Optional _id
  • Protected context
  • owner
  • uuid
  • Methods
  • getCustodian
  • getTokenBalances
  • isCustodiedBy
  • isOwnedBy
  • moveFunds
  • setCustodian
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

DefaultPortfolio

PreviousCurrentIdentityNextDefaultTrustedClaimIssuer

Last updated 4 years ago

Was this helpful?

Represents the default Portfolio for an Identity

Hierarchy

↳

↳ DefaultPortfolio

Index

Properties

Methods

Properties

Protected Optional _id

• _id? : BigNumber

internal Portfolio identifier (unused for default Portfolio)

Protected context

owner

identity of the Portfolio's owner

uuid

• uuid: string

Methods

getCustodian

Retrieve the custodian Identity of this Portfolio

note if no custodian is set, the owner Identity is returned

getTokenBalances

Retrieve the balances of all assets in this Portfolio

Parameters:

Name

Type

args?

undefined | object

isCustodiedBy

▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›

Return whether an Identity is the Portfolio custodian

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹boolean›

isOwnedBy

▸ isOwnedBy(args?: undefined | object): Promise‹boolean›

Return whether an Identity is the Portfolio owner

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹boolean›

moveFunds

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

Parameters:

Name

Type

args

setCustodian

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

note this may create an AuthorizationRequest which has to be accepted by the corresponding Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

Parameters:

Name

Type

args

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers: object

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Inherited from .

Defined in

• context:

Inherited from .

Defined in

• owner:

Inherited from .

Defined in

Inherited from .

Defined in

▸ getCustodian(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

▸ getTokenBalances(args?: undefined | object): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

Inherited from .

Defined in

Inherited from .

Defined in

▸ moveFunds(args: ): Promise‹‹void››

Inherited from .

Defined in

Returns: Promise‹‹void››

▸ setCustodian(args: ): Promise‹‹void››

Inherited from .

Defined in

Returns: Promise‹‹void››

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Portfolio/index.ts:53
Context
src/api/entities/Entity.ts:48
Identity
src/api/entities/Portfolio/index.ts:48
src/api/entities/Entity.ts:46
Identity
src/api/entities/Portfolio/index.ts:199
Identity
PortfolioBalance
src/api/entities/Portfolio/index.ts:104
PortfolioBalance
src/api/entities/Portfolio/index.ts:88
src/api/entities/Portfolio/index.ts:72
MoveFundsParams
TransactionQueue
src/api/entities/Portfolio/index.ts:190
TransactionQueue
SetCustodianParams
TransactionQueue
src/api/entities/Portfolio/index.ts:174
TransactionQueue
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Portfolio
_id
context
owner
uuid
getCustodian
getTokenBalances
isCustodiedBy
isOwnedBy
moveFunds
setCustodian
generateUuid
unserialize
MoveFundsParams
SetCustodianParams
Portfolio
Entity
Portfolio
Entity
Portfolio
Portfolio
Portfolio
Portfolio
Portfolio
Portfolio
Entity
Entity
_id
owner
getCustodian
getTokenBalances
isCustodiedBy
isOwnedBy
moveFunds
setCustodian
context
uuid
generateUuid
unserialize