@audius/sdk 0.0.0

package/scripts/Wormhole.json

@@ -0,0 +1,155 @@
+{
+  "contractName": "Wormhole",
+  "abi": [
+    {
+      "constant": true,
+      "inputs": [],
+      "name": "DOMAIN_SEPARATOR",
+      "outputs": [
+        {
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
+        }
+      ],
+      "payable": false,
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "constant": true,
+      "inputs": [],
+      "name": "LOCK_ASSETS_TYPEHASH",
+      "outputs": [
+        {
+          "internalType": "bytes32",
+          "name": "",
+          "type": "bytes32"
+        }
+      ],
+      "payable": false,
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "constant": false,
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_tokenAddress",
+          "type": "address"
+        },
+        {
+          "internalType": "address",
+          "name": "_wormholeAddress",
+          "type": "address"
+        }
+      ],
+      "name": "initialize",
+      "outputs": [],
+      "payable": false,
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "constant": false,
+      "inputs": [],
+      "name": "initialize",
+      "outputs": [],
+      "payable": false,
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "constant": false,
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "from",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "amount",
+          "type": "uint256"
+        },
+        {
+          "internalType": "bytes32",
+          "name": "recipient",
+          "type": "bytes32"
+        },
+        {
+          "internalType": "uint8",
+          "name": "targetChain",
+          "type": "uint8"
+        },
+        {
+          "internalType": "bool",
+          "name": "refundDust",
+          "type": "bool"
+        },
+        {
+          "internalType": "uint256",
+          "name": "deadline",
+          "type": "uint256"
+        },
+        {
+          "internalType": "uint8",
+          "name": "v",
+          "type": "uint8"
+        },
+        {
+          "internalType": "bytes32",
+          "name": "r",
+          "type": "bytes32"
+        },
+        {
+          "internalType": "bytes32",
+          "name": "s",
+          "type": "bytes32"
+        }
+      ],
+      "name": "lockAssets",
+      "outputs": [],
+      "payable": false,
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "constant": true,
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "name": "nonces",
+      "outputs": [
+        {
+          "internalType": "uint32",
+          "name": "",
+          "type": "uint32"
+        }
+      ],
+      "payable": false,
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "constant": true,
+      "inputs": [],
+      "name": "token",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "payable": false,
+      "stateMutability": "view",
+      "type": "function"
+    }
+  ]
+}

package/scripts/addCIDToIpldBlacklist.js

