Publishing/fetching Releases

The Valist SDK can be used to manage releases. 
ReleaseIDs
Release ID is the keccak256 hash of the ProjectID concatenated by the Release Name. 
Generate ID Function
The generate ID function generates an ID for a Release. 
1
export function generateID(
2
  parentID: ethers.BigNumberish,
3
  name: string
4
): string 
Copied!
Release Meta 
The SDK exports the following class for metadata associated with a release. 
1
export class ReleaseMeta {
2
	/** project image */
3
	public image?: string;
4
	/** full release name. */
5
	public name?: string;
6
	/** short description of the release. */
7
	public description?: string;
8
	/** link to the release assets. */
9
	public external_url?: string;
10
}
Copied!
Release Methods
createRelease Method
This method creates a release for a project. 
1
async createRelease(
2
  projectID: ethers.BigNumberish,
3
  name: string,
4
  meta: ReleaseMeta
5
): Promise<TransactionResponse> 
Copied!
Parameters
Type
Description
projectID
BigNumber
The projectID for which to create the release.
name
string
Name of the release, used to create the ReleaseID​
meta
​ReleaseMeta​
Metadata of the release. 
releaseExists method  Readonly 
Checks if a release exists. 
1
async releaseExists(
2
  releaseID: ethers.BigNumberish
3
): Promise<boolean>
Copied!
Parameter
Type 
Description
releaseID
BigNumber
​Id of the release. 
getReleaseMeta Method Readonly
Returns the metadata for the release. 
1
async getReleaseMeta(
2
  releaseID: ethers.BigNumberish
3
): Promise<ReleaseMeta>
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
approveRelease Method
Approves/signs the release and adds to the signer's list. 
1
async approveRelease(
2
  releaseID: ethers.BigNumberish
3
): Promise<TransactionResponse>
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
revokeRelease Method
Revokes the release and removes the caller from the signers list. 
1
async revokeRelease(
2
  releaseID: ethers.BigNumberish
3
): Promise<TransactionResponse>
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
getReleaseSigners Method Readonly
Returns the list of signers for a release.
1
async getReleaseSigners(
2
  releaseID: ethers.BigNumberish
3
): Promise<string[]> 
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
getPreviousReleaseID Method Readonly
Returns the releaseID of the preceding release. 
1
async getPreviousReleaseID(
2
  releaseID: ethers.BigNumberish
3
): Promise<ethers.BigNumber>
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
getReleaseProjectID Method Readonly
Returns the ProjectID of the Release. 
1
async getReleaseProjectID(
2
  releaseID: ethers.BigNumberish
3
): Promise<ethers.BigNumber>
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
isReleaseSigner Method Readonly
Checks if an address is the signer of a release. 
1
async isReleaseSigner(
2
 releaseID: ethers.BigNumberish,
3
 address: string
4
): Promise<boolean>
Copied!
Parameter
Type
Description
releaseID
BigNumber
​Id of the release. 
address
string
Address of Signer
​

TypeScript SDK - Previous

Managing Projects

Next - TypeScript SDK

Managing Products

Last modified 1mo ago

Export as PDF

Copy link

Contents

ReleaseIDs

Release Meta

Release Methods