-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(wip): improve documentation structure of _erc725.js_
- Loading branch information
Showing
2 changed files
with
172 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Examples | ||
|
|
||
| - Fetch data from smart contracts + decode in one go! | ||
|
|
||
| - Create basic schemas | ||
|
|
||
| - Encode / Decode Links to external sources (`VerifiableURI`) | ||
|
|
||
| - Map infos to specific addresses or identifiers | ||
|
|
||
| - Using Dynamic Keys | ||
|
|
||
| - Create Lists with keyType Arrays | ||
|
|
||
| - Adding | ||
| - Deleting | ||
| - Updating | ||
|
|
||
| - Store multiple infos under one data key with tuples | ||
|
|
||
| - Use `CompactBytesArray` for efficient storing + retrieval |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| # Overview | ||
|
|
||
| ## Types | ||
|
|
||
| - ERC725JSONSchema, | ||
| - ERC725JSONSchemaKeyType, | ||
| - ERC725JSONSchemaValueContent, | ||
| - ERC725JSONSchemaValueType, | ||
| - Permissions, | ||
| - ERC725Config, | ||
| - KeyValuePair, | ||
| - ProviderTypes | ||
| - DynamicNameSchema | ||
| - DecodeDataInput, | ||
| - DecodeDataOutput, | ||
| - EncodeDataInput, | ||
| - FetchDataOutput, | ||
|
|
||
| _there is even more..._ | ||
|
|
||
| ## Encoding utilities | ||
|
|
||
| - encodeData | ||
| - encodeKey -> necessary? | ||
| - encodeKeyName | ||
| - encodeKeyValue | ||
| - encodeArrayKey | ||
| - encodeValueType, | ||
| - encodeValueContent, | ||
|
|
||
| ## Decoding utilities | ||
|
|
||
| - decodeData | ||
| - decodeKey | ||
| - decodeKeyPart | ||
| - decodeKeyValue | ||
| - decodeMappingKey | ||
| - decodeValueType, | ||
| - decodeValueContent, | ||
|
|
||
| ## Permissions utilities | ||
|
|
||
| - encodePermissions | ||
| - decodePermissions | ||
| - checkPermissions | ||
| - mapPermission -> Super useful! | ||
|
|
||
| ## Fetching data | ||
|
|
||
| - getDataFromExternalSources | ||
| - ERC725.getData | ||
| - ERC725.fetchData | ||
| - ERC725.getOwner | ||
| - ERC725.isValidSignature | ||
|
|
||
| **These to be discussed** | ||
|
|
||
| - getArrayValues | ||
| - getDataMultiple | ||
| - getData | ||
|
|
||
| ## External Data Source utilities (`VerifiableURI` and `JSONURI`) | ||
|
|
||
| - encodeDataSourceWithHash, | ||
| - decodeDataSourceWithHash, | ||
| - getVerificationMethod | ||
| - hashData | ||
| - isDataAuthentic | ||
|
|
||
| ## Schema utilities | ||
|
|
||
| - getSchema | ||
| - getSchemaElement | ||
| - getSchemaElementForDynamicKeyName | ||
| - validateSchemas | ||
| - generateSchemasFromDynamicKeys | ||
|
|
||
| ## Dynamic Keys utilities | ||
|
|
||
| - encodeDynamicKeyPart | ||
| - encodeDynamicMapping | ||
| - encodeDynamicMappingWithGrouping | ||
| - encodeDynamicKeyName | ||
| - generateDynamicKeyName | ||
| - isDynamicKeyPart | ||
| - isDynamicKeyName | ||
| - splitMultiDynamicKeyNamePart | ||
|
|
||
| ## Helpers | ||
|
|
||
| - convertIPFSGatewayUrl | ||
| - duplicateMultiTypeERC725SchemaEntry | ||
| - guessKeyTypeFromKeyName | ||
| - isValidUintSize | ||
| - isValidByteSize | ||
| - isValueContentLiteralHex | ||
| - isValid32ByteHexString | ||
|
|
||
| ## Tuple utilities | ||
|
|
||
| - encodeTupleKeyValue | ||
| - decodeTupleKeyValue | ||
| - isValidTuple | ||
|
|
||
| --- | ||
|
|
||
| These functions are not exported (yet!) | ||
|
|
||
| - validateSchemas | ||
| - duplicateMultiTypeERC725SchemaEntry | ||
| - convertIPFSGatewayUrl | ||
| - generateSchemasFromDynamicKeys | ||
| - encodeKeyValue | ||
| - guessKeyTypeFromKeyName -> can be renamed to `get`? | ||
| - encodeTupleKeyValue | ||
| - encodeKey -> necessary? | ||
| - isValidTuple | ||
| - decodeKeyValue | ||
| - getVerificationMethod | ||
| - hashData | ||
| - isDataAuthentic | ||
| - splitMultiDynamicKeyNamePart | ||
| - isValidUintSize | ||
| - isValidByteSize | ||
| - isValueContentLiteralHex | ||
| - getSchemaElementForDynamicKeyName | ||
| - getSchemaElement | ||
| - getArrayValues | ||
| - getDataMultiple | ||
| - getData | ||
| - encodeDynamicKeyPart | ||
| - encodeDynamicMapping | ||
| - encodeDynamicMappingWithGrouping | ||
| - encodeDynamicKeyName | ||
| - generateDynamicKeyName | ||
| - isValid32ByteHexString | ||
| - mapPermission -> Super useful! | ||
| - isDynamicKeyPart | ||
| - decodeKeyPart | ||
| - isValidTuple | ||
| - decodeTupleKeyValue -> strange we don't have `encodeTupleKeyValue` | ||
| - decodeKey | ||
|
|
||
| These types should be exported: | ||
|
|
||
| - DynamicNameSchema | ||
| - DecodeDataInput, | ||
| - DecodeDataOutput, | ||
| - EncodeDataInput, | ||
| - FetchDataOutput, | ||
| - there is even more... |