Class Document

Класс для управления и подписания документов с использованием WIF-ключа.

Example

const wifKey = "your-wif-private-key";
const docSigner = new Document(wifKey);

const generatedDoc: IGeneratedDocument = {
  full_title: "Пример документа",
  html: "<p>Это пример документа</p>",
  hash: "hash_of_document",
  meta: { author: "Автор документа" },
  binary: "binary_data"
};

const signedDoc = await docSigner.signDocument(generatedDoc);
console.log(signedDoc);

// Замена WIF-ключа
docSigner.setWif("new-wif-private-key");

Index

Constructors

constructor

Methods

setWif signDocument assertDocumentSignatures calculateDocumentHashes compareDocuments createUnsignedDocument finalize parse validateDocument validateSignature

Constructors

constructor

new Document(wifKey?): Document
Инициализация класса Document с WIF-ключом.
Parameters
- Optional wifKey: string
  WIF-ключ, используемый для подписи.
Returns Document
- Defined in components/sdk/src/classes/document/index.ts:35

Methods

setWif

setWif(wifKey): void
Замена текущего WIF-ключа на новый.
Parameters
- wifKey: string
  Новый WIF-ключ.
Returns void
- Defined in components/sdk/src/classes/document/index.ts:44

signDocument

signDocument(document, account, signatureId?, existingSignedDocuments?): Promise<{
    doc_hash: string;
    hash: string;
    meta: any;
    meta_hash: string;
    signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[];
    version: string;
}>
Подписывает документ и возвращает его в формате ISignedDocument.
Parameters
- document: IGeneratedDocument
  Сгенерированный документ для подписи.
- account: string
  Имя аккаунта подписывающего (signer)
- signatureId: number = 1
  ID подписи (обычно 1 для первой подписи)
- Optional existingSignedDocuments: {
      doc_hash: string;
      hash: string;
      meta: any;
      meta_hash: string;
      signatures: {
          id: number;
          is_valid?: null | boolean;
          meta: any;
          public_key: string;
          signature: string;
          signed_at: string;
          signed_hash: string;
          signer: string;
          signer_certificate?: null | {
              first_name: string;
              inn: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              first_name: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              inn: string;
              ogrn: string;
              represented_by: {
                  first_name: string;
                  last_name: string;
                  middle_name: string;
                  position: string;
              };
              short_name: string;
              type: AccountType;
              username: string;
          };
      }[];
      version: string;
  }[]
  Массив уже подписанных документов для объединения подписей
Returns Promise<{
    doc_hash: string;
    hash: string;
    meta: any;
    meta_hash: string;
    signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[];
    version: string;
}>
Подписанный документ.
- Defined in components/sdk/src/classes/document/index.ts:87

`Static` assertDocumentSignatures

assertDocumentSignatures(document, requiredSigners): void
Статический метод для валидации подписей документа по списку username. Проверяет наличие подписей от указанных пользователей и их валидность. Выбрасывает ошибку если валидация не прошла.
Parameters
- document: {
      doc_hash: string;
      hash: string;
      meta: any;
      meta_hash: string;
      signatures: {
          id: number;
          is_valid?: null | boolean;
          meta: any;
          public_key: string;
          signature: string;
          signed_at: string;
          signed_hash: string;
          signer: string;
          signer_certificate?: null | {
              first_name: string;
              inn: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              first_name: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              inn: string;
              ogrn: string;
              represented_by: {
                  first_name: string;
                  last_name: string;
                  middle_name: string;
                  position: string;
              };
              short_name: string;
              type: AccountType;
              username: string;
          };
      }[];
      version: string;
  }
  Подписанный документ для проверки
  - doc_hash: string
  - hash: string
  - meta: any
  - meta_hash: string
  - signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[]
  - version: string
- requiredSigners: string[]
  Массив username, чьи подписи должны присутствовать и быть валидными
Returns void
Throws
Error с описанием причины неудачи валидации

Example
```
try {
  Document.assertDocumentSignatures(signedDocument, ['user1', 'user2']);
  console.log('Все требуемые подписи присутствуют и валидны');
} catch (error) {
  console.error('Ошибка валидации:', error.message);
}
```
- Defined in components/sdk/src/classes/document/index.ts:427

`Static` calculateDocumentHashes

calculateDocumentHashes(meta, documentHash, signed_at, version?): Promise<{
    hash: string;
    meta_hash: string;
    signed_hash: string;
}>
Статический метод для вычисления хэшей документа. Вычисляет meta_hash, hash и signed_hash по актуальной логике в зависимости от версии.
Parameters
- meta: any
- documentHash: string
- signed_at: string
- version: string = '1.0.0'
Returns Promise<{
    hash: string;
    meta_hash: string;
    signed_hash: string;
}>
- Defined in components/sdk/src/classes/document/index.ts:60

`Static` compareDocuments

