Reference / Modules / client / AuthenticatedLocClient

Class: AuthenticatedLocClient

client.AuthenticatedLocClient

Hierarchy

• LocClient

  ↳ AuthenticatedLocClient

Table of contents

Constructors

• constructor

Properties

• axiosFactory
• componentFactory
• config
• currentAccount
• legalOfficer
• nodeApi

Methods

• acceptCollectionLoc
• acceptIdentityLoc
• acceptIdentityLocSubmittable
• acceptLoc
• acceptTransactionLoc
• acceptTransactionLocSubmittable
• acknowledgeFile
• acknowledgeFileSubmittable
• acknowledgeLink
• acknowledgeLinkSubmittable
• acknowledgeMetadata
• acknowledgeMetadataSubmittable
• addCollectionItem
• addCollectionItemSubmittable
• addCollectionItems
• addFile
• addLink
• addMetadata
• addTokensRecord
• addTokensRecordSubmittable
• addTokensRecords
• backend
• canAddRecord
• cancel
• cancelItemPublicDataSubmission
• cancelOpenLoc
• cancelPreAcknowledgeFile
• cancelPreAcknowledgeLink
• cancelPreAcknowledgeMetadata
• cancelPreClose
• cancelPrePublishFile
• cancelPrePublishLink
• cancelPrePublishMetadata
• cancelPreVoid
• cancelRecordPublicDataSubmission
• checkDelivery
• checkTokensRecordDelivery
• close
• createLocRequest
• createOpenLoc
• createSofRequest
• deleteFile
• deleteLink
• deleteMetadata
• dismissIssuer
• ensureEnoughFunds
• estimateFeesAcceptIdentityLoc
• estimateFeesAcceptTransactionLoc
• estimateFeesAcknowledgeFile
• estimateFeesAcknowledgeLink
• estimateFeesAcknowledgeMetadata
• estimateFeesAddCollectionItem
• estimateFeesAddTokensRecord
• estimateFeesOpenCollectionLoc
• estimateFeesOpenIdentityLoc
• estimateFeesOpenLogionIdentityLoc
• estimateFeesOpenLogionTransactionLoc
• estimateFeesOpenTransactionLoc
• estimateFeesPublishFile
• estimateFeesPublishLink
• estimateFeesPublishMetadata
• estimateFeesSetInvitedContributor
• getCollectionItem
• getCollectionItems
• getCollectionSize
• getDeliveries
• getInvitedContributors
• getLegalOfficerVerifiedIssuers
• getLoc
• getLocIssuers
• getLocRequest
• getTokensRecord
• getTokensRecordDeliveries
• getTokensRecords
• isInvitedContributorOf
• isIssuerOf
• nominateIssuer
• openCollectionLoc
• openCollectionLocSubmittable
• openIdentityLoc
• openIdentityLocSubmittable
• openLoc
• openLogionIdentityLoc
• openLogionIdentityLocSubmittable
• openLogionTransactionLoc
• openLogionTransactionLocSubmittable
• openTransactionLoc
• openTransactionLocSubmittable
• preAcknowledgeFile
• preAcknowledgeLink
• preAcknowledgeMetadata
• preClose
• prePublishFile
• prePublishLink
• prePublishMetadata
• preVoid
• publishFile
• publishFileSubmittable
• publishLink
• publishLinkSubmittable
• publishMetadata
• publishMetadataSubmittable
• rejectLoc
• requestFileReview
• requestLinkReview
• requestMetadataReview
• requestVote
• reviewFile
• reviewLink
• reviewMetadata
• rework
• setCollectionFileRestrictedDelivery
• setInvitedContributor
• setInvitedContributorSubmittable
• setIssuerSelection
• storageSize
• submit
• submitItemPublicData
• submitRecordPublicData
• termsAndConditions
• toFileParams
• toLinkParams
• toMetadataItemParams
• uploadItemFile
• uploadTokensRecordFile
• validTokenOrThrow
• voidLoc

Constructors

constructor

• new AuthenticatedLocClient(params): AuthenticatedLocClient

Parameters