@@ -0,0 +1,124 @@
+const { getDataContractAccounts } = require('../initScripts/helpers/utils')
+const contractConfig = require('../../contracts/contract-config.js')
+const AudiusLibs = require('../src')
+const { initializeLibConfig } = require('../tests/helpers')
+const Utils = require('../src/utils')
+
+const networks = new Set([
+  'development',
+  'test_local'
+  // disable mainnet keys for now
+  /* 'audius_private',
+  'poa_mainnet',
+  'poa_sokol' */
+])
+
+let config
+
+// node addCIDToIpldBlacklist.js <env> <cid>
+// From libs root:
+// node scripts/addCIDToIpldBlacklist.js development QmSH5gJPHg9xLzV823ty8BSGyHNP6ty22bgLsv5MLY3kBq
+
+async function run () {
+  try {
+    const { network, cid } = parseArgs()
+    const decodedCID = decodeCID(cid)
+    config = contractConfig[network]
+    // note: can extract private key here if necessary
+    const { BLACKLISTER_PUBLIC_KEY } = await getBlacklisterKeys(network)
+    const audiusLibs = await createAndInitLibs(BLACKLISTER_PUBLIC_KEY)
+    const ipldTxReceipt = await addIPLDTxToChain(audiusLibs, decodedCID.digest)
+
+    console.log(`Successfully added ${cid} to chain! \nIpld Tx Receipt:`)
+    console.log(ipldTxReceipt)
+
+    console.log(
+      '\nYou might need to wait a full 60s cycle for your CID to be added to the IPLD blacklist table!'
+    )
+
+    // manually check ipld blacklist table to see if CID was added
+    // NOTE: might need to wait ~60s
+  } catch (e) {
+    console.error(e.message)
+    if (e.message.includes('Incorrect script usage')) {
+      console.log('Available environments are:')
+      console.log(networks)
+    }
+  }
+}
+
+// get appropriate args from CLI
+function parseArgs () {
+  const args = process.argv.slice(2)
+  const network = args[0]
+  const cid = args[1]
+
+  // check appropriate CLI usage
+  if (!network || !cid || !networks.has(network)) {
+    let errorMessage = `Incorrect script usage for input env (${network}) and (cid) ${cid}.`
+    errorMessage += "\nPlease follow the structure 'node addCIDToIpldBlacklist.js <env> <cid>'"
+    throw new Error(errorMessage)
+  }
+
+  return { network, cid }
+}
+
+// transform CID into a readable digest
+function decodeCID (cid) {
+  let decodedCID
+  try {
+    decodedCID = Utils.decodeMultihash(cid)
+  } catch (e) {
+    throw new Error(`Error with decoding input CID ${cid}: ${e}`)
+  }
+  return decodedCID
+}
+
+// get key according to environmnet
+async function getBlacklisterKeys (network) {
+  let BLACKLISTER_PUBLIC_KEY
+  let BLACKLISTER_PRIVATE_KEY = null // what would this be for mainnet?
+
+  // if local dev, grab priv/pub keys from local ganache chain
+  // else, grab key from config
+  // NOTE: for local dev, wallet[0] is unlocked and does not require a private key
+  if (network === 'development' || network === 'test_local') {
+    const ganacheContractsAccounts = await getDataContractAccounts()
+    const keyPairs = ganacheContractsAccounts.private_keys
+    BLACKLISTER_PUBLIC_KEY = Object.keys(keyPairs)[0]
+    BLACKLISTER_PRIVATE_KEY = keyPairs[BLACKLISTER_PUBLIC_KEY]
+  } else {
+    BLACKLISTER_PUBLIC_KEY = config.blacklisterAddress
+  }
+  return { BLACKLISTER_PUBLIC_KEY, BLACKLISTER_PRIVATE_KEY }
+}
+
+// init libs with blacklister public address
+async function createAndInitLibs (blacklisterPublicKey) {
+  let audiusLibs
+  try {
+    const libsConfig = await initializeLibConfig(blacklisterPublicKey)
+    audiusLibs = new AudiusLibs(libsConfig)
+    await audiusLibs.init()
+  } catch (e) {
+    throw new Error(`Error with initializing libs: ${e}`)
+  }
+
+  return audiusLibs
+}
+
+// add cid to ipld blacklist
+async function addIPLDTxToChain (audiusLibs, digest) {
+  let ipldTxReceipt
+  try {
+    ipldTxReceipt = await audiusLibs.contracts.IPLDBlacklistFactoryClient.addIPLDToBlacklist(
+      digest
+    )
+  } catch (e) {
+    throw new Error(`Error with adding IPLD blacklist txn: ${e}`)
+  }
+
+  return ipldTxReceipt
+}
+
+run()

