Class Client

Hierarchy

Client

Index

Constructors

Properties

generateID getAccountID getProjectID getReleaseID ipfs ipfsGateway license metaTx registry signer? subgraphUrl

Methods

accountExists addAccountMember addProjectMember approveRelease createAccount createProject createRelease getAccountMembers getAccountMeta getFileBaseName getLatestReleaseID getPreviousReleaseID getProductBalance getProductBalanceBatch getProductLimit getProductPrice getProductRoyaltyInfo getProductSupply getProductTokenPrice getProjectAccountID getProjectMembers getProjectMeta getReleaseMeta getReleaseProjectID getReleaseSigners isAccountMember isBrowserFile isProjectMember isReleaseSigner listAccountProjects listAccounts listProjectReleases listProjects listReleases listUserAccounts listUserProjects projectExists purchaseProduct purchaseProductToken releaseExists removeAccountMember removeProjectMember revokeRelease sendTx setAccountMeta setProductLimit setProductPrice setProductRoyalty setProductTokenPrice setProjectMeta withdrawProductBalance withdrawProductTokenBalance writeFile writeFolder writeFolderNode writeJSON

Constructors

constructor

new Client(registry, license, ipfs, ipfsGateway, subgraphUrl, signer?, metaTx?): Client
Parameters
- registry: Contract
- license: Contract
- ipfs: IPFSCLIENT
- ipfsGateway: string
- subgraphUrl: string
- Optional signer: Signer
- metaTx: boolean = true
Returns Client
- Defined in packages/valist-sdk/src/client.ts:23

Properties

generateID

generateID: ((parentID, name) => string) = generateID

Type declaration

- (parentID, name): string
- Generate account, project, and release IDs.
  Parameters
  - parentID: BigNumberish
    
    ID of the parent account or release. Use chainId for accounts.
  - name: string
    
    Name of the account, project, or rlease.
  Returns string

getAccountID

getAccountID: ((chainId, account) => string) = getAccountID

Type declaration

- (chainId, account): string
- Parameters
  - chainId: BigNumberish
  - account: string
  Returns string

getProjectID

getProjectID: ((chainId, account, project) => string) = getProjectID

Type declaration

- (chainId, account, project): string
- Parameters
  - chainId: BigNumberish
  - account: string
  - project: string
  Returns string

getReleaseID

getReleaseID: ((chainId, account, project, release) => string) = getReleaseID

Type declaration

- (chainId, account, project, release): string
- Parameters
  - chainId: BigNumberish
  - account: string
  - project: string
  - release: string
  Returns string

`Private` ipfs

ipfs: IPFSCLIENT

`Private` ipfsGateway

ipfsGateway: string

`Private` license

license: Contract

`Private` metaTx

metaTx: boolean = true

`Private` registry

registry: Contract

`Private` `Optional` signer

signer?: Signer

`Private` subgraphUrl

subgraphUrl: string

Methods

accountExists

accountExists(accountID): Promise<boolean>
Parameters
- accountID: BigNumberish
Returns Promise<boolean>
- Defined in packages/valist-sdk/src/client.ts:51

addAccountMember

addAccountMember(accountID, address): Promise<TransactionResponse>
Parameters
- accountID: BigNumberish
- address: string
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:96

addProjectMember

addProjectMember(projectID, address): Promise<TransactionResponse>
Parameters
- projectID: BigNumberish
- address: string
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:106

approveRelease

approveRelease(releaseID): Promise<TransactionResponse>
Parameters
- releaseID: BigNumberish
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:116

createAccount

createAccount(name, meta, members): Promise<TransactionResponse>
Parameters
- name: string
- meta: AccountMeta
- members: string[]
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:33

createProject

createProject(accountID, name, meta, members): Promise<TransactionResponse>
Parameters
- accountID: BigNumberish
- name: string
- meta: ProjectMeta
- members: string[]
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:39

createRelease

createRelease(projectID, name, meta): Promise<TransactionResponse>
Parameters
- projectID: BigNumberish
- name: string
- meta: ReleaseMeta
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:45

getAccountMembers

getAccountMembers(accountID): Promise<string[]>
Parameters
- accountID: BigNumberish
Returns Promise<string[]>
- Defined in packages/valist-sdk/src/client.ts:201

getAccountMeta

getAccountMeta(accountID): Promise<AccountMeta>
Parameters
- accountID: BigNumberish
Returns Promise<AccountMeta>
- Defined in packages/valist-sdk/src/client.ts:66

getFileBaseName

getFileBaseName(filePath): string
Parameters
- filePath: string
Returns string
- Defined in packages/valist-sdk/src/client.ts:294

getLatestReleaseID

getLatestReleaseID(projectID): Promise<BigNumberish>
Parameters
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:213

getPreviousReleaseID

getPreviousReleaseID(releaseID): Promise<BigNumberish>
Parameters
- releaseID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:217

getProductBalance

getProductBalance(address, projectID): Promise<BigNumberish>
Parameters
- address: string
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:193

getProductBalanceBatch