Name	Type
params	Object
params.axiosFactory	AxiosFactory
params.componentFactory	ComponentFactory
params.config	LogionClientConfig
params.currentAccount	ValidAccountId
params.legalOfficer	LegalOfficerClass
params.nodeApi	LogionNodeApiClass

Returns

AuthenticatedLocClient

Overrides

LocClient.constructor

Defined in

packages/client/src/LocClient.ts:769

Properties

axiosFactory

• Protected Readonly axiosFactory: AxiosFactory

Inherited from

LocClient.axiosFactory

Defined in

packages/client/src/LocClient.ts:557

---

componentFactory

• Private Readonly componentFactory: ComponentFactory

Defined in

packages/client/src/LocClient.ts:788

---

config

• Private Readonly config: LogionClientConfig

Defined in

packages/client/src/LocClient.ts:789

---

currentAccount

• Readonly currentAccount: ValidAccountId

Defined in

packages/client/src/LocClient.ts:787

---

legalOfficer

• Protected Readonly legalOfficer: LegalOfficerClass

Inherited from

LocClient.legalOfficer

Defined in

packages/client/src/LocClient.ts:559

---

nodeApi

• Protected Readonly nodeApi: LogionNodeApiClass

Inherited from

LocClient.nodeApi

Defined in

packages/client/src/LocClient.ts:558

Methods

acceptCollectionLoc