compareDocuments(signedDocument, generatedDocument, version?): Promise<{
    differences: Record<string, {
        actual: string;
        expected: string;
    }>;
    isValid: boolean;
}>
Статический метод для сверки подписанного и сгенерированного документов. Преобразует сгенерированный документ в неподписанную версию и сравнивает хэши. Поскольку хэши включают всю информацию о документе, достаточно сравнить только их.
Parameters
- signedDocument: {
      doc_hash: string;
      hash: string;
      meta: any;
      meta_hash: string;
      signatures: {
          id: number;
          is_valid?: null | boolean;
          meta: any;
          public_key: string;
          signature: string;
          signed_at: string;
          signed_hash: string;
          signer: string;
          signer_certificate?: null | {
              first_name: string;
              inn: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              first_name: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              inn: string;
              ogrn: string;
              represented_by: {
                  first_name: string;
                  last_name: string;
                  middle_name: string;
                  position: string;
              };
              short_name: string;
              type: AccountType;
              username: string;
          };
      }[];
      version: string;
  }
  Подписанный документ для сверки
  - doc_hash: string
  - hash: string
  - meta: any
  - meta_hash: string
  - signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[]
  - version: string
- generatedDocument: IGeneratedDocument
  Сгенерированный документ для сверки
- version: string = '1.0.0'
  Версия алгоритма расчета хэшей (по умолчанию '1.0.0')
Returns Promise<{
    differences: Record<string, {
        actual: string;
        expected: string;
    }>;
    isValid: boolean;
}>
Объект с результатами сверки по хэшам
Example
```
const signedDoc: ISignedDocument = { ... };
const generatedDoc: IGeneratedDocument = { ... };
const comparison = await Document.compareDocuments(signedDoc, generatedDoc);
if (comparison.isValid) {
  console.log('Документы совпадают');
} else {
  console.log('Различия:', comparison.differences);
}
```
- Defined in components/sdk/src/classes/document/index.ts:380

`Static` createUnsignedDocument

createUnsignedDocument(document, version?): Promise<{
    doc_hash: string;
    hash: string;
    meta: any;
    meta_hash: string;
    signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[];
    version: string;
}>
Статический метод для создания не подписанной версии документа из сгенерированного документа. Вычисляет все необходимые хэши, но не добавляет подписи. Полезно для сверки и сравнения документов.
Parameters
- document: IGeneratedDocument
  Сгенерированный документ для преобразования
- version: string = '1.0.0'
  Версия алгоритма расчета хэшей (по умолчанию '1.0.0')
Returns Promise<{
    doc_hash: string;
    hash: string;
    meta: any;
    meta_hash: string;
    signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[];
    version: string;
}>
Документ в формате ISignedDocument без подписей
Example
```
const generatedDoc: IGeneratedDocument = { ... };
const unsignedDoc = Document.createUnsignedDocument(generatedDoc);
console.log(unsignedDoc); // Документ без подписей для сверки
```
- Defined in components/sdk/src/classes/document/index.ts:335

`Static` finalize

finalize(document): IChainDocument2
Статический метод для преобразования подписанного документа в формат для блокчейна. Преобразует метаданные в строки JSON.
Parameters
- document: {
      doc_hash: string;
      hash: string;
      meta: any;
      meta_hash: string;
      signatures: {
          id: number;
          is_valid?: null | boolean;
          meta: any;
          public_key: string;
          signature: string;
          signed_at: string;
          signed_hash: string;
          signer: string;
          signer_certificate?: null | {
              first_name: string;
              inn: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              first_name: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              inn: string;
              ogrn: string;
              represented_by: {
                  first_name: string;
                  last_name: string;
                  middle_name: string;
                  position: string;
              };
              short_name: string;
              type: AccountType;
              username: string;
          };
      }[];
      version: string;
  }
  Подписанный документ для финализации
  - doc_hash: string
  - hash: string
  - meta: any
  - meta_hash: string
  - signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[]
  - version: string
Returns IChainDocument2
Документ в формате для отправки в блокчейн
- Defined in components/sdk/src/classes/document/index.ts:250

`Static` parse

parse(document): {
    doc_hash: string;
    hash: string;
    meta: any;
    meta_hash: string;
    signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[];
    version: string;
}
Статический метод для преобразования документа из формата блокчейна в стандартный формат. Преобразует строки JSON метаданных в объекты.
Parameters
- document: IChainDocument2
  Документ в формате блокчейна
Returns {
    doc_hash: string;
    hash: string;
    meta: any;
    meta_hash: string;
    signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[];
    version: string;
}
Стандартный подписанный документ
- doc_hash: string
- hash: string
- meta: any
- meta_hash: string
- signatures: {
      id: number;
      is_valid?: null | boolean;
      meta: any;
      public_key: string;
      signature: string;
      signed_at: string;
      signed_hash: string;
      signer: string;
      signer_certificate?: null | {
          first_name: string;
          inn: string;
          last_name: string;
          middle_name?: null | string;
          type: AccountType;
          username: string;
      } | {
          first_name: string;
          last_name: string;
          middle_name?: null | string;
          type: AccountType;
          username: string;
      } | {
          inn: string;
          ogrn: string;
          represented_by: {
              first_name: string;
              last_name: string;
              middle_name: string;
              position: string;
          };
          short_name: string;
          type: AccountType;
          username: string;
      };
  }[]
- version: string
- Defined in components/sdk/src/classes/document/index.ts:277

