Skip to content

Latest commit

 

History

History
126 lines (91 loc) · 5.33 KB

UploadContractApi.md

File metadata and controls

126 lines (91 loc) · 5.33 KB

Functions

createFormData(postData)FormData

object를 FormData type으로 변환시켜주는 함수

checkIsDupSong(formData)boolean | null

중복 곡을 체크하는 함수

postMetadata(data, title, album, image, lyrics)string | null

메타데이터 CID1 업로드

isRightRates(rates)boolean
deployAndGetAddress(addresses, proportions, songCid, price)Object

settlementContract 배포

deDup(holders, rates)object

중복 요소 제거 함수

postContractData(data)

settlementContract주소를 포함한 폼 데이터를 백엔드에 post함.

createFormData(postData) ⇒ FormData

object를 FormData type으로 변환시켜주는 함수

Kind: global function
Returns: FormData - FormData type 반환

Param Type Description
postData Object key-value쌍으로 이루어진 object

checkIsDupSong(formData) ⇒ boolean | null

중복 곡을 체크하는 함수

Kind: global function

Param Type Description
formData FormData file이 담긴 FormData

postMetadata(data, title, album, image, lyrics) ⇒ string | null

메타데이터 CID1 업로드

Kind: global function

Param Type Description
data Object
title string description
album string description
image Buffer description
lyrics string description
... * ...

isRightRates(rates) ⇒ boolean

Kind: global function
Returns: boolean - 저작권 비율이 모두 양수이고, 그 총합이 1이면 true 반환

Param Type Description
rates array 저작권 비율. 소수 number로 이루어짐

deployAndGetAddress(addresses, proportions, songCid, price) ⇒ Object

settlementContract 배포

Kind: global function
Returns: Object - settlementContract 객체 반환

Param Type Default Description
addresses Array 저작권자들 각각의 지갑주소
proportions Array 저작권자들 각각의 정산 비율
songCid string CID1(곡 메타데이터 CID)
price string | number "900000000" 곡의 가격

deDup(holders, rates) ⇒ object

중복 요소 제거 함수

Kind: global function
Returns: object - 중복없는 object 반환

Param Type Description
holders string 저작권자
rates string 저작권 비율

postContractData(data)

settlementContract주소를 포함한 폼 데이터를 백엔드에 post함.

Kind: global function

Param Type Description
data Object description
data.file Buffer 음원파일
data.title string 노래 제목
data.holder Array 저작권자 리스트
data.rate Array 저작권자 비율
data.cid1 number CID1(음원 메타데이터 정보; 가수, 가사 앨범아트 등)
data.settleAddr string 정산컨트랙트 주소
... * ...