Class FSUploader

Uploads contracts from the local filesystem, with optional caching: if provided with an Uploads directory containing upload receipts, allows for uploaded contracts to be reused.

Hierarchy

Uploader
- FSUploader

Index

Constructors

constructor

new FSUploader(options?): FSUploader
Parameters
- options: Partial<Uploader> = {}
Returns FSUploader
Inherited from Uploader.constructor
- Defined in agent/agent-services.ts:118

Properties

`Optional` agent

agent?: Agent

Agent that will sign the upload transactions(s).

cache

cache: Record<string, Uploaded>

Map of code hash to Uploaded result.

id

id: string = 'FS'

Unique identifier of this uploader implementation.

log

log: UploadConsole = ...

reupload

reupload: boolean

If set, reuploads even if store is present.

store

store: JSONDirectory<UploadReceipt_v1> = ...

Directory with JSON files

`Static` variants

variants: Record<string, UploaderClass<Uploader>> = ...

Global registry of Uploader implementations. Populated downstream.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in fadroma-upload.ts:39

chain

get chain(): undefined | Chain
Chain to which this uploader uploads contracts.

Returns undefined | Chain
Inherited from Uploader.chain
- Defined in agent/agent-services.ts:126

Methods

`Protected` addCodeHash

addCodeHash(uploadable): void
Parameters
- uploadable: Partial<Uploadable & {
  name: string;
  }>
Returns void
- Defined in fadroma-upload.ts:87

`Protected` checkCodeHash

checkCodeHash(a, b): void
Parameters
- a: {
  artifact?: string | URL;
  codeHash?: string;
  }
  - Optional artifact?: string | URL
  - Optional codeHash?: string
- b: {
  codeHash?: string;
  }
  - Optional codeHash?: string
Returns void
Inherited from Uploader.checkCodeHash
- Defined in agent/agent-services.ts:200

`Protected` checkLocalCodeHash

checkLocalCodeHash(input, output): void
Panic if the code hash returned by the upload doesn't match the one specified in the Contract.
Parameters
- input: Uploadable & {
  codeHash: string;
  }
- output: Uploaded
Returns void
Inherited from Uploader.checkLocalCodeHash
- Defined in agent/agent-services.ts:216

`Protected` fetch

fetch(path): Promise<Uint8Array>
Parameters
- path: string | URL
Returns Promise<Uint8Array>
Overrides Uploader.fetch
- Defined in fadroma-upload.ts:97

`Protected` fetchSync

fetchSync(path): Uint8Array
Parameters
- path: string | URL
Returns Uint8Array
- Defined in fadroma-upload.ts:100

get

get(uploadable): undefined | Uploaded
Parameters
- uploadable: Uploadable
Returns undefined | Uploaded
Uploaded from the cache or store or undefined
Overrides Uploader.get
- Defined in fadroma-upload.ts:46

set

set(uploaded): FSUploader
Add an Uploaded to the cache and store.
Parameters
- uploaded: Uploaded
Returns FSUploader
Overrides Uploader.set
- Defined in fadroma-upload.ts:66

upload

upload(contract): Promise<Uploaded>
Upload an Uploadable (such as a Contract or Template).
Parameters
- contract: Uploadable & Partial<Uploaded>
Returns Promise<Uploaded>
Promise
Inherited from Uploader.upload
- Defined in agent/agent-services.ts:142

uploadMany

uploadMany(inputs): Promise<(null | Uploaded)[]>
Upload multiple contracts.
Parameters
- inputs: Uploadable[]
Returns Promise<(null | Uploaded)[]>
Inherited from Uploader.uploadMany
- Defined in agent/agent-services.ts:186

Class FSUploader

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Uploader> = {}

Returns FSUploader

Properties

Optional agent

cache

id

log

reupload

store

Static variants

Accessors

[toStringTag]

Returns string

chain

Returns undefined | Chain

Methods

Protected addCodeHash

Parameters

uploadable: Partial<Uploadable & { name: string; }>

Returns void

Protected checkCodeHash

Parameters

a: { artifact?: string | URL; codeHash?: string; }

Optional artifact?: string | URL

Optional codeHash?: string

b: { codeHash?: string; }

Optional codeHash?: string

Returns void

Protected checkLocalCodeHash

Parameters

input: Uploadable & { codeHash: string; }

output: Uploaded

Returns void

Protected fetch

Parameters

path: string | URL

Returns Promise<Uint8Array>

Protected fetchSync

Parameters

path: string | URL

Returns Uint8Array

get

Parameters

uploadable: Uploadable

Returns undefined | Uploaded

set

Parameters

uploaded: Uploaded

Returns FSUploader

upload

Parameters

contract: Uploadable & Partial<Uploaded>

Returns Promise<Uploaded>

uploadMany

Parameters

inputs: Uploadable[]

Returns Promise<(null | Uploaded)[]>

Settings

Member Visibility

Theme

On This Page

`Optional` agent

`Static` variants

`Protected` addCodeHash

uploadable: Partial<Uploadable & {
name: string;
}>

`Protected` checkCodeHash

a: {
artifact?: string | URL;
codeHash?: string;
}

`Optional` artifact?: string | URL

`Optional` codeHash?: string

b: {
codeHash?: string;
}

`Optional` codeHash?: string

`Protected` checkLocalCodeHash

input: Uploadable & {
codeHash: string;
}

`Protected` fetch

`Protected` fetchSync