package/scripts/circleci-test.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+set -e
+
+<<COMMENT
+CircleCI Specific Test Script
+Removes dependency on docker container, assumes ports 8545 & 8546 are exposed
+COMMENT
+
+##### INIT DATA CONTRACTS #####
+
+if [ -d "../contracts" ]; then
+  echo "Audius contracts repo is present"
+  cd ../contracts/
+else
+  echo "INCORRECT REPOSITORY STRUCTURE. PLEASE FOLLOW README"
+  exit 1
+fi
+
+rm -rf ./build/
+npm run truffle-migrate
+
+##### INIT ETH CONTRACTS #####
+
+if [ -d "../eth-contracts" ]; then
+  echo "Audius eth-contracts repo is present"
+  cd ../eth-contracts/
+else
+  echo "INCORRECT REPOSITORY STRUCTURE. PLEASE FOLLOW README"
+  exit 1
+fi
+
+rm -rf ./build/
+npm run truffle-migrate
+
+#### RUN TESTS #####
+
+cd ../libs/
+
+# Migrate data & eth contracts
+# - Copy contracts build dir + create config files
+# - Data contracts config: registry contract & owner wallet addresses
+# - Eth contracts config: AudiusToken contract address
+sh ./scripts/migrate_contracts.sh
+
+# Run unit tests
+npm run test:unit
+
+# run tests
+printf '\nSTART tests:\n\n'
+node_modules/.bin/ts-mocha tests/index.js
+
+# run linter
+npm run lint

package/scripts/communityRewards/transferCommunityRewardsToSolana.js