`Static` validateDocument

validateDocument(document): boolean
Статический метод для валидации подписанного документа. Проверяет корректность дат, подписей и их порядок.
Parameters
- document: {
      doc_hash: string;
      hash: string;
      meta: any;
      meta_hash: string;
      signatures: {
          id: number;
          is_valid?: null | boolean;
          meta: any;
          public_key: string;
          signature: string;
          signed_at: string;
          signed_hash: string;
          signer: string;
          signer_certificate?: null | {
              first_name: string;
              inn: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              first_name: string;
              last_name: string;
              middle_name?: null | string;
              type: AccountType;
              username: string;
          } | {
              inn: string;
              ogrn: string;
              represented_by: {
                  first_name: string;
                  last_name: string;
                  middle_name: string;
                  position: string;
              };
              short_name: string;
              type: AccountType;
              username: string;
          };
      }[];
      version: string;
  }
  Подписанный документ для проверки
  - doc_hash: string
  - hash: string
  - meta: any
  - meta_hash: string
  - signatures: {
        id: number;
        is_valid?: null | boolean;
        meta: any;
        public_key: string;
        signature: string;
        signed_at: string;
        signed_hash: string;
        signer: string;
        signer_certificate?: null | {
            first_name: string;
            inn: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            first_name: string;
            last_name: string;
            middle_name?: null | string;
            type: AccountType;
            username: string;
        } | {
            inn: string;
            ogrn: string;
            represented_by: {
                first_name: string;
                last_name: string;
                middle_name: string;
                position: string;
            };
            short_name: string;
            type: AccountType;
            username: string;
        };
    }[]
  - version: string
Returns boolean
true если документ валиден, иначе false
- Defined in components/sdk/src/classes/document/index.ts:203

`Static` validateSignature

validateSignature(signature): boolean
Статический метод для валидации отдельной подписи документа. Проверяет корректность даты и цифровой подписи.
Parameters
- signature: {
      id: number;
      is_valid?: null | boolean;
      meta: any;
      public_key: string;
      signature: string;
      signed_at: string;
      signed_hash: string;
      signer: string;
      signer_certificate?: null | {
          first_name: string;
          inn: string;
          last_name: string;
          middle_name?: null | string;
          type: AccountType;
          username: string;
      } | {
          first_name: string;
          last_name: string;
          middle_name?: null | string;
          type: AccountType;
          username: string;
      } | {
          inn: string;
          ogrn: string;
          represented_by: {
              first_name: string;
              last_name: string;
              middle_name: string;
              position: string;
          };
          short_name: string;
          type: AccountType;
          username: string;
      };
  }
  Информация о подписи для проверки
  - id: number
  - Optional is_valid?: null | boolean
  - meta: any
  - public_key: string
  - signature: string
  - signed_at: string
  - signed_hash: string
  - signer: string
  - Optional signer_certificate?: null | {
        first_name: string;
        inn: string;
        last_name: string;
        middle_name?: null | string;
        type: AccountType;
        username: string;
    } | {
        first_name: string;
        last_name: string;
        middle_name?: null | string;
        type: AccountType;
        username: string;
    } | {
        inn: string;
        ogrn: string;
        represented_by: {
            first_name: string;
            last_name: string;
            middle_name: string;
            position: string;
        };
        short_name: string;
        type: AccountType;
        username: string;
    }
    Сертификат подписанта (сокращенная информация)
Returns boolean
true если подпись валидна, иначе false
- Defined in components/sdk/src/classes/document/index.ts:304

Class Document

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Document

Methods

setWif

Parameters

Returns void

signDocument

Parameters

Static assertDocumentSignatures

Parameters

doc_hash: string

hash: string

meta: any

meta_hash: string

version: string

Returns void

Throws

Example

Static calculateDocumentHashes

Parameters

Returns Promise<{ hash: string; meta_hash: string; signed_hash: string; }>

Static compareDocuments

Parameters

doc_hash: string

hash: string

meta: any

meta_hash: string

version: string

Returns Promise<{ differences: Record<string, { actual: string; expected: string; }>; isValid: boolean; }>

Example

Static createUnsignedDocument

Parameters

Example

Static finalize

Parameters

doc_hash: string

hash: string

meta: any

meta_hash: string

version: string

Returns IChainDocument2

Static parse

Parameters

doc_hash: string

hash: string

meta: any

meta_hash: string

version: string

Static validateDocument

Parameters

doc_hash: string

hash: string

meta: any

meta_hash: string

version: string

Returns boolean

Static validateSignature

Parameters

id: number

Optional is_valid?: null | boolean

meta: any

public_key: string

signature: string

signed_at: string

signed_hash: string

signer: string

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Static` assertDocumentSignatures

`Static` calculateDocumentHashes

Returns Promise<{
hash: string;
meta_hash: string;
signed_hash: string;
}>

`Static` compareDocuments

Returns Promise<{
differences: Record<string, {
actual: string;
expected: string;
}>;
isValid: boolean;
}>

`Static` createUnsignedDocument

`Static` finalize

`Static` parse

`Static` validateDocument

`Static` validateSignature

`Optional` is_valid?: null | boolean