ARWEAVE

Index

Constructors

• constructor

Properties

• arweave

Methods

• balance
• pinFile
• pinString
• status
• wait

Constructors

constructor

• new ARWEAVE(key: string | object): ARWEAVE

• Parameters

  • key: string | object

  Returns ARWEAVE

Properties

arweave

arweave: default

Methods

publicbalance

• balance(): Promise<undefined | string>

• Returns Promise<undefined | string>

publicpinFile

• pinFile(data: Buffer, filename: string, size: number, mimeType: string, waitForConfirmation?: boolean): Promise<undefined | string>

• Parameters

  • data: Buffer

  • filename: string

  • size: number

  • mimeType: string

  • waitForConfirmation: boolean = false

  Returns Promise<undefined | string>

publicpinString

• pinString(data: string, waitForConfirmation?: boolean): Promise<undefined | string>

• Parameters

  • data: string

  • waitForConfirmation: boolean = false

  Returns Promise<undefined | string>

publicstatus

• status(hash: string): Promise<{ data: TransactionStatusResponse; error?: undefined; success: boolean } | { data?: undefined; error: unknown; success: boolean }>

• Parameters

  • hash: string

  Returns Promise<{ data: TransactionStatusResponse; error?: undefined; success: boolean } | { data?: undefined; error: unknown; success: boolean }>

publicwait

• wait(data: { hash: string; interval?: number; maxAttempts?: number; maxErrors?: number }): Promise<{ error?: string; result?: any; success: boolean }>

• Parameters

  • data: { hash: string; interval?: number; maxAttempts?: number; maxErrors?: number }

  Returns Promise<{ error?: string; result?: any; success: boolean }>