@@ -0,0 +1,222 @@
+/*
+Script that has no internal dependencies outside of web3, solanaWeb3, certusOne SDK to initialize and transfer
+*/
+
+const axios = require('axios')
+const Web3 = require('web3')
+const solanaWeb3 = require('@solana/web3.js')
+const { Keypair } = solanaWeb3
+const {
+  getSignedVAA,
+  getEmitterAddressEth,
+  parseSequenceFromLogEth,
+  redeemOnSolana,
+  postVaaSolana,
+  CHAIN_ID_ETH
+} = require('@certusone/wormhole-sdk')
+const { setDefaultWasm } = require('@certusone/wormhole-sdk/lib/cjs/solana/wasm.js')
+const EthRewardManagerABI = require('../../eth-contracts/ABIs/EthRewardsManager.json').abi
+
+const { grpc } = require('@improbable-eng/grpc-web')
+const { NodeHttpTransport } = require('@improbable-eng/grpc-web-node-http-transport')
+
+// Without this, we get the error:
+// "This environment's XHR implementation cannot support binary transfer."
+grpc.setDefaultTransport(NodeHttpTransport())
+
+setDefaultWasm('node')
+
+// Please provide an eth RPC provider endpoint here
+// For example https://mainnet.infura.io/v3/<your-key-here>
+const ETH_PROVIDER = process.env.ethProvider
+const SOLANA_CLUSTER_ENDPOINT = 'https://audius.rpcpool.com/'
+const ETH_BRIDGE_ADDRESS = '0x98f3c9e6E3fAce36bAAd05FE09d375Ef1464288B'
+const SOL_BRIDGE_ADDRESS = 'worm2ZoG2kUd4vFXhvjh93UUH596ayRfgQ2MgjNMTth'
+const ETH_TOKEN_BRIDGE_ADDRESS = '0x3ee18B2214AFF97000D974cf647E7C347E8fa585'
+const SOL_TOKEN_BRIDGE_ADDRESS = 'wormDTUJ6AWPNvk59vGQbDvGJmqbDTdgWgAqcLBCgUb'
+
+// https://github.com/certusone/wormhole/blob/7f5740754b8d722c42310be086dc21efa7ed8c83/bridge_ui/src/utils/consts.ts#L150
+const WORMHOLE_RPC_HOSTS = [
+  'https://wormhole-v2-mainnet-api.certus.one',
+  'https://wormhole.inotel.ro',
+  'https://wormhole-v2-mainnet-api.mcf.rocks',
+  'https://wormhole-v2-mainnet-api.chainlayer.network',
+  'https://wormhole-v2-mainnet-api.staking.fund',
+  'https://wormhole-v2-mainnet-api.chainlayer.network'
+]
+
+const connection = new solanaWeb3.Connection(SOLANA_CLUSTER_ENDPOINT)
+
+// num attempts and delay between attempts to find transaction receipt
+const NUM_RETRIES_RECEIPT = 5
+const RETRY_DELAY_MS_RECEIPT = 1000
+
+// num attempts and delay between attempts to find requested VAA
+// stop if not found after 5 minutes (60 * 5000ms)
+const NUM_RETRIES_VAA = 60
+const RETRY_DELAY_MS_VAA = 5000
+
+const ETH_REWARD_MANAGER_ADDRESS = '0x5aa6B99A2B461bA8E97207740f0A689C5C39C3b0'
+const TEST_PRIVATE_KEY = process.env.testPrivateKey
+const FEE_PAYER_SECRET_KEY = process.env.feePayerAddress
+
+const feePayerSecretKey = Uint8Array.from(JSON.parse(FEE_PAYER_SECRET_KEY))
+const feePayerKeypair = Keypair.fromSecretKey(feePayerSecretKey)
+const feePayerPublicKey = feePayerKeypair.publicKey
+const feePayerAddress = feePayerPublicKey.toString()
+
+const web3 = new Web3(ETH_PROVIDER)
+// ethereum address that executes the transfer to solana transaction
+const ethAccount = web3.eth.accounts.wallet.add(TEST_PRIVATE_KEY)
+
+const arbiterFee = 0
+const nonce = 2 // this is just some random number atm
+
+async function getGasPrice () {
+  try {
+    const gasPrices = await axios.get(
+      'https://ethgasstation.info/json/ethgasAPI.json'
+    )
+    return web3.utils.toWei((gasPrices.data.fastest / 10).toString(), 'gwei')
+  } catch (err) {
+    console.error(
+      `Got ${err} when trying to fetch gas from ethgasstation.info, falling back web3's gas estimation`
+    )
+    return (await web3.eth.getGasPrice()).toString()
+  }
+}
+
+// "Fetch the signedVAA from the Wormhole Network (this may require retries while you wait for confirmation)"
+// https://github.com/certusone/wormhole/blob/c824a996360103eb2147bc43f7b0f7e3b989bdf5/sdk/js/src/rpc/getSignedVAAWithRetry.ts#L3
+const getSignedVAAWithRetry = async function (
+  hosts,
+  emitterChain,
+  emitterAddress,
+  sequence,
+  extraGrpcOpts = {},
+  retryTimeout = RETRY_DELAY_MS_VAA,
+  retryAttempts = NUM_RETRIES_VAA
+) {
+  let currentWormholeRpcHost = -1
+  const getNextRpcHost = () => ++currentWormholeRpcHost % hosts.length
+  let result
+  let attempts = 0
+  while (!result) {
+    attempts++
+    console.log(`transferCommunityRewardsToSolana.js | getSignedVAAWithRetry | attempt # ${attempts}`)
+    await new Promise((resolve) => setTimeout(resolve, retryTimeout))
+    try {
+      result = await getSignedVAA(
+        hosts[getNextRpcHost()],
+        emitterChain,
+        emitterAddress,
+        sequence,
+        extraGrpcOpts
+      )
+    } catch (e) {
+      if (retryAttempts !== undefined && attempts >= retryAttempts) {
+        throw e
+      }
+    }
+  }
+  return result
+}
+
+const getReceipt = async (txHash, numRetries) => {
+  console.log(`transferCommunityRewardsToSolana.js | getReceipt | txHash ${txHash} | ${numRetries} retries left`)
+  if (numRetries <= 0) {
+    return null
+  }
+  const txReceipt = await web3.eth.getTransactionReceipt(txHash)
+  if (!txReceipt) {
+    await new Promise(resolve => setTimeout(resolve, RETRY_DELAY_MS_RECEIPT))
+    return getReceipt(numRetries - 1)
+  }
+  return txReceipt
+}
+
+async function run () {
+  try {
+    const gasPrice = await getGasPrice()
+    console.log({ gasPrice })
+
+    const ethRewardsManagerContract = new web3.eth.Contract(
+      EthRewardManagerABI,
+      ETH_REWARD_MANAGER_ADDRESS
+    )
+    // transfer eth rewards manager funds to solana via wormhole
+    // recipient is defined in the eth rewards manager contract
+    const txResp = await ethRewardsManagerContract.methods.transferToSolana(
+      arbiterFee,
+      nonce
+    ).send({
+      from: ethAccount.address,
+      gas: 200000, // should this be dynamic?
+      gasPrice
+    })
+    console.log({ txResp })
+
+    const txHash = txResp.transactionHash
+    console.log({ txHash })
+
+    const txReceipt = await getReceipt(txHash, NUM_RETRIES_RECEIPT)
+    console.log({ txReceipt })
+    if (!txReceipt) {
+      return
+    }
+
+    const sequence = parseSequenceFromLogEth(txReceipt, ETH_BRIDGE_ADDRESS)
+    const emitterAddress = getEmitterAddressEth(ETH_TOKEN_BRIDGE_ADDRESS)
+    console.log({ sequence, emitterAddress })
+
+    // Attest and transfer, aka
+    // Fetch and post the signed VAA bytes for our transaction
+    // Then redeem on solana
+    const { vaaBytes } = await getSignedVAAWithRetry(
+      WORMHOLE_RPC_HOSTS,
+      CHAIN_ID_ETH,
+      emitterAddress,
+      sequence
+    )
+    console.log({ vaaBytes })
+
+    const signTransaction = async (transaction) => {
+      transaction.partialSign(feePayerKeypair)
+      return transaction
+    }
+    await postVaaSolana(
+      connection,
+      signTransaction,
+      SOL_BRIDGE_ADDRESS,
+      feePayerAddress,
+      vaaBytes
+    )
+    const transaction = await redeemOnSolana(
+      connection,
+      SOL_BRIDGE_ADDRESS,
+      SOL_TOKEN_BRIDGE_ADDRESS,
+      feePayerAddress,
+      vaaBytes
+    )
+    console.log({ transaction })
+
+    const signed = await signTransaction(transaction)
+    console.log({ signed })
+
+    const txid = await connection.sendRawTransaction(signed.serialize())
+    console.log({ txid })
+
+    await connection.confirmTransaction(txid)
+    console.log('Success!')
+  } catch (e) {
+    console.error(e)
+    console.log(`Error: ${e.message}`)
+  }
+}
+if (require && require.main === module) {
+  run()
+}
+
+module.exports = {
+  transferCommunityRewardsToSolana: run
+}

