Skip to content

Commit

Permalink
SoundEditionType: single | album (#62)
Browse files Browse the repository at this point in the history
* SoundEditionType

* renames

* toLowerCase

* improve types

* module: node16

* fix ts

* remove duplicate config

* Removes PayableOverrides assertion

Co-authored-by: Pablo Sáez <pablosaez1995@gmail.com>
  • Loading branch information
gigamesh and PabloSzx authored Sep 10, 2022
1 parent 055f781 commit 5696974
Show file tree
Hide file tree
Showing 12 changed files with 233 additions and 219 deletions.
5 changes: 5 additions & 0 deletions .changeset/young-toes-rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@soundxyz/sdk': patch
---

Integrates album contract & EditionType to distinguish between single & album
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@
"private": true,
"scripts": {
"format": "prettier . --write",
"check": "pnpm -r check",
"postinstall": "husky install",
"pretty-quick": "pretty-quick --staged",
"release": "pnpm -r --access=public publish --no-git-checks",
"release:canary": "(node scripts/canary-release.js && pnpm -r publish --access public --no-git-checks --tag alpha) || echo Skipping Canary...",
"test": "pnpm -r --filter=sdk test",
"tsc": "tsc -p tsconfig.check.json",
"changeset": "changeset"
},
"license": "MIT",
Expand Down Expand Up @@ -51,7 +49,7 @@
"pretty-quick": "^3.1.3",
"rimraf": "^3.0.2",
"semver": "^7.3.7",
"typescript": "4.7.4"
"typescript": "4.8.3"
},
"pnpm": {
"patchedDependencies": {
Expand Down
5 changes: 2 additions & 3 deletions packages/sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"scripts": {
"check": "tsc --pretty --noEmit",
"prepack": "node build.mjs",
"postpublish": "gh-release",
"pull-env": "dotenv-vault pull",
Expand Down Expand Up @@ -59,7 +58,7 @@
"@nomicfoundation/hardhat-network-helpers": "^1.0.4",
"@nomiclabs/hardhat-ethers": "^2.1.1",
"@nomiclabs/hardhat-waffle": "^2.0.3",
"@soundxyz/sound-protocol": "0.0.2-alpha-a71f0db.0",
"@soundxyz/sound-protocol": "0.0.2-alpha-c4e7cc9.0",
"@types/chai": "^4.3.3",
"@types/mocha": "^9.1.1",
"@types/node": "18.7.5",
Expand All @@ -78,7 +77,7 @@
"require-env-variable": "^4.0.1",
"ts-node": "^10.9.1",
"tslib": "^2.4.0",
"typescript": "4.7.4"
"typescript": "4.8.3"
},
"peerDependencies": {
"@soundxyz/sound-protocol": "*"
Expand Down
11 changes: 11 additions & 0 deletions packages/sdk/schema.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -1138,6 +1138,7 @@ enum ContractMethod {
Contract type, currently the playform only supports "ARTIST"
"""
enum ContractType {
ALBUM
ARTIST
EDITION
}
Expand Down Expand Up @@ -2427,6 +2428,16 @@ type Mutation {
input: CreateReleaseInput!
): Release!

"""
[ARTIST] Create release for new sound edition contracts
"""
createSoundEditionRelease(
"""
New release data
"""
input: CreateReleaseInput!
): Release!

"""
[ADMIN] Delete specified sale schedule
"""
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/api/graphql/gql.ts
Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,7 @@ export const ContractMethod = {
export type ContractMethod = typeof ContractMethod[keyof typeof ContractMethod]
/** Contract type, currently the playform only supports "ARTIST" */
export const ContractType = {
ALBUM: 'ALBUM',
ARTIST: 'ARTIST',
EDITION: 'EDITION',
} as const
Expand Down Expand Up @@ -1207,6 +1208,8 @@ export type Mutation = {
createPresale: SaleSchedule
/** [ARTIST] Create release */
createRelease: Release
/** [ARTIST] Create release for new sound edition contracts */
createSoundEditionRelease: Release
/** [ADMIN] Delete specified sale schedule */
deleteSaleSchedule: Scalars['Void']
/** [AUTHENTICATED] Delete shelf for user */
Expand Down Expand Up @@ -1431,6 +1434,11 @@ export type MutationcreateReleaseArgs = {
input: CreateReleaseInput
}

/** Mutations */
export type MutationcreateSoundEditionReleaseArgs = {
input: CreateReleaseInput
}

/** Mutations */
export type MutationdeleteSaleScheduleArgs = {
saleScheduleId: Scalars['UUID']
Expand Down
25 changes: 17 additions & 8 deletions packages/sdk/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import type { Signer } from '@ethersproject/abstract-signer'
import type { BigNumberish } from '@ethersproject/bignumber'
import type { ContractTransaction } from '@ethersproject/contracts'
import type { ReleaseInfoQueryVariables } from './api/graphql/gql'
import type { ContractCall, EditionConfig, MintConfig, MintSchedule } from './types'
import type { ContractCall, EditionConfig, MintConfig, MintSchedule, EditionType } from './types'

export function SoundClient({
signer,
Expand Down Expand Up @@ -267,19 +267,21 @@ export function SoundClient({
editionConfig,
mintConfigs,
salt: customSalt,
editionType = 'SINGLE',
}: {
editionConfig: EditionConfig
mintConfigs: MintConfig[]
salt?: string | number
editionType?: EditionType
}) {
const { signer, chainId, userAddress } = await _requireSigner()

const formattedSalt = getSaltAsBytes32(customSalt || Math.random() * 1_000_000_000_000_000)

const creatorAdddress = _getCreatorAddress(chainId)
const creatorAddress = _getCreatorAddress({ chainId, editionType })

// Precompute the edition address.
const editionAddress = await SoundCreatorV1__factory.connect(creatorAdddress, signer).soundEditionAddress(
const editionAddress = await SoundCreatorV1__factory.connect(creatorAddress, signer).soundEditionAddress(
userAddress,
formattedSalt,
)
Expand Down Expand Up @@ -377,7 +379,6 @@ export function SoundClient({
editionConfig.mintRandomnessTimeThreshold,
])

const creatorAddress = _getCreatorAddress(chainId)
const soundCreatorContract = SoundCreatorV1__factory.connect(creatorAddress, signer)

return soundCreatorContract.createSoundAndMints(
Expand Down Expand Up @@ -409,10 +410,18 @@ export function SoundClient({
}
}

async function expectedEditionAddress({ deployer, salt }: { deployer: string; salt: string | number }) {
async function expectedEditionAddress({
deployer,
salt,
editionType = 'SINGLE',
}: {
deployer: string
salt: string | number
editionType?: EditionType
}) {
validateAddress(deployer)
const { signerOrProvider, chainId } = await _requireSignerOrProvider()
const soundCreatorAddress = _getCreatorAddress(chainId)
const soundCreatorAddress = _getCreatorAddress({ chainId, editionType })

return SoundCreatorV1__factory.connect(soundCreatorAddress, signerOrProvider).soundEditionAddress(
deployer,
Expand Down Expand Up @@ -596,7 +605,7 @@ export function SoundClient({
return Object.values(supportedNetworks).includes(chainId as ChainId)
}

function _getCreatorAddress(chainId: number) {
function _getCreatorAddress({ chainId, editionType }: { chainId: number; editionType: EditionType }) {
if ((chainId === supportedChainIds.LOCAL || chainId === supportedChainIds.LOCAL_ALT) && !soundCreatorAddress) {
throw new CreatorAddressMissingForLocalError()
}
Expand All @@ -605,7 +614,7 @@ export function SoundClient({
return soundCreatorAddress
}

if (isSoundCreatorAddressChain(chainId)) return soundCreatorAddresses[chainId]
if (isSoundCreatorAddressChain(chainId)) return soundCreatorAddresses[chainId][editionType]

throw new UnsupportedCreatorAddressError({ chainId })
}
Expand Down
7 changes: 7 additions & 0 deletions packages/sdk/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,13 @@ export type ContractCall = {
calldata: string
}

export const EditionType = {
SINGLE: 'SINGLE',
ALBUM: 'ALBUM',
} as const

export type EditionType = typeof EditionType[keyof typeof EditionType]

/*********************************************************
API TYPES
********************************************************/
Expand Down
9 changes: 7 additions & 2 deletions packages/sdk/src/utils/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import {
FixedPriceSignatureMinter__factory,
MerkleDropMinter__factory,
} from '@soundxyz/sound-protocol/typechain/index'
import { contractAddresses } from '@soundxyz/sound-protocol'
import { EditionType } from '../types'

export const minterFactoryMap = {
[interfaceIds.IRangeEditionMinter]: RangeEditionMinter__factory,
Expand Down Expand Up @@ -33,8 +35,11 @@ export const supportedChainIds = {

export const soundCreatorAddresses = {
// [supportedChainIds.MAINNET]: 'TODO',
[supportedChainIds.GOERLI]: '0x063df381b76207fa7ef94bc7f81f68cb6708ee0e',
}
[supportedChainIds.GOERLI]: {
[EditionType.SINGLE]: contractAddresses.preview.soundCreatorV1.single,
[EditionType.ALBUM]: contractAddresses.preview.soundCreatorV1.album,
},
} as const

export function isSoundCreatorAddressChain(chain: number): chain is keyof typeof soundCreatorAddresses {
return chain in soundCreatorAddresses
Expand Down
105 changes: 4 additions & 101 deletions packages/sdk/tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -1,105 +1,8 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "esnext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

"outDir": "dist",
/* Modules */
"module": "esnext" /* Specify what module code is generated. */,
"rootDir": "./src" /* Specify the root folder within your source files. */,
"moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
"declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
"emitDeclarationOnly": true /* Only output d.ts files and not JavaScript files. */,
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
"importsNotUsedAsValues": "error" /* Specify emit/checking behavior for imports that are only used for types. */,
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"rootDir": "./src",
"outDir": "./dist"
},
"include": ["src/**/*"]
"include": ["src"]
}
Loading

0 comments on commit 5696974

Please sign in to comment.