Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • authId
  • Protected context
  • data
  • expiry
  • issuer
  • target
  • uuid
  • Methods
  • accept
  • exists
  • isEqual
  • isExpired
  • remove
  • toJson
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

AuthorizationRequest

PreviousAccountNextAuthorizations

Last updated 3 years ago

Was this helpful?

Represents a request made by an Identity to another Identity (or account) for some sort of authorization. This has multiple uses. For example, if Alice wants to transfer ownership of her asset ALICETOKEN to Bob, an authorization request gets emitted to Bob, who then has to accept it in order for the ownership transfer to be complete

Hierarchy

  • ‹UniqueIdentifiers, ›

    ↳ AuthorizationRequest

Index

Properties

Methods

Properties

authId

• authId: BigNumber

internal identifier for the request (used to accept/reject/cancel)

Protected context

data

authorization request data corresponding to type of authorization

Type
Data

Add Relayer Paying Key

Beneficiary, Relayer, Allowance

Become Agent

Permission Group

Attest Primary Key Rotation

DID

Rotate Primary Key

DID

Transfer Ticker

Ticker

Add MultiSig Signer

Account

Transfer Token Ownership

Ticker

Join Identity

DID

Portfolio Custody

Portfolio

expiry

• expiry: Date | null

date at which the authorization request expires and can no longer be accepted. At this point, a new authorization request must be emitted. Null if the request never expires

issuer

Identity that emitted the request

target

Identity or Account to which the request was emitted

uuid

• uuid: string

Methods

accept

Accept the authorization request. You must be the target of the request to be able to accept it

Parameters:

Name
Type

args

void

opts?

exists

▸ exists(): Promise‹boolean›

Determine whether this Authorization Request exists on chain

Returns: Promise‹boolean›

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

isExpired

â–¸ isExpired(): boolean

Returns whether the Authorization Request has expired

Returns: boolean

remove

Remove the authorization request

  • If you are the request issuer, this will cancel the authorization

  • If you are the request target, this will reject the authorization

Parameters:

Name
Type

args

void

opts?

toJson

Return the Authorization's static data

Static generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

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

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Defined in

• context:

Inherited from .

Defined in

• data:

Defined in

Defined in

• issuer:

Defined in

• target:

Defined in

Inherited from .

Defined in

▸ accept(args: void, opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call accept.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

Overrides .

Defined in

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Defined in

▸ remove(args: void, opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

â–¸ toJson():

Overrides .

Defined in

Returns:

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/AuthorizationRequest.ts:95
Context
src/api/entities/Entity.ts:48
src/api/entities/AuthorizationRequest.ts:84
src/api/entities/AuthorizationRequest.ts:90
Identity
src/api/entities/AuthorizationRequest.ts:67
src/api/entities/AuthorizationRequest.ts:62
src/api/entities/Entity.ts:46
ProcedureOpts
TransactionQueue
src/api/entities/AuthorizationRequest.ts:162
ProcedureMethod
TransactionQueue
src/api/entities/AuthorizationRequest.ts:191
Entity
src/api/entities/Entity.ts:61
src/api/entities/AuthorizationRequest.ts:182
ProcedureOpts
TransactionQueue
src/api/entities/AuthorizationRequest.ts:175
ProcedureMethod
TransactionQueue
HumanReadable
src/api/entities/AuthorizationRequest.ts:208
HumanReadable
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
HumanReadable
authId
context
data
expiry
issuer
target
uuid
accept
exists
isEqual
isExpired
remove
toJson
generateUuid
unserialize
ProcedureOpts
Entity
ProcedureOpts
Entity
Entity
Entity
Entity
Entity
Entity
Entity
context
uuid
exists
isEqual
toJson
generateUuid
unserialize
Authorization
Signer