Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShdwDrive

Hierarchy

  • ShdwDrive

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ShdwDrive(connection: Connection, wallet: any): ShdwDrive

  • Parameters

    • connection: Connection

      connection - initialized web3 connection object

    • wallet: any

      Web3 wallet

    Returns ShdwDrive

Properties

addStorage

addStorage: (key: PublicKey, size: string, priorityFee?: number) => Promise<ShadowDriveResponse> = addStorage

Type declaration

    • Parameters

      • key: PublicKey

        Public Key of the existing storage to increase size on

      • size: string

        Amount of storage you are requesting to add to your storage account. Should be in a string like '1KB', '1MB', '1GB'. Only KB, MB, and GB storage delineations are supported currently.

      • priorityFee: number = 100000

      Returns Promise<ShadowDriveResponse>

      Confirmed transaction ID

cancelDeleteStorageAccount

cancelDeleteStorageAccount: (key: PublicKey, priorityFee?: number) => Promise<{ txid: string }> = cancelDeleteStorageAccount

Type declaration

    • (key: PublicKey, priorityFee?: number): Promise<{ txid: string }>

    • Parameters

      • key: PublicKey

        Publickey of a Storage Account

      • priorityFee: number = 100000

      Returns Promise<{ txid: string }>

      • Confirmed transaction ID

claimStake

claimStake: (key: PublicKey, priorityFee?: number) => Promise<{ txid: string }> = claimStake

Type declaration

    • (key: PublicKey, priorityFee?: number): Promise<{ txid: string }>

    • Parameters

      • key: PublicKey

        PublicKey of a Storage Account

      • priorityFee: number = 100000

      Returns Promise<{ txid: string }>

      • Confirmed transaction ID

createStorageAccount

createStorageAccount: (name: string, size: string, priorityFee?: number) => Promise<CreateStorageResponse> = createStorageAccount

Type declaration

    • Parameters

      • name: string

        What you want your storage account to be named. (Does not have to be unique)

      • size: string

        Amount of storage you are requesting to create. Should be in a string like '1KB', '1MB', '1GB'. Only KB, MB, and GB storage delineations are supported currently.

      • priorityFee: number = 100000

      Returns Promise<CreateStorageResponse>

      Created bucket and transaction signature

deleteFile

deleteFile: (key: PublicKey, url: string) => Promise<ShadowDriveResponse> = deleteFile

Type declaration

    • Parameters

      • key: PublicKey

        Publickey of Storage Account

      • url: string

        Shadow Drive URL of the file you are requesting to delete.

      Returns Promise<ShadowDriveResponse>

      • Confirmed transaction ID

deleteStorageAccount

deleteStorageAccount: (key: PublicKey, priorityFee?: number) => Promise<{ txid: string }> = deleteStorageAccount

Type declaration

    • (key: PublicKey, priorityFee?: number): Promise<{ txid: string }>

    • Parameters

      • key: PublicKey

        PublicKey of a StorageAccount

      • priorityFee: number = 100000

      Returns Promise<{ txid: string }>

      • Confirmed transaction ID

editFile

editFile: (key: PublicKey, data: File | ShadowFile) => Promise<ShadowUploadResponse> = editFile

Type declaration

    • Parameters

      • key: PublicKey

        Publickey of Storage Account.

      • data: File | ShadowFile

        File or ShadowFile object, file extensions should be included in the name property of ShadowFiles.

      Returns Promise<ShadowUploadResponse>

      File location and transaction signature.

getStorageAccount

getStorageAccount: (key: PublicKey) => Promise<{ account: StorageAccountV2; publicKey: web3.PublicKey }> = getStorageAcc

Type declaration

    • (key: PublicKey): Promise<{ account: StorageAccountV2; publicKey: web3.PublicKey }>

    • Get a single storage account for the current user

      Parameters

      • key: PublicKey

        Publickey of a Storage Account

      Returns Promise<{ account: StorageAccountV2; publicKey: web3.PublicKey }>

      • Requested Storage Account

getStorageAccountInfo

getStorageAccountInfo: (key: PublicKey) => Promise<StorageAccountInfo> = getStorageAccInfo

Type declaration

    • Get storage account details

      Parameters

      • key: PublicKey

        Publickey of a Storage Account

      Returns Promise<StorageAccountInfo>

      Storage Account

