Class: OffChainListBase

Properties overview

• root: Field = Field; ↗
• Overrides: Struct({
  / The root hash of the Merkle tree representing the whitelist. /
  root: Field,
  }).empty ↗

Methods overview

• getValue() ↗
• isNone() ↗
• isSome() ↗
• load() ↗
• toString() ↗
• create() ↗
• empty() ↗
• fromString() ↗

Defined in: packages/storage/src/whitelist/offchain-map.ts:42

Base class for offchain lists and maps that does not have storage

Extends

• {
  root: Field;
  }

Constructors

new OffChainListBase()

new OffChainListBase(value: {
  root: Field;
 }): OffChainListBase

Defined in: node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103

Parameters

value

root

Field = Field

The root hash of the Merkle tree representing the whitelist.

Returns

OffChainListBase

Inherited from

Struct({
  / The root hash of the Merkle tree representing the whitelist. /
  root: Field,
}).constructor

Properties

root

root: Field = Field;

Defined in: packages/storage/src/whitelist/offchain-map.ts:44

The root hash of the Merkle tree representing the whitelist.

Inherited from

Struct({
  / The root hash of the Merkle tree representing the whitelist. /
  root: Field,
}).root

Methods

getValue()

getValue(
   key: Field, 
   storage: Storage, 
name: string): Promise<FieldOption>

Defined in: packages/storage/src/whitelist/offchain-map.ts:92

The function fetches a whitelisted amount associated with a given key using a map and returns it
as a FieldOption.

Parameters

key

Field

The key parameter is of type Field,
which represents a field element in the context of a cryptographic system.

storage

Storage

name

string = "offchain-map"

Returns

Promise<FieldOption>

The getValue function returns a Promise that resolves to a FieldOption
object. This object contains a value property representing the amount retrieved from a map based
on the provided key. The isSome property indicates whether the value is present or not.
The value is not present if the list is NOT empty and the key is NOT in the map.
The value is present if the list IS empty or the key IS in the map.
The value is present and equals to Field(0) if the list IS empty.

isNone()

isNone(): Bool

Defined in: packages/storage/src/whitelist/offchain-map.ts:46

Returns

Bool

isSome()

isSome(): Bool

Defined in: packages/storage/src/whitelist/offchain-map.ts:50

Returns

Bool

load()

load(storage: Storage, name: string): Promise<OffchainMapOption>

Defined in: packages/storage/src/whitelist/offchain-map.ts:54

Parameters

storage

Storage

name

string = "offchain-map"

Returns

Promise<OffchainMapOption>

toString()

toString(): string

Defined in: packages/storage/src/whitelist/offchain-map.ts:165

Returns a string representation of an object.

Returns

string

create()

static create(params: {
  data: object;
  list:   | OffChainMapEntry[]
     | {
     key: string;
     value: number;
    }[];
  name: string;
 }): Promise<{
  json: OffchainMapSerialized;
  listBase: OffChainListBase;
}>

Defined in: packages/storage/src/whitelist/offchain-map.ts:119

Creates a new OffchainListBase

Parameters

params

The parameters for creating the list.

data

object

The JSON data that should be added to the IPFS storage that represent the initial data

list

| OffChainMapEntry[]
| {
key: string;
value: number;
}[]

The list of entries to be added to the map.

name

string

Returns

Promise<{
json: OffchainMapSerialized;
listBase: OffChainListBase;
}>

A new OffChainList instance.

empty()

static empty(): OffChainListBase

Defined in: packages/storage/src/whitelist/offchain-map.ts:106

Returns

OffChainListBase

Overrides

Struct({
  / The root hash of the Merkle tree representing the whitelist. /
  root: Field,
}).empty

fromString()

static fromString(str: string): OffChainListBase

Defined in: packages/storage/src/whitelist/offchain-map.ts:169

Parameters

str

string

Returns

OffChainListBase