Social Interactions
NEAR components can natively communicate with the SocialDB smart contract (currently deployed at social.near).
The SocialDB is a contract that stores key-value pairs, and is used mostly to store social-related data, such as posts, likes, or profiles.
Besides user data, the SocialDB contract stores all existing NEAR components.
Social.get
Social.get queries a key from the SocialDB contract and returns the data. The key being queried can contain wildcards.
For example:
alice.near/profile/**will match the entire profile data of account alice.near.alice.near/profile/*will match all the fields of the profile, but not the nested objects.alice.near/profile/namewill match only the name field of the profile.*/widget/*will match all the widgets of all the accounts.
Parameters
| param | 필수 여부 | type | 설명 |
|---|---|---|---|
patterns | required | string / string[] | 경로 패턴 |
finality | 선택사항 | "final" / 숫자 | 블록 높이 또는 완결성 |
options | 선택사항 | 객체 | options 객체입니다. |
subscribe(선택 사항): true이면 데이터가 5초마다 새로 고쳐집니다.return_deleted(선택 사항): 삭제된 값을 (null로) 반환할지 여부를 나타냅니다. 기본값은false입니다.
The block height or finality can be used to get the data at a specific block height or finality.
If the block height or finality is not specified, the data will be fetched at the optimistic finality (the latest block height).
For block height and finality final, instead of calling the NEAR RPC directly, the VM uses the Social API Server to fetch the data.
Social API server indexes the data for SocialDB and allows to fetch the data at any block height with additional options.
It also allows returning more data than an RPC call because it's not restricted by the gas limit. In general, the API server also serves data faster than the NEAR RPC, because it doesn't execute the contract code in a virtual machine.
While the data is fetching, Social.get returns null.
Social.getr
Social.getr은 Social.get의 래퍼 헬퍼일 뿐이며, 각 경로 패턴에 **를 추가합니다.
Parameters
| param | 필수 여부 | type | 설명 |
|---|---|---|---|
patterns | required | string / string[] | 경로 패턴 |
finality | 선택사항 | "final" / 숫자 | 블록 높이 또는 완결성 |
options | 선택사항 | 객체 | options 객체 |
subscribe(선택 사항): true이면 데이터가 5초마다 새로 고쳐집니다.return_deleted(선택 사항): 삭제된 값을 (null로) 반환할지 여부를 나타냅니다. 기본값은false입니다.
Social.keys
The keys method allows to get the list of keys that match a pattern. It's useful for querying the data without reading values.
It also has an additional options field that can be used to specify the return type and whether to return deleted keys.
Parameters
Social.key는 최대 3개의 인수를 사용합니다:
| param | 필수 여부 | type | 설명 |
|---|---|---|---|
patterns | required | string / string[] | 경로 패턴 |
finality | 선택사항 | "final" / 숫자 | 블록 높이 또는 완결성 |
options | 선택사항 | 객체 | options 객체 |
subscribe(선택 사항): true이면 데이터가 5초마다 새로 고쳐집니다.return_type(선택 사항):"History","True"또는"Block Height"중 하나입니다. 지정하지 않으면"True"가 반환됩니다.return_deleted(선택 사항): 삭제된 값을 (null로) 반환할지 여부를 나타냅니다. 기본값은false입니다.values_only(선택 사항): 값만 반환할지 여부입니다(객체는 포함하지 않음). 기본값은false입니다.
Social API 서버는 사용자 지정 옵션 return_type: "History"를 지원합니다. 각 일치 키에 대해 값이 오름차순으로 변경되었을 때 모든 블록 높이가 포함된 배열을 반환합니다.
값을 덮어쓰는 피드를 만드는 데 사용할 수 있습니다.
Social.set
data 객체를 가져와 SocialDB에 커밋합니다. The data object can contain multiple keys, and each key can contain multiple values.
Importantly, a user can only commit to their own space in SocialDB (e.g. alice.near can only write in alice.near/**), except if given explicit permission by the owner of another space.
Each time a user wants to commit data, they will be prompted to confirm the action. On confirming, the user can choose to not be asked again in the future.
Parameters
Social.index 인자:
| param | 필수 여부 | type | 설명 |
|---|---|---|---|
data | required | 객체 | 커밋될 데이터 객체 입니다. CommitButton과 마찬가지로 계정 ID로 시작하면 안 됩니다. |
options | 선택사항 | 객체 | options 객체 |
force(선택 사항): 데이터를 덮어쓸지 여부를 의미합니다.onCommit(선택 사항): 성공적인 커밋에서 트리거하는 함수입니다. 작성된 데이터(accountID포함)를 전달합니다.onCancel(선택 사항): 사용자가 커밋을 취소할 때 트리거하는 함수입니다.
By default Social.set will omit saving data that is already saved (e.g. if the user already liked a post, it won't save the like again). To force saving the data, pass the force option.
Social.index
NEAR Social readily provides an indexer - a service that listen to actions in SocialDB, and caches them so they can be retrieved without needing to interact with the contract.
The indexer is very useful, for example, to rapidly store and retrieve information on all comments for a post. Without the indexer, we would need to check all entries in the contract to see who answered, surely running out of GAS before completion.
Indexing an Action
To index an action we need to add the index key to the data being saved, within the index key we will save the action being indexed, alongside a key and a value that identifies this specific instance.
In the example above we index a docs action. In this case the action is docs, and the key that identifies it is "read".
Standards
Indexing a Post
To index a post, the standard is to save the action post, with {key: "main", value: {type: "md"}.
{
index: {
post: JSON.stringify({
key: "main",
value: {type: "md"}
})
}
}
Indexing a Like
To index a like, the standard is to save the action like, with {key: object-representing-the-post, value: {type: "like" }}
{
index: {
like: JSON.stringify({
key: {type: 'social', path: 'influencer.testnet/post/main', blockHeight: 152959480 },
value: {type: "like"}})
}
}
Retrieving Indexed Actions
To retrieve indexed actions we use the Social.index method. It takes the action and the key as arguments, and returns an array of all the indexed values alongside the blockHeight in which they were indexed, and which user made the action.
Parameters
Social.index 인자:
| param | 필수 여부 | type | 설명 |
|---|---|---|---|
action | required | 문자열 | 예를 들어 경로 index/like에서 action은 like입니다. |
key | required | 문자열 | 표준의 내부 인덱스 값입니다. |
options | 선택사항 | 객체 | options 객체 |
subscribe(선택 사항): true이면 데이터가 5초마다 새로 고쳐집니다.accountId(선택 사항): 지정된 경우 값을 필터링하려면 문자열 또는 계정 ID 배열이어야 합니다. 그렇지 않으면 계정 ID로 필터링하지 않습니다.order(선택 사항):asc또는desc중 하나입니다. 기본값은asc입니다.limit(선택 사항): 기본값은100입니다. 반환할 값의 수를 의미합니다. 마지막 요소의 블록 높이가 같은 경우 인덱스 값보다 많은 값을 반환할 수 있습니다.from(선택 사항): 순서에 따라 기본값은0또는Max입니다.