getStorageAccounts

getStorageAccounts: () => Promise<{ account: StorageAccountV2; publicKey: web3.PublicKey }[]> = getStorageAccs

Type declaration

    • Get all storage accounts for the current user

      Returns Promise<{ account: StorageAccountV2; publicKey: web3.PublicKey }[]>

      • List of storage accounts

listObjects

listObjects: (storageAccount: PublicKey) => Promise<ListObjectsResponse> = listObjects

Type declaration

makeStorageImmutable

makeStorageImmutable: (key: PublicKey, priorityFee?: number) => Promise<ShadowDriveResponse> = makeStorageImmutable

Type declaration

    • Parameters

      • key: PublicKey

        Publickey of a Storage Account

      • priorityFee: number = 100000

      Returns Promise<ShadowDriveResponse>

      • Confirmed transaction ID

migrate

migrate: (key: PublicKey) => Promise<{ step1_sig: string; step2_sig: string }> = migrate

Type declaration

    • (key: PublicKey): Promise<{ step1_sig: string; step2_sig: string }>

    • Parameters

      • key: PublicKey

        PublicKey of a Storage Account

      Returns Promise<{ step1_sig: string; step2_sig: string }>

      • Confirmed transaction ID

reduceStorage

reduceStorage: (key: PublicKey, size: string, priorityFee?: number) => Promise<ShadowDriveResponse> = reduceStorage

Type declaration

    • Parameters

      • key: PublicKey

        Publickey of a Storage Account

      • size: string

        Amount of storage you are requesting to reduce from your storage account. Should be in a string like '1KB', '1MB', '1GB'. Only KB, MB, and GB storage delineations are supported currently.

      • priorityFee: number = 100000

      Returns Promise<ShadowDriveResponse>

      • Confirmed transaction ID

refreshStake

refreshStake: (key: PublicKey, priorityFee?: number) => Promise<{ txid: string }> = refreshStake

Type declaration

    • (key: PublicKey, priorityFee?: number): Promise<{ txid: string }>

    • Parameters

      • key: PublicKey

        Public Key of the existing storage to increase size on

      • priorityFee: number = 100000

      Returns Promise<{ txid: string }>

      • confirmed transaction id

storageConfigPDA

storageConfigPDA: PublicKey

topUp

topUp: (key: PublicKey, amount: number, priorityFee?: number) => Promise<{ txid: string }> = topUp

Type declaration

    • (key: PublicKey, amount: number, priorityFee?: number): Promise<{ txid: string }>

    • Parameters

      • key: PublicKey

        Public Key of the existing storage account

      • amount: number

        amount of $SHDW to transfer to stake account

      • priorityFee: number = 100000

      Returns Promise<{ txid: string }>

      • confirmed transaction id

uploadFile

uploadFile: (key: PublicKey, data: File | ShadowFile, overwrite?: Boolean) => Promise<ShadowUploadResponse> = uploadFile

Type declaration

    • Parameters

      • key: PublicKey

        Publickey of Storage Account.

      • data: File | ShadowFile

        File or ShadowFile object, file extensions should be included in the name property of ShadowFiles.

      • overwrite: Boolean = false

        If true, overwrites if existing. Default is false.

      Returns Promise<ShadowUploadResponse>

      File location and transaction signature.

uploadMultipleFiles

uploadMultipleFiles: (key: PublicKey, data: FileList | ShadowFile[], concurrent?: number, overwrite?: Boolean, callback?: Function) => Promise<ShadowBatchUploadResponse[]> = uploadMultipleFiles

Type declaration

    • Parameters

      • key: PublicKey

        Storage account PublicKey to upload the files to.

      • data: FileList | ShadowFile[]
      • concurrent: number = 3

        Number of files to concurrently upload. Default: 3

      • overwrite: Boolean = false

        If true, overwrites if existing. Default is false.

      • Optional callback: Function

        Callback function for every batch of files uploaded. A number will be passed into the callback like callback(num) indicating the number of files that were confirmed in that specific batch.

      Returns Promise<ShadowBatchUploadResponse[]>

      • File names, locations and transaction signatures for uploaded files.

userInfo

userInfo: PublicKey

Methods

init

Generated using TypeDoc