Key | Proofable Node SDK

Hierarchy

Message
- Key

Index

Type aliases

Properties

Methods

Type aliases

Static AsObject

AsObject: { key: Uint8Array | string; keySepList: Array<number> }

Type declaration

key: Uint8Array | string
keySepList: Array<number>

Static MessageArray

MessageArray: any[]

Static StaticToObject

StaticToObject: (includeInstance: boolean, msg: Message) => {}

Type declaration

- (includeInstance: boolean, msg: Message): {}
- Parameters
  - includeInstance: boolean
  - msg: Message
  Returns {}

Properties

Static extensions

extensions: {}

Type declaration

[key: number]: ExtensionFieldInfo<Message>

Static extensionsBinary

extensionsBinary: {}

Type declaration

[key: number]: ExtensionFieldBinaryInfo<Message>

Methods

addKeySep

addKeySep(value: number, index?: undefined | number): number

- Defined in src/protos/api/api_pb.d.ts:182
Parameters
- value: number
- Optional index: undefined | number
Returns number

clearKeySepList

clearKeySepList(): void

- Defined in src/protos/api/api_pb.d.ts:179
Returns void

clone

clone(): this

Inherited from Anchor.clone
- Defined in node_modules/@types/google-protobuf/index.d.ts:115
Returns this

cloneMessage

cloneMessage(): this

Inherited from Anchor.cloneMessage
- Defined in node_modules/@types/google-protobuf/index.d.ts:114
Returns this

getExtension

getExtension<T>(fieldInfo: ExtensionFieldInfo<T>): T

Inherited from Anchor.getExtension
- Defined in node_modules/@types/google-protobuf/index.d.ts:108
Type parameters
- T
Parameters
- fieldInfo: ExtensionFieldInfo<T>
Returns T

getJsPbMessageId

getJsPbMessageId(): undefined | string

Inherited from Anchor.getJsPbMessageId
- Defined in node_modules/@types/google-protobuf/index.d.ts:16
Returns undefined | string

getKey

getKey(): Uint8Array | string

- Defined in src/protos/api/api_pb.d.ts:174
Returns Uint8Array | string

getKeySepList

getKeySepList(): Array<number>

- Defined in src/protos/api/api_pb.d.ts:180
Returns Array<number>

getKey_asB64

getKey_asB64(): string

- Defined in src/protos/api/api_pb.d.ts:176
Returns string

getKey_asU8

getKey_asU8(): Uint8Array

- Defined in src/protos/api/api_pb.d.ts:175
Returns Uint8Array

readBinaryExtension

readBinaryExtension(proto: Message, reader: BinaryReader, extensions: {}, setExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>, val: T) => void): void

Inherited from Anchor.readBinaryExtension
- Defined in node_modules/@types/google-protobuf/index.d.ts:39
Parameters
- proto: Message
- reader: BinaryReader
- extensions: {}
  - [key: number]: ExtensionFieldBinaryInfo<Message>
- setExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>, val: T) => void
  - - <T>(fieldInfo: ExtensionFieldInfo<T>, val: T): void
    - Type parameters
      - T
      Parameters
      - fieldInfo: ExtensionFieldInfo<T>
      - val: T
      Returns void
Returns void

serializeBinary

serializeBinary(): Uint8Array

Overrides Message.serializeBinary
- Defined in src/protos/api/api_pb.d.ts:184
Returns Uint8Array

serializeBinaryExtensions

serializeBinaryExtensions(proto: Message, writer: BinaryWriter, extensions: {}, getExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>) => T): void

Inherited from Anchor.serializeBinaryExtensions
- Defined in node_modules/@types/google-protobuf/index.d.ts:34
Parameters
- proto: Message
- writer: BinaryWriter
- extensions: {}
  - [key: number]: ExtensionFieldBinaryInfo<Message>
- getExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>) => T
  - - <T>(fieldInfo: ExtensionFieldInfo<T>): T
    - Type parameters
      - T
      Parameters
      - fieldInfo: ExtensionFieldInfo<T>
      Returns T
Returns void

setExtension

setExtension<T>(fieldInfo: ExtensionFieldInfo<T>, value: T): void

Inherited from Anchor.setExtension
- Defined in node_modules/@types/google-protobuf/index.d.ts:109
Type parameters
- T
Parameters
- fieldInfo: ExtensionFieldInfo<T>
- value: T
Returns void

setKey

setKey(value: Uint8Array | string): void

- Defined in src/protos/api/api_pb.d.ts:177
Parameters
- value: Uint8Array | string
Returns void

setKeySepList

setKeySepList(value: Array<number>): void

- Defined in src/protos/api/api_pb.d.ts:181
Parameters
- value: Array<number>
Returns void

toArray

toArray(): Message.MessageArray

Inherited from Anchor.toArray
- Defined in node_modules/@types/google-protobuf/index.d.ts:106
Returns Message.MessageArray

toObject

toObject(includeInstance?: undefined | false | true): AsObject

Overrides Message.toObject
- Defined in src/protos/api/api_pb.d.ts:185
Parameters
- Optional includeInstance: undefined | false | true
Returns AsObject

toString

toString(): string

Inherited from Anchor.toString
- Defined in node_modules/@types/google-protobuf/index.d.ts:107
Returns string

Static addToRepeatedField

addToRepeatedField(msg: Message, fieldNumber: number, value: any, index?: undefined | number): void

Inherited from Anchor.addToRepeatedField
- Defined in node_modules/@types/google-protobuf/index.d.ts:62
Parameters
- msg: Message
- fieldNumber: number
- value: any
- Optional index: undefined | number
Returns void

Static addToRepeatedWrapperField

addToRepeatedWrapperField<T>(msg: Message, fieldNumber: number, value: T | undefined, ctor: { constructor: any }, index?: undefined | number): T

Inherited from Anchor.addToRepeatedWrapperField
- Defined in node_modules/@types/google-protobuf/index.d.ts:95
Type parameters
- T: Message
Parameters
- msg: Message
- fieldNumber: number
- value: T | undefined
- ctor: { constructor: any }
  - constructor: function
    - new __type(): T
    - Defined in node_modules/@types/google-protobuf/index.d.ts:99
      Returns T
- Optional index: undefined | number
Returns T

Static bytesAsB64

bytesAsB64(bytes: Uint8Array): string

Inherited from Anchor.bytesAsB64
- Defined in node_modules/@types/google-protobuf/index.d.ts:48
Parameters
- bytes: Uint8Array
Returns string

Static bytesAsU8

bytesAsU8(str: string): Uint8Array

Inherited from Anchor.bytesAsU8
- Defined in node_modules/@types/google-protobuf/index.d.ts:49
Parameters
- str: string
Returns Uint8Array

Static bytesListAsB64

bytesListAsB64(bytesList: Uint8Array[]): string[]

Inherited from Anchor.bytesListAsB64
- Defined in node_modules/@types/google-protobuf/index.d.ts:50
Parameters
- bytesList: Uint8Array[]
Returns string[]

Static bytesListAsU8

bytesListAsU8(strList: string[]): Uint8Array[]

Inherited from Anchor.bytesListAsU8
- Defined in node_modules/@types/google-protobuf/index.d.ts:51
Parameters
- strList: string[]
Returns Uint8Array[]

Static clone

clone<T>(msg: T): T

Inherited from Anchor.clone
- Defined in node_modules/@types/google-protobuf/index.d.ts:116
Type parameters
- T: Message
Parameters
- msg: T
Returns T

Static cloneMessage

cloneMessage<T>(msg: T): T

Inherited from Anchor.cloneMessage
- Defined in node_modules/@types/google-protobuf/index.d.ts:117
Type parameters
- T: Message
Parameters
- msg: T
Returns T