package/scripts/ipfs.sh

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+API_PORT=6001
+SWARM_PORT=6002
+CONTAINER_NAME=local_ipfs_node
+IPFS_RELEASE_VERSION=ipfs/go-ipfs:v0.8.0
+
+if [[ "$1" =~ ^up|down$ ]]; then
+  echo "Local ipfs operations:"
+else
+  echo "Must be a valid command - ./scripts/ipfs.sh <up|down>"
+  exit 1
+fi
+
+if [[ "$1" == 'up' ]]; then
+  if [[ -z "$2" ]]; then
+  echo "Format - ./scripts/ipfs.sh up <serviceName> <apiPort> <swarmPort> <gatewayPort (optional)>"
+  exit 1
+  else
+    CONTAINER_NAME=$2
+  fi
+
+  if [[ -z "$3" ]]; then
+  echo "Using default apiPort - $API_PORT"
+  echo "Format - ./scripts/ipfs.sh up <serviceName> <apiPort> <swarmPort> <gatewayPort (optional)>"
+  else
+    API_PORT=$3
+  fi
+
+  if [[ -z "$4" ]]; then
+  echo "Using default swarmPort - $SWARM_PORT"
+  echo "Format - ./scripts/ipfs.sh up <serviceName> <apiPort> <swarmPort> <gatewayPort (optional)>"
+  else
+    SWARM_PORT=$4
+  fi
+
+  # Pull image
+  docker pull $IPFS_RELEASE_VERSION
+
+
+  if [[ -z "$5" ]]; then
+    docker run -d --name $CONTAINER_NAME -p 127.0.0.1:$API_PORT:5001 -p 127.0.0.1:$SWARM_PORT:4001 --network=audius_dev $IPFS_RELEASE_VERSION daemon
+  else
+    GATEWAY_PORT=$5
+    docker run -d --name $CONTAINER_NAME -p 127.0.0.1:$API_PORT:5001 -p 127.0.0.1:$SWARM_PORT:4001 -p 127.0.0.1:$GATEWAY_PORT:8080 --network=audius_dev $IPFS_RELEASE_VERSION daemon
+  fi
+
+elif [[ "$1" == 'down' ]]; then
+  if [[ -z "$2" ]]; then
+  echo "Format - ./scripts/ipfs.sh up <serviceName> <apiPort> <swarmPort> <gatewayPort (optional)>"
+  exit 1
+  else
+    CONTAINER_NAME=$2
+  fi
+  docker stop $CONTAINER_NAME
+  docker rm $CONTAINER_NAME
+fi
+