getProductBalanceBatch(addresses, projectIDs): Promise<BigNumberish[]>
Parameters
- addresses: string[]
- projectIDs: BigNumberish[]
Returns Promise<BigNumberish[]>
- Defined in packages/valist-sdk/src/client.ts:197

getProductLimit

getProductLimit(projectID): Promise<BigNumberish>
Parameters
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:181

getProductPrice

getProductPrice(projectID): Promise<BigNumberish>
Parameters
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:171

getProductRoyaltyInfo

getProductRoyaltyInfo(projectID, price): Promise<[string, BigNumberish]>
Parameters
- projectID: BigNumberish
- price: BigNumberish
Returns Promise<[string, BigNumberish]>
- Defined in packages/valist-sdk/src/client.ts:185

getProductSupply

getProductSupply(projectID): Promise<BigNumberish>
Parameters
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:189

getProductTokenPrice

getProductTokenPrice(token, projectID): Promise<BigNumberish>
Parameters
- token: string
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:176

getProjectAccountID

getProjectAccountID(projectID): Promise<BigNumberish>
Parameters
- projectID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:221

getProjectMembers

getProjectMembers(projectID): Promise<string[]>
Parameters
- projectID: BigNumberish
Returns Promise<string[]>
- Defined in packages/valist-sdk/src/client.ts:205

getProjectMeta

getProjectMeta(projectID): Promise<ProjectMeta>
Parameters
- projectID: BigNumberish
Returns Promise<ProjectMeta>
- Defined in packages/valist-sdk/src/client.ts:72

getReleaseMeta

getReleaseMeta(releaseID): Promise<ReleaseMeta>
Parameters
- releaseID: BigNumberish
Returns Promise<ReleaseMeta>
- Defined in packages/valist-sdk/src/client.ts:78

getReleaseProjectID

getReleaseProjectID(releaseID): Promise<BigNumberish>
Parameters
- releaseID: BigNumberish
Returns Promise<BigNumberish>
- Defined in packages/valist-sdk/src/client.ts:225

getReleaseSigners

getReleaseSigners(releaseID): Promise<string[]>
Parameters
- releaseID: BigNumberish
Returns Promise<string[]>
- Defined in packages/valist-sdk/src/client.ts:209

isAccountMember

isAccountMember(accountID, address): Promise<boolean>
Parameters
- accountID: BigNumberish
- address: string
Returns Promise<boolean>
- Defined in packages/valist-sdk/src/client.ts:229

isBrowserFile

isBrowserFile(file): file is File
Parameters
- file: File | FileObject
Returns file is File
- Defined in packages/valist-sdk/src/client.ts:298

isProjectMember

isProjectMember(projectID, address): Promise<boolean>
Parameters
- projectID: BigNumberish
- address: string
Returns Promise<boolean>
- Defined in packages/valist-sdk/src/client.ts:233

isReleaseSigner

isReleaseSigner(releaseID, address): Promise<boolean>
Parameters
- releaseID: BigNumberish
- address: string
Returns Promise<boolean>
- Defined in packages/valist-sdk/src/client.ts:237

listAccountProjects

listAccountProjects(accountID): Promise<Project[]>
Parameters
- accountID: BigNumberish
Returns Promise<Project[]>
- Defined in packages/valist-sdk/src/client.ts:262

listAccounts

listAccounts(): Promise<Account>
Returns Promise<Account>
- Defined in packages/valist-sdk/src/client.ts:241

listProjectReleases

listProjectReleases(projectID): Promise<Release[]>
Parameters
- projectID: BigNumberish
Returns Promise<Release[]>
- Defined in packages/valist-sdk/src/client.ts:270

listProjects

listProjects(): Promise<Project>
Returns Promise<Project>
- Defined in packages/valist-sdk/src/client.ts:248

listReleases

listReleases(): Promise<Release>
Returns Promise<Release>
- Defined in packages/valist-sdk/src/client.ts:255

listUserAccounts

listUserAccounts(address): Promise<Account[]>
Parameters
- address: string
Returns Promise<Account[]>
- Defined in packages/valist-sdk/src/client.ts:278

listUserProjects

listUserProjects(address): Promise<Project[]>
Parameters
- address: string
Returns Promise<Project[]>
- Defined in packages/valist-sdk/src/client.ts:286

projectExists

projectExists(projectID): Promise<boolean>
Parameters
- projectID: BigNumberish
Returns Promise<boolean>
- Defined in packages/valist-sdk/src/client.ts:56

purchaseProduct

purchaseProduct(projectID, recipient): Promise<ContractTransaction>
Parameters
- projectID: BigNumberish
- recipient: string
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:144

purchaseProductToken

purchaseProductToken(token, projectID, recipient): Promise<ContractTransaction>
Parameters
- token: string
- projectID: BigNumberish
- recipient: string
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:150

releaseExists

releaseExists(releaseID): Promise<boolean>
Parameters
- releaseID: BigNumberish
Returns Promise<boolean>
- Defined in packages/valist-sdk/src/client.ts:61

removeAccountMember

removeAccountMember(accountID, address): Promise<TransactionResponse>
Parameters
- accountID: BigNumberish
- address: string
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:101