Static compareExtensions

compareExtensions(extension1: {}, extension2: {}): boolean

Inherited from Anchor.compareExtensions
- Defined in node_modules/@types/google-protobuf/index.d.ts:112
Parameters
- extension1: {}
- extension2: {}
Returns boolean

Static compareFields

compareFields(field1: any, field2: any): boolean

Inherited from Anchor.compareFields
- Defined in node_modules/@types/google-protobuf/index.d.ts:113
Parameters
- field1: any
- field2: any
Returns boolean

Static computeOneofCase

computeOneofCase(msg: Message, oneof: number[]): number

Inherited from Anchor.computeOneofCase
- Defined in node_modules/@types/google-protobuf/index.d.ts:72
Parameters
- msg: Message
- oneof: number[]
Returns number

Static copyInto

copyInto(fromMessage: Message, toMessage: Message): void

Inherited from Anchor.copyInto
- Defined in node_modules/@types/google-protobuf/index.d.ts:118
Parameters
- fromMessage: Message
- toMessage: Message
Returns void

Static deserializeBinary

deserializeBinary(bytes: Uint8Array): Key

Overrides Message.deserializeBinary
- Defined in src/protos/api/api_pb.d.ts:190
Parameters
- bytes: Uint8Array
Returns Key

Static deserializeBinaryFromReader

deserializeBinaryFromReader(message: Key, reader: BinaryReader): Key

Overrides Message.deserializeBinaryFromReader
- Defined in src/protos/api/api_pb.d.ts:191
Parameters
- message: Key
- reader: BinaryReader
Returns Key

Static difference

difference<T>(m1: T, m2: T): T

Inherited from Anchor.difference
- Defined in node_modules/@types/google-protobuf/index.d.ts:110
Type parameters
- T: Message
Parameters
- m1: T
- m2: T
Returns T

Static equals

equals(m1: Message, m2: Message): boolean

Inherited from Anchor.equals
- Defined in node_modules/@types/google-protobuf/index.d.ts:111
Parameters
- m1: Message
- m2: Message
Returns boolean

Static from

from(key: string, keyEncoding?: "utf8" | "hex"): Key

- Defined in src/api/client.ts:202
Parameters
- key: string
- Optional keyEncoding: "utf8" | "hex"
Returns Key

Static getField

getField(msg: Message, fieldNumber: number): FieldValue | null

Inherited from Anchor.getField
- Defined in node_modules/@types/google-protobuf/index.d.ts:45
Parameters
- msg: Message
- fieldNumber: number
Returns FieldValue | null

Static getFieldWithDefault

getFieldWithDefault<T>(msg: Message, fieldNumber: number, defaultValue: T): T

Inherited from Anchor.getFieldWithDefault
- Defined in node_modules/@types/google-protobuf/index.d.ts:52
Type parameters
- T
Parameters
- msg: Message
- fieldNumber: number
- defaultValue: T
Returns T

Static getMapField

getMapField(msg: Message, fieldNumber: number, noLazyCreate: boolean, valueCtor: typeof Message): Map<any, any>

Inherited from Anchor.getMapField
- Defined in node_modules/@types/google-protobuf/index.d.ts:53
Parameters
- msg: Message
- fieldNumber: number
- noLazyCreate: boolean
- valueCtor: typeof Message
Returns Map<any, any>

Static getOptionalFloatingPointField

getOptionalFloatingPointField(msg: Message, fieldNumber: number): number | undefined

Inherited from Anchor.getOptionalFloatingPointField
- Defined in node_modules/@types/google-protobuf/index.d.ts:46
Parameters
- msg: Message
- fieldNumber: number
Returns number | undefined

Static getRepeatedFloatingPointField

getRepeatedFloatingPointField(msg: Message, fieldNumber: number): number[]

Inherited from Anchor.getRepeatedFloatingPointField
- Defined in node_modules/@types/google-protobuf/index.d.ts:47
Parameters
- msg: Message
- fieldNumber: number
Returns number[]

