All files / src storage.js

91.48% Statements 43/47
68.75% Branches 11/16
92.3% Functions 12/13
91.48% Lines 43/47

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259                                                13x 13x     8x             8x 8x           1x 2x 2x   2x   2x   2x       1x 1x 1x 1x       1x 1x   1x                             4x 4x 1x     4x                                             4x                                 1x 1x 1x   1x                                                           1x                       5x 5x 1x     5x 5x   5x                                                                   5x   5x 5x                             1x 1x 1x     1x                           1x 1x                
/*
 * Flow JS Testing
 *
 * Copyright 2020-2023 Dapper Labs, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
import {getAccountAddress} from "./account"
import {executeScript} from "./interaction"
import {isAddress, parsePath} from "./utils"
 
// Helpers
function createSet(acc, pathStruct) {
  acc.add(pathStruct.identifier)
  return acc
}
function reduceToSet(arr) {
  return arr.reduce(createSet, new Set())
}
function reduceToUniqueArray(arr) {
  const set = reduceToSet(arr)
  return Array.from(set)
}
function reduceValues(arr, useSet) {
  if (useSet) {
    return reduceToSet(arr)
  }
 
  return reduceToUniqueArray(arr)
}
function formatReferences(paths) {
  return Object.keys(paths).reduce((acc, path) => {
    const {slot} = parsePath(path)
    const value = paths[path].type.type
 
    value.fullType = value.typeID
 
    acc[slot] = value
 
    return acc
  }, {})
}
function formatStorage(paths) {
  return Object.keys(paths).reduce((acc, path) => {
    const {slot} = parsePath(path)
    acc[slot] = paths[path]
    return acc
  }, {})
}
function processValues(result) {
  const publicPaths = formatReferences(result.publicPaths)
  const storagePaths = formatStorage(result.storagePaths)
 
  return {publicPaths, storagePaths}
}
 
/**
 * Retrieves information about the public and storage paths for a given account.
 *
 * @async
 * @param {string} account - The address or the name of the account to retrieve path information for.
 * @param {boolean} [useSet=true] - Whether to return array or Set
 * @returns {Promise<{
 *   publicPaths: string[] | Set<string>,
 *   storagePaths: string[] | Set<string>
 * }>} An object containing arrays or Sets of the public and storage paths for the account.
 */
export async function getPaths(account, useSet = true) {
  let accountAddress = account
  if (!isAddress(accountAddress)) {
    accountAddress = await getAccountAddress(account)
  }
 
  const [result] = await executeScript({
    code: `
      access(all) struct PathInfo{
        access(all) let public: &[PublicPath]
        access(all) let storage: &[StoragePath]
        
        init(public: &[PublicPath], storage: &[StoragePath]){
          self.public = public
          self.storage = storage
        }
      }
      access(all) fun main(address: Address): PathInfo{
        let account = getAccount(address)
        let info = PathInfo(
          public: account.storage.publicPaths, 
          storage: account.storage.storagePaths
        )
        return info
      }
    `,
    args: [accountAddress],
  })
 
  return {
    publicPaths: reduceValues(result.public, useSet),
    storagePaths: reduceValues(result.storage, useSet),
  }
}
 
/**
 * Retrieves public and storage paths for a given account with extra information available on them
 *
 * @async
 * @param {string} account - The address of the account to retrieve path information for.
 * @returns {Promise<{
 *   publicPaths: {[key: string]: {[key: string]: any}},
 *   storagePaths: {[key: string]: {[key: string]: any}}
 * }>} An object containing objects with the types of the public and storage paths for the account.
 */
export async function getPathsWithType(account) {
  let accountAddress = account
  if (!isAddress(accountAddress)) {
    accountAddress = await getAccountAddress(account)
  }
  const [result] = await executeScript({
    code: `
      access(all) fun main(address: Address): {String: {String: AnyStruct}} {
        let account = getAccount(address)
        var res: {String: {String: AnyStruct}} = {}
               
        // Iterate over public
        let public: {String: AnyStruct} = {}
        account.storage.forEachPublic(fun (path:PublicPath, type: Type): Bool{
          public[path.toString()] = type
          return true
        })
        
        
        // Iterate over storage paths
        let storage: {String: AnyStruct} = {}
        account.storage.forEachStored(fun (path:StoragePath, type: Type): Bool{
          storage[path.toString()] = type
          return true
        })
        
        res["publicPaths"] = public
        res["storagePaths"] = storage
        
        return res
      }
    `,
    args: [accountAddress],
  })
 
  return processValues(result)
}
 
/**
 * Retrieves the storage value at a given path for a given account.
 *
 * @async
 * @param {string} account - The address or name of the account to retrieve the storage value from.
 * @param {string} path - The path of the storage value to retrieve.
 * @returns {Promise<any>} The value of the storage at the given path, or `null` if no value is found.
 */
export async function getStorageValue(account, path) {
  let accountAddress = account
  if (!isAddress(accountAddress)) {
    accountAddress = await getAccountAddress(account)
  }
 
  let fixedPath = path.startsWith("/") ? path.slice(1) : path
  let storagePath = `/storage/${fixedPath}`
  // TODO I am unsure whether this is correct for MetadataViews/ViewResolver in V2 standard
  const code = `
    import MetadataViews from 0x1
    import ViewResolver from 0x1
    
    access(all) fun main(address: Address, path: StoragePath): AnyStruct{
      let account = getAuthAccount< auth(BorrowValue) &Account>(address)
      
      if let valueType = account.storage.type(at: path) {
        if(valueType.isSubtype(of: Type<@AnyResource>())){
          let obj = account.storage.borrow< &AnyResource >(from: path)!
          let meta = obj as? &{ViewResolver.ResolverCollection}
        
          if let idList = meta?.getIDs(){
            if(idList.length > 0){
              let res: {UInt64: AnyStruct} = {}
            
              for id in idList {
                res[id] = meta!.borrowViewResolver(id: id)!.resolveView(Type<MetadataViews.Display>())!
              }
              return res
            }
          }
          
          let value = account.storage.borrow< &AnyResource >(from: path)! as AnyStruct
          return value  
        }
        
        let value = account.storage.borrow< &AnyStruct >(from: path)! as AnyStruct
        return value  
      }
      
      return nil
    }
  `
  const args = [accountAddress, storagePath]
 
  const [values] = await executeScript({code, args})
  return values
}
 
/**
 * Retrieves the storage statistics (used and capacity) for a given account.
 *
 * @async
 * @param {string} address - The address of the account to retrieve storage statistics for.
 * @param {boolean} [convert=true] - Whether to convert the returned statistics from `UInt64` to `number`.
 * @returns {Promise<{
 *   used: number | string,
 *   capacity: number | string
 * }>} An object containing the used and capacity storage statistics for the account.
 */
export async function getStorageStats(address, convert = true) {
  let accountAddress = address
  if (!isAddress(accountAddress)) {
    accountAddress = await getAccountAddress(address)
  }
 
  const [result] = await executeScript({
    code: `
      access(all) fun main(address: Address): {String: UInt64} {
        let account = getAccount(address)
        
        return {
          "used": account.storage.used,
          "capacity": account.storage.capacity
        }
      }
    `,
    args: [accountAddress],
  })
 
  if (convert) {
    return {
      used: parseInt(result.used),
      capacity: parseInt(result.capacity),
    }
  }
 
  return result
}