package/scripts/migrate_contracts.sh

@@ -0,0 +1,25 @@
+# COPY DATA CONTRACTS
+if [ -d "../contracts/build/contracts" ]
+then
+  echo "Audius contracts repo is present"
+  cd ../contracts/
+  echo "Writing contracts config files"
+  node_modules/.bin/truffle exec scripts/migrate-contracts.js
+else
+  echo "INCORRECT REPOSITORY STRUCTURE. PLEASE FOLLOW README"
+  exit 1
+fi
+
+# COPY ETH CONTRACTS
+if [ -d "../eth-contracts/build/contracts" ]
+then
+  echo "Audius eth-contracts repo is present"
+  cd ../eth-contracts/
+  echo "Writing eth-contracts config files"
+  node_modules/.bin/truffle exec scripts/migrate-contracts.js
+  cp ../libs/scripts/AudiusClaimDistributor.json ../libs/eth-contracts/ABIs/AudiusClaimDistributor.json
+  cp ../libs/scripts/Wormhole.json ../libs/eth-contracts/ABIs/Wormhole.json
+else
+  echo "INCORRECT REPOSITORY STRUCTURE. PLEASE FOLLOW README"
+  exit 1
+fi

package/scripts/reset.sh

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+
+set -e
+set -o xtrace
+
+##### INIT DATA CONTRACTS #####
+
+if [ -d "../contracts" ]
+then
+  echo "Audius contracts repo is present"
+  cd ../contracts/
+else
+  echo "INCORRECT REPOSITORY STRUCTURE. PLEASE FOLLOW README"
+  exit 1
+fi
+
+rm -rf ./build/
+
+# not problematic for this to fail
+set +e
+npm run ganache-q
+set -e
+
+npm run ganache
+npm run truffle-migrate
+
+
+##### INIT ETH CONTRACTS #####
+
+if [ -d "../eth-contracts" ]
+then
+  echo "Audius eth-contracts repo is present"
+  cd ../eth-contracts/
+else
+  echo "INCORRECT REPOSITORY STRUCTURE. PLEASE FOLLOW README"
+  exit 1
+fi
+
+rm -rf ./build/
+
+# not problematic for this to fail
+set +e
+npm run ganache-q
+set -e
+
+npm run ganache
+npm run truffle-migrate
+
+cd ../libs/
+
+# Migrate data & eth contracts
+# - Copy contracts build dir + create config files
+# - Data contracts config: registry contract & owner wallet addresses
+# - Eth contracts config: AudiusToken contract, registry contract and owner wallet addresses
+sh ./scripts/migrate_contracts.sh
+
+#### RUN TESTS #####
+
+# printf '\nSTART tests:\n\n'
+#./node_modules/.bin/mocha tests/index.js
+
+# run linter
+# node_modules/.bin/standard
+
+# intentionally does not bring down containers