Static getRepeatedWrapperField

getRepeatedWrapperField<T>(msg: Message, ctor: { constructor: any }, fieldNumber: number): T[]

Inherited from Anchor.getRepeatedWrapperField
- Defined in node_modules/@types/google-protobuf/index.d.ts:78
Type parameters
- T: Message
Parameters
- msg: Message
- ctor: { constructor: any }
  - constructor: function
    - new __type(): T
    - Defined in node_modules/@types/google-protobuf/index.d.ts:80
      Returns T
- fieldNumber: number
Returns T[]

Static getWrapperField

getWrapperField<T>(msg: Message, ctor: { constructor: any }, fieldNumber: number, required?: undefined | number): T

Inherited from Anchor.getWrapperField
- Defined in node_modules/@types/google-protobuf/index.d.ts:73
Type parameters
- T: Message
Parameters
- msg: Message
- ctor: { constructor: any }
  - constructor: function
    - new __type(): T
    - Defined in node_modules/@types/google-protobuf/index.d.ts:75
      Returns T
- fieldNumber: number
- Optional required: undefined | number
Returns T

Static initialize

initialize(msg: Message, data: Message.MessageArray, messageId: string | number, suggestedPivot: number, repeatedFields?: number[], oneofFields?: number[][] | null): void

Inherited from Anchor.initialize
- Defined in node_modules/@types/google-protobuf/index.d.ts:17
Parameters
- msg: Message
- data: Message.MessageArray
- messageId: string | number
- suggestedPivot: number
- Optional repeatedFields: number[]
- Optional oneofFields: number[][] | null
Returns void

Static registerMessageType

registerMessageType(id: number, constructor: typeof Message): void

Inherited from Anchor.registerMessageType
- Defined in node_modules/@types/google-protobuf/index.d.ts:119
Parameters
- id: number
- constructor: typeof Message
Returns void

Static serializeBinaryToWriter

serializeBinaryToWriter(message: Key, writer: BinaryWriter): void

Overrides Message.serializeBinaryToWriter
- Defined in src/protos/api/api_pb.d.ts:189
Parameters
- message: Key
- writer: BinaryWriter
Returns void

Static setField

setField(msg: Message, fieldNumber: number, value: FieldValue): void

Inherited from Anchor.setField
- Defined in node_modules/@types/google-protobuf/index.d.ts:58
Parameters
- msg: Message
- fieldNumber: number
- value: FieldValue
Returns void

Static setOneofField

setOneofField(msg: Message, fieldNumber: number, oneof: number[], value: FieldValue): void

Inherited from Anchor.setOneofField
- Defined in node_modules/@types/google-protobuf/index.d.ts:67
Parameters
- msg: Message
- fieldNumber: number
- oneof: number[]
- value: FieldValue
Returns void

Static setOneofWrapperField

setOneofWrapperField(msg: Message, fieldNumber: number, oneof: number[], value: any): void

Inherited from Anchor.setOneofWrapperField
- Defined in node_modules/@types/google-protobuf/index.d.ts:86
Parameters
- msg: Message
- fieldNumber: number
- oneof: number[]
- value: any
Returns void

Static setRepeatedWrapperField

setRepeatedWrapperField<T>(msg: Message, fieldNumber: number, value?: T[]): void

Inherited from Anchor.setRepeatedWrapperField
- Defined in node_modules/@types/google-protobuf/index.d.ts:91
Type parameters
- T: Message
Parameters
- msg: Message
- fieldNumber: number
- Optional value: T[]
Returns void

Static setWrapperField

setWrapperField<T>(msg: Message, fieldNumber: number, value?: undefined | Map<any, any> | T): void

Inherited from Anchor.setWrapperField
- Defined in node_modules/@types/google-protobuf/index.d.ts:82
Type parameters
- T: Message
Parameters
- msg: Message
- fieldNumber: number
- Optional value: undefined | Map<any, any> | T
Returns void