removeProjectMember

removeProjectMember(projectID, address): Promise<TransactionResponse>
Parameters
- projectID: BigNumberish
- address: string
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:111

revokeRelease

revokeRelease(releaseID): Promise<TransactionResponse>
Parameters
- releaseID: BigNumberish
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:121

sendTx

sendTx(unsigned): Promise<TransactionResponse>
Parameters
- unsigned: ContractTransaction
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:361

setAccountMeta

setAccountMeta(accountID, meta): Promise<TransactionResponse>
Parameters
- accountID: BigNumberish
- meta: AccountMeta
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:84

setProductLimit

setProductLimit(projectID, limit): Promise<ContractTransaction>
Parameters
- projectID: BigNumberish
- limit: BigNumberish
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:126

setProductPrice

setProductPrice(projectID, price): Promise<ContractTransaction>
Parameters
- projectID: BigNumberish
- price: BigNumberish
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:134

setProductRoyalty

setProductRoyalty(projectID, recipient, amount): Promise<ContractTransaction>
Parameters
- projectID: BigNumberish
- recipient: string
- amount: BigNumberish
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:130

setProductTokenPrice

setProductTokenPrice(token, projectID, price): Promise<ContractTransaction>
Parameters
- token: string
- projectID: BigNumberish
- price: BigNumberish
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:139

setProjectMeta

setProjectMeta(projectID, meta): Promise<TransactionResponse>
Parameters
- projectID: BigNumberish
- meta: ProjectMeta
Returns Promise<TransactionResponse>
- Defined in packages/valist-sdk/src/client.ts:90

withdrawProductBalance

withdrawProductBalance(projectID, recipient): Promise<ContractTransaction>
Parameters
- projectID: BigNumberish
- recipient: string
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:161

withdrawProductTokenBalance

withdrawProductTokenBalance(token, projectID, recipient): Promise<ContractTransaction>
Parameters
- token: string
- projectID: BigNumberish
- recipient: string
Returns Promise<ContractTransaction>
- Defined in packages/valist-sdk/src/client.ts:166

writeFile

writeFile(file, wrapWithDirectory?, onProgress?): Promise<string>
Parameters
- file: File | FileObject
- wrapWithDirectory: boolean = false
- Optional onProgress: ((percentCompleteOrBytesUploaded) => void)
  - - (percentCompleteOrBytesUploaded): void
    - Parameters
      
      percentCompleteOrBytesUploaded: string | number
      
      Returns void
Returns Promise<string>
- Defined in packages/valist-sdk/src/client.ts:314

writeFolder

writeFolder(files, wrapWithDirectory?, onProgress?): Promise<string>
Parameters
- files: ImportCandidate[]
- wrapWithDirectory: boolean = false
- Optional onProgress: ((percent) => void)
  - - (percent): void
    - Parameters
      
      percent: number
      
      Returns void
Returns Promise<string>
- Defined in packages/valist-sdk/src/client.ts:338

writeFolderNode

writeFolderNode(files, wrapWithDirectory?, onProgress?): Promise<string>
Parameters
- files: ImportCandidate[]
- wrapWithDirectory: boolean = false
- Optional onProgress: ((percent) => void)
  - - (percent): void
    - Parameters
      
      percent: number
      
      Returns void
Returns Promise<string>
- Defined in packages/valist-sdk/src/client.ts:350

writeJSON

writeJSON(data): Promise<string>
Parameters
- data: Object
Returns Promise<string>
- Defined in packages/valist-sdk/src/client.ts:302

Class Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

registry: Contract

license: Contract

ipfs: IPFSCLIENT

ipfsGateway: string

subgraphUrl: string

Optional signer: Signer

metaTx: boolean = true

Returns Client

Properties

generateID

Type declaration

Parameters

parentID: BigNumberish

name: string

Returns string

getAccountID

Type declaration

Parameters

chainId: BigNumberish

account: string

Returns string

getProjectID

Type declaration

Parameters

chainId: BigNumberish

account: string

project: string

Returns string

getReleaseID

Type declaration

Parameters

chainId: BigNumberish

account: string

project: string

release: string

Returns string

Private ipfs

Private ipfsGateway

Private license

Private metaTx

Private registry

Private Optional signer

Private subgraphUrl

Methods

accountExists

Parameters

accountID: BigNumberish

Returns Promise<boolean>

addAccountMember

Parameters

accountID: BigNumberish

address: string

Returns Promise<TransactionResponse>

addProjectMember

Parameters

projectID: BigNumberish

address: string

Returns Promise<TransactionResponse>

approveRelease

Parameters

releaseID: BigNumberish

Returns Promise<TransactionResponse>

createAccount

Parameters

name: string

meta: AccountMeta

members: string[]

Returns Promise<TransactionResponse>

createProject

Parameters

accountID: BigNumberish

`Optional` signer: Signer

`Private` ipfs

`Private` ipfsGateway

`Private` license

`Private` metaTx

`Private` registry

`Private` `Optional` signer

`Private` subgraphUrl