▸ acceptCollectionLoc(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2163

---

acceptIdentityLoc

▸ acceptIdentityLoc(parameters): Promise<void>

Parameters

Name	Type
parameters	AcceptIdentityLocParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2011

---

acceptIdentityLocSubmittable

▸ acceptIdentityLocSubmittable(parameters): undefined | SubmittableExtrinsic

Parameters

Name	Type
parameters	EstimateFeesIdentityTransactionLocParams

Returns

undefined | SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:2025

---

acceptLoc

▸ acceptLoc(args): Promise<void>

Parameters

Name	Type
args	Object
args.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1982

---

acceptTransactionLoc

▸ acceptTransactionLoc(parameters): Promise<void>

Parameters

Name	Type
parameters	AcceptTransactionLocParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1857

---

acceptTransactionLocSubmittable

▸ acceptTransactionLocSubmittable(parameters): undefined | SubmittableExtrinsic

Parameters

Name	Type
parameters	EstimateFeesAcceptTransactionLocParams

Returns

undefined | SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1871

---

acknowledgeFile

▸ acknowledgeFile(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1558

---

acknowledgeFileSubmittable

▸ acknowledgeFileSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	{ locId: UUID } & RefFileParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1599

---

acknowledgeLink

▸ acknowledgeLink(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1797

---

acknowledgeLinkSubmittable

▸ acknowledgeLinkSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	{ locId: UUID } & RefLinkParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1838

---

acknowledgeMetadata

▸ acknowledgeMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckMetadataParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1682

---

acknowledgeMetadataSubmittable

▸ acknowledgeMetadataSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	{ locId: UUID } & RefMetadataParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1723

---

addCollectionItem

▸ addCollectionItem(parameters): Promise<void>

Parameters

Name	Type
parameters	BlockchainSubmission<AddCollectionItemParams & FetchParameters>

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:908

---

addCollectionItemSubmittable

▸ addCollectionItemSubmittable(parameters): Promise<SubmittableExtrinsic>

Parameters

Name	Type
parameters	AddCollectionItemParams & FetchParameters & { termsAndConditions: TermsAndConditionsElement[] }

Returns

Promise<SubmittableExtrinsic>

Defined in

packages/client/src/LocClient.ts:1062

---

addCollectionItems

▸ addCollectionItems(parameters): Promise<void>

Parameters

Name	Type
parameters	BlockchainBatchSubmission<AddCollectionItemParams & FetchParameters>

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:917

---

addFile

▸ addFile(parameters): Promise<void>

Parameters

Name	Type
parameters	AddFileParams & FetchParameters & { direct: boolean }

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:846

---

addLink

▸ addLink(parameters): Promise<void>

Parameters

Name	Type
parameters	AddLinkParams & FetchParameters

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:890

---

addMetadata

▸ addMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	AddMetadataParams & FetchParameters

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:828

---

addTokensRecord

▸ addTokensRecord(parameters): Promise<void>

Parameters

Name	Type
parameters	BlockchainSubmission<AddTokensRecordParams & FetchParameters>

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1347

---

addTokensRecordSubmittable

▸ addTokensRecordSubmittable(parameters): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>

Parameters

Name	Type
parameters	AddTokensRecordParams & FetchParameters

Returns

Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>

Defined in

packages/client/src/LocClient.ts:1389

---

addTokensRecords

▸ addTokensRecords(parameters): Promise<void>

Parameters

Name	Type
parameters	BlockchainBatchSubmission<AddTokensRecordParams & FetchParameters>

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:986

---

backend

▸ backend(): AxiosInstance

Returns

AxiosInstance

Inherited from

LocClient.backend

Defined in

packages/client/src/LocClient.ts:565

---

canAddRecord

▸ canAddRecord(request): Promise<boolean>

Parameters

Name	Type
request	LocRequest

Returns

Promise<boolean>

Defined in

packages/client/src/LocClient.ts:1294

---

cancel

▸ cancel(locId): Promise<void>

Parameters

Name	Type
locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1216

---

cancelItemPublicDataSubmission

▸ cancelItemPublicDataSubmission(locId, itemId): Promise<void>

Parameters

Name	Type
locId	UUID
itemId	Hash

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1143

---

cancelOpenLoc

▸ cancelOpenLoc(args): Promise<void>

Parameters

Name	Type
args	Object
args.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2002

---

cancelPreAcknowledgeFile

▸ cancelPreAcknowledgeFile(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1584

---

cancelPreAcknowledgeLink

▸ cancelPreAcknowledgeLink(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1823

---

cancelPreAcknowledgeMetadata

▸ cancelPreAcknowledgeMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckMetadataParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1708

---

cancelPreClose

▸ cancelPreClose(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.autoAck	boolean
parameters.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2263

---

cancelPrePublishFile

▸ cancelPrePublishFile(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1531

---

cancelPrePublishLink

▸ cancelPrePublishLink(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1775

---

cancelPrePublishMetadata

▸ cancelPrePublishMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.nameHash	Hash

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1654

---

cancelPreVoid

▸ cancelPreVoid(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2317

---

cancelRecordPublicDataSubmission

▸ cancelRecordPublicDataSubmission(locId, recordId): Promise<void>

Parameters

Name	Type
locId	UUID
recordId	Hash

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1429

---

checkDelivery

▸ checkDelivery(parameters): Promise<CollectionDelivery>

Parameters

Name	Type
parameters	CheckCollectionDeliveryRequest

Returns

Promise<CollectionDelivery>

Overrides

LocClient.checkDelivery

Defined in

packages/client/src/LocClient.ts:1198

---

checkTokensRecordDelivery

▸ checkTokensRecordDelivery(parameters): Promise<CollectionDelivery>

Parameters

Name	Type
parameters	CheckTokensRecordDeliveryRequest

Returns

Promise<CollectionDelivery>

Overrides

LocClient.checkTokensRecordDelivery

Defined in

packages/client/src/LocClient.ts:1482

---

close

▸ close(parameters): Promise<void>

Parameters

Name	Type
parameters	{ autoAck: boolean ; locId: UUID ; seal?: string } & BlockchainSubmissionParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2226

---

createLocRequest

▸ createLocRequest(request): Promise<LocRequest>

Parameters

Name	Type
request	CreateLocRequest

Returns

Promise<LocRequest>

Defined in

packages/client/src/LocClient.ts:791

---

createOpenLoc

▸ createOpenLoc(request): Promise<LocRequest>

Parameters

Name	Type
request	CreateOpenLoc

Returns

Promise<LocRequest>

Defined in

packages/client/src/LocClient.ts:800

---

createSofRequest

▸ createSofRequest(request): Promise<LocRequest>

Parameters

Name	Type
request	CreateSofRequest & FetchParameters

Returns

Promise<LocRequest>

Defined in

packages/client/src/LocClient.ts:809

---

deleteFile

▸ deleteFile(parameters): Promise<void>

Parameters

Name	Type
parameters	RefFileParams & FetchParameters

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:881

---

deleteLink

▸ deleteLink(parameters): Promise<void>

Parameters

Name	Type
parameters	RefLinkParams & FetchParameters

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:899

---

deleteMetadata

▸ deleteMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	RefMetadataParams & FetchParameters

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:837

---

dismissIssuer

▸ dismissIssuer(parameters): Promise<void>

Parameters

Name	Type
parameters	{ requester: string } & BlockchainSubmissionParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2338

---

ensureEnoughFunds

▸ ensureEnoughFunds(fees): Promise<void>

Parameters

Name	Type
fees	Fees

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1539

---

estimateFeesAcceptIdentityLoc

▸ estimateFeesAcceptIdentityLoc(parameters): Promise<undefined | Fees>

Parameters

Name	Type
parameters	EstimateFeesIdentityTransactionLocParams

Returns

Promise<undefined | Fees>

Defined in

packages/client/src/LocClient.ts:2049

---

estimateFeesAcceptTransactionLoc

▸ estimateFeesAcceptTransactionLoc(parameters): Promise<undefined | Fees>

Parameters

Name	Type
parameters	EstimateFeesAcceptTransactionLocParams

Returns

Promise<undefined | Fees>

Defined in

packages/client/src/LocClient.ts:1885

---

estimateFeesAcknowledgeFile

▸ estimateFeesAcknowledgeFile(parameters): Promise<Fees>

Parameters

Name	Type
parameters	{ locId: UUID } & RefFileParams

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1592

---

estimateFeesAcknowledgeLink

▸ estimateFeesAcknowledgeLink(parameters): Promise<Fees>

Parameters

Name	Type
parameters	{ locId: UUID } & RefLinkParams

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1831

---

estimateFeesAcknowledgeMetadata

▸ estimateFeesAcknowledgeMetadata(parameters): Promise<Fees>

Parameters

Name	Type
parameters	{ locId: UUID } & RefMetadataParams

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1716

---

estimateFeesAddCollectionItem

▸ estimateFeesAddCollectionItem(parameters): Promise<Fees>

Parameters

Name	Type
parameters	AddCollectionItemParams & FetchParameters & { collectionItemFee: Lgnt }

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1112

---

estimateFeesAddTokensRecord

▸ estimateFeesAddTokensRecord(parameters): Promise<Fees>

Parameters

Name	Type
parameters	AddTokensRecordParams & FetchParameters & { tokensRecordFee: Lgnt }

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1437

---

estimateFeesOpenCollectionLoc

▸ estimateFeesOpenCollectionLoc(parameters): Promise<Fees>

Parameters

Name	Type
parameters	{ valueFee: Lgnt } & OpenPolkadotLocParams & OpenCollectionLocParams & AutoPublish

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:2214

---

estimateFeesOpenIdentityLoc

▸ estimateFeesOpenIdentityLoc(parameters): Promise<Fees>

Parameters

Name	Type
parameters	OpenPolkadotLocParams & AutoPublish

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:2127

---

estimateFeesOpenLogionIdentityLoc

▸ estimateFeesOpenLogionIdentityLoc(parameters): Promise<Fees>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:2154

---

estimateFeesOpenLogionTransactionLoc

▸ estimateFeesOpenLogionTransactionLoc(parameters): Promise<Fees>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.requesterLocId	UUID

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1973

---

estimateFeesOpenTransactionLoc

▸ estimateFeesOpenTransactionLoc(parameters): Promise<Fees>

Parameters

Name	Type
parameters	OpenPolkadotLocParams & AutoPublish

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1945

---

estimateFeesPublishFile

▸ estimateFeesPublishFile(parameters): Promise<Fees>

Parameters

Name	Type
parameters	EstimateFeesPublishFileParams

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1543

---

estimateFeesPublishLink

▸ estimateFeesPublishLink(parameters): Promise<Fees>

Parameters

Name	Type
parameters	EstimateFeesPublishLinkParams

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1790

---

estimateFeesPublishMetadata

▸ estimateFeesPublishMetadata(parameters): Promise<Fees>

Parameters

Name	Type
parameters	EstimateFeesPublishMetadataParams

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1662

---

estimateFeesSetInvitedContributor

▸ estimateFeesSetInvitedContributor(params): Promise<Fees>

Parameters

Name	Type
params	SetInvitedContributorSelectionParams & FetchParameters

Returns

Promise<Fees>

Defined in

packages/client/src/LocClient.ts:1332

---

getCollectionItem

▸ getCollectionItem(parameters): Promise<undefined | UploadableCollectionItem>

Parameters

Name	Type
parameters	{ itemId: Hash } & FetchParameters

Returns

Promise<undefined | UploadableCollectionItem>

Inherited from

LocClient.getCollectionItem

Defined in

packages/client/src/LocClient.ts:569

---

getCollectionItems

▸ getCollectionItems(parameters): Promise<UploadableCollectionItem[]>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<UploadableCollectionItem[]>

Inherited from

LocClient.getCollectionItems

Defined in

packages/client/src/LocClient.ts:611

---

getCollectionSize

▸ getCollectionSize(parameters): Promise<undefined | number>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<undefined | number>

Inherited from

LocClient.getCollectionSize

Defined in

packages/client/src/LocClient.ts:635

---

getDeliveries

▸ getDeliveries(parameters): Promise<ItemDeliveries>

Parameters

Name	Type
parameters	GetDeliveriesRequest

Returns

Promise<ItemDeliveries>

Overrides

LocClient.getDeliveries

Defined in

packages/client/src/LocClient.ts:1188

---

getInvitedContributors

▸ getInvitedContributors(request): Promise<ValidAccountId[]>

Parameters

Name	Type
request	LocRequest

Returns

Promise<ValidAccountId[]>

Defined in

packages/client/src/LocClient.ts:1309

---

getLegalOfficerVerifiedIssuers

▸ getLegalOfficerVerifiedIssuers(): Promise<BackendVerifiedIssuerIdentity[]>

Returns

Promise<BackendVerifiedIssuerIdentity[]>

Defined in

packages/client/src/LocClient.ts:2349

---

getLoc

▸ getLoc(parameters): Promise<LegalOfficerCase>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<LegalOfficerCase>

Inherited from

LocClient.getLoc

Defined in

packages/client/src/LocClient.ts:561

---

getLocIssuers

▸ getLocIssuers(request, locBatch): Promise<LocVerifiedIssuers>

Parameters

Name	Type
request	LocRequest
locBatch	LocBatch

Returns

Promise<LocVerifiedIssuers>

Defined in

packages/client/src/LocClient.ts:1232

---

getLocRequest

▸ getLocRequest(parameters): Promise<LocRequest>

Parameters

Name	Type
parameters	FetchParameters

Returns

Promise<LocRequest>

Overrides

LocClient.getLocRequest

Defined in

packages/client/src/LocClient.ts:818

---

getTokensRecord

▸ getTokensRecord(parameters): Promise<undefined | ClientTokensRecord>

Parameters

Name	Type
parameters	{ recordId: Hash } & FetchParameters

Returns

Promise<undefined | ClientTokensRecord>

Inherited from

LocClient.getTokensRecord

Defined in

packages/client/src/LocClient.ts:640

---

getTokensRecordDeliveries

▸ getTokensRecordDeliveries(parameters): Promise<ItemDeliveries>

Parameters

Name	Type
parameters	GetTokensRecordDeliveriesRequest

Returns

Promise<ItemDeliveries>

Overrides

LocClient.getTokensRecordDeliveries

Defined in

packages/client/src/LocClient.ts:1478

---

getTokensRecords

▸ getTokensRecords(parameters): Promise<ClientTokensRecord[]>

Parameters

Name	Type
parameters	GetTokensRecordsRequest

Returns

Promise<ClientTokensRecord[]>

Inherited from

LocClient.getTokensRecords

Defined in

packages/client/src/LocClient.ts:679

---

isInvitedContributorOf

▸ isInvitedContributorOf(locId): Promise<boolean>

Parameters

Name	Type
locId	UUID

Returns

Promise<boolean>

Defined in

packages/client/src/LocClient.ts:1305

---

isIssuerOf

▸ isIssuerOf(request): Promise<boolean>

Parameters

Name	Type
request	LocRequest

Returns

Promise<boolean>

Defined in

packages/client/src/LocClient.ts:1300

---

nominateIssuer

▸ nominateIssuer(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID ; requester: string } & BlockchainSubmissionParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2326

---

openCollectionLoc

▸ openCollectionLoc(parameters, requirePreOpen?): Promise<void>

Parameters

Name	Type	Default value
parameters	BlockchainSubmission<OpenPolkadotLocParams & OpenCollectionLocParams & AutoPublish>	undefined
requirePreOpen	boolean	true

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2167

---

openCollectionLocSubmittable

▸ openCollectionLocSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	OpenPolkadotLocParams & OpenCollectionLocParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:2190

---

openIdentityLoc

▸ openIdentityLoc(parameters, requirePreOpen?): Promise<void>

Parameters

Name	Type	Default value
parameters	BlockchainSubmission<OpenPolkadotLocParams & AutoPublish>	undefined
requirePreOpen	boolean	true

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2062

---

openIdentityLocSubmittable

▸ openIdentityLocSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	OpenPolkadotLocParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:2085

---

openLoc

▸ openLoc(args): Promise<void>

Parameters

Name	Type
args	{ locId: UUID } & AutoPublish

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1991

---

openLogionIdentityLoc

▸ openLogionIdentityLoc(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & BlockchainSubmissionParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2138

---

openLogionIdentityLocSubmittable

▸ openLogionIdentityLocSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	Object
parameters.locId	UUID

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:2147

---

openLogionTransactionLoc

▸ openLogionTransactionLoc(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID ; requesterLocId: UUID } & BlockchainSubmissionParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1956

---

openLogionTransactionLocSubmittable

▸ openLogionTransactionLocSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.requesterLocId	UUID

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1965

---

openTransactionLoc

▸ openTransactionLoc(parameters, requirePreOpen?): Promise<void>

Parameters

Name	Type	Default value
parameters	BlockchainSubmission<OpenPolkadotLocParams & AutoPublish>	undefined
requirePreOpen	boolean	true

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1898

---

openTransactionLocSubmittable

▸ openTransactionLocSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	OpenPolkadotLocParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1928

---

preAcknowledgeFile

▸ preAcknowledgeFile(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1576

---

preAcknowledgeLink

▸ preAcknowledgeLink(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1815

---

preAcknowledgeMetadata

▸ preAcknowledgeMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & AckMetadataParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1700

---

preClose

▸ preClose(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.autoAck	boolean
parameters.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2255

---

prePublishFile

▸ prePublishFile(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1523

---

prePublishLink

▸ prePublishLink(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1767

---

prePublishMetadata

▸ prePublishMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.nameHash	Hash

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1646

---

preVoid

▸ preVoid(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.reason	string

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2306

---

publishFile

▸ publishFile(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1505

---

publishFileSubmittable

▸ publishFileSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	EstimateFeesPublishFileParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1551

---

publishLink

▸ publishLink(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1749

---

publishLinkSubmittable

▸ publishLinkSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	EstimateFeesPublishLinkParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1783

---

publishMetadata

▸ publishMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	PublishMetadataParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1625

---

publishMetadataSubmittable

▸ publishMetadataSubmittable(parameters): SubmittableExtrinsic

Parameters

Name	Type
parameters	EstimateFeesPublishMetadataParams

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1669

---

rejectLoc

▸ rejectLoc(args): Promise<void>

Parameters

Name	Type
args	Object
args.locId	UUID
args.reason	string

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1845

---

requestFileReview

▸ requestFileReview(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.hash	Hash
parameters.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1486

---

requestLinkReview

▸ requestLinkReview(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.target	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1730

---

requestMetadataReview

▸ requestMetadataReview(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.locId	UUID
parameters.nameHash	Hash

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1606

---

requestVote

▸ requestVote(params): Promise<string>

Parameters

Name	Type
params	{ locId: UUID } & BlockchainSubmissionParams

Returns

Promise<string>

Defined in

packages/client/src/LocClient.ts:2371

---

reviewFile

▸ reviewFile(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & ReviewFileParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1495

---

reviewLink

▸ reviewLink(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & ReviewLinkParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1739

---

reviewMetadata

▸ reviewMetadata(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & ReviewMetadataParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1615

---

rework

▸ rework(locId): Promise<void>

Parameters

Name	Type
locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1224

---

setCollectionFileRestrictedDelivery

▸ setCollectionFileRestrictedDelivery(params): Promise<void>

Parameters

Name	Type
params	Object
params.hash	Hash
params.locId	UUID
params.restrictedDelivery	boolean

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2388

---

setInvitedContributor

▸ setInvitedContributor(params): Promise<void>

Parameters

Name	Type
params	BlockchainSubmission<SetInvitedContributorSelectionParams & FetchParameters>

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1324

---

setInvitedContributorSubmittable

▸ setInvitedContributorSubmittable(params): SubmittableExtrinsic

Parameters

Name	Type
params	SetInvitedContributorSelectionParams & FetchParameters

Returns

SubmittableExtrinsic

Defined in

packages/client/src/LocClient.ts:1339

---

setIssuerSelection

▸ setIssuerSelection(params): Promise<void>

Parameters

Name	Type
params	SetIssuerSelectionParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2358

---

storageSize

▸ storageSize(autoPublish, files): undefined | bigint

Parameters

Name	Type
autoPublish	boolean
files	AddFileParams[]

Returns

undefined | bigint

Defined in

packages/client/src/LocClient.ts:1921

---

submit

▸ submit(locId): Promise<void>

Parameters

Name	Type
locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1208

---

submitItemPublicData

▸ submitItemPublicData(locId, item): Promise<void>

Parameters

Name	Type
locId	UUID
item	CreateOffchainCollectionItem

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1132

---

submitRecordPublicData

▸ submitRecordPublicData(locId, record): Promise<void>

Parameters

Name	Type
locId	UUID
record	CreateOffchainTokensRecord

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1418

---

termsAndConditions

▸ termsAndConditions(parameters): TermsAndConditionsElement[]

Parameters

Name	Type
parameters	AddCollectionItemParams

Returns

TermsAndConditionsElement[]

Defined in

packages/client/src/LocClient.ts:1044

---

toFileParams

▸ toFileParams(item): FileParams

Parameters

Name	Type
item	AddFileParams

Returns

FileParams

Defined in

packages/client/src/LocClient.ts:2110

---

toLinkParams

▸ toLinkParams(item): LinkParams

Parameters

Name	Type
item	AddLinkParams

Returns

LinkParams

Defined in

packages/client/src/LocClient.ts:2119

---

toMetadataItemParams

▸ toMetadataItemParams(item): MetadataItemParams

Parameters

Name	Type
item	AddMetadataParams

Returns

MetadataItemParams

Defined in

packages/client/src/LocClient.ts:2102

---

uploadItemFile

▸ uploadItemFile(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.file	HashOrContent
parameters.itemId	Hash
parameters.locId	UUID

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1151

---

uploadTokensRecordFile

▸ uploadTokensRecordFile(parameters): Promise<void>

Parameters

Name	Type
parameters	Object
parameters.file	HashOrContent
parameters.locId	UUID
parameters.recordId	Hash

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:1451

---

validTokenOrThrow

▸ validTokenOrThrow(itemToken): void

Parameters

Name	Type
itemToken	ItemTokenWithRestrictedType

Returns

void

Defined in

packages/client/src/LocClient.ts:1178

---

voidLoc

▸ voidLoc(parameters): Promise<void>

Parameters

Name	Type
parameters	{ locId: UUID } & VoidParams

Returns

Promise<void>

Defined in

packages/client/src/LocClient.ts:2271