Static toMap

toMap(field: any[], mapKeyGetterFn: (field: any) => string, toObjectFn?: Message.StaticToObject, includeInstance?: undefined | false | true): void

Inherited from Anchor.toMap
- Defined in node_modules/@types/google-protobuf/index.d.ts:101
Parameters
- field: any[]
- mapKeyGetterFn: (field: any) => string
  - - (field: any): string
    - Parameters
      - field: any
      Returns string
- Optional toObjectFn: Message.StaticToObject
- Optional includeInstance: undefined | false | true
Returns void

Static toObject

toObject(includeInstance: boolean, msg: Key): AsObject

Overrides Message.toObject
- Defined in src/protos/api/api_pb.d.ts:186
Parameters
- includeInstance: boolean
- msg: Key
Returns AsObject

Static toObjectExtension

toObjectExtension(msg: Message, obj: {}, extensions: {}, getExtensionFn: (fieldInfo: ExtensionFieldInfo<Message>) => Message, includeInstance?: undefined | false | true): void

Inherited from Anchor.toObjectExtension
- Defined in node_modules/@types/google-protobuf/index.d.ts:28
Parameters
- msg: Message
- obj: {}
- extensions: {}
  - [key: number]: ExtensionFieldInfo<Message>
- getExtensionFn: (fieldInfo: ExtensionFieldInfo<Message>) => Message
  - - (fieldInfo: ExtensionFieldInfo<Message>): Message
    - Parameters
      - fieldInfo: ExtensionFieldInfo<Message>
      Returns Message
- Optional includeInstance: undefined | false | true
Returns void

Static toObjectList

toObjectList<T>(field: T[], toObjectFn: (includeInstance: boolean, data: T) => {}, includeInstance?: undefined | false | true): Array<{}>

Inherited from Anchor.toObjectList
- Defined in node_modules/@types/google-protobuf/index.d.ts:24
Type parameters
- T: Message
Parameters
- field: T[]
- toObjectFn: (includeInstance: boolean, data: T) => {}
  - - (includeInstance: boolean, data: T): {}
    - Parameters
      - includeInstance: boolean
      - data: T
      Returns {}
- Optional includeInstance: undefined | false | true
Returns Array<{}>

Hierarchy

Index

Type aliases

Properties

Methods

Type aliases

Static AsObject

Type declaration

key: Uint8Array | string

keySepList: Array<number>

Static MessageArray

Static StaticToObject

Type declaration

Parameters

includeInstance: boolean

msg: Message

Returns {}

Properties

Static extensions

Type declaration

[key: number]: ExtensionFieldInfo<Message>

Static extensionsBinary

Type declaration

[key: number]: ExtensionFieldBinaryInfo<Message>

Methods

addKeySep

Parameters

value: number

Optional index: undefined | number

Returns number

clearKeySepList

Returns void

clone

Returns this

cloneMessage

Returns this

getExtension

Type parameters

T

Parameters

fieldInfo: ExtensionFieldInfo<T>

Returns T

getJsPbMessageId

Returns undefined | string

getKey

Returns Uint8Array | string

getKeySepList

Returns Array<number>

getKey_asB64

Returns string

getKey_asU8

Returns Uint8Array

readBinaryExtension

Parameters

proto: Message

reader: BinaryReader

extensions: {}

[key: number]: ExtensionFieldBinaryInfo<Message>

setExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>, val: T) => void

Type parameters

T

Parameters

fieldInfo: ExtensionFieldInfo<T>

val: T

Returns void

Returns void

serializeBinary

Returns Uint8Array

serializeBinaryExtensions

Parameters

proto: Message

writer: BinaryWriter

extensions: {}

[key: number]: ExtensionFieldBinaryInfo<Message>

getExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>) => T

Type parameters

T

Parameters

fieldInfo: ExtensionFieldInfo<T>

Returns T