Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[r2r] Add nft docs #42

Merged
merged 114 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
114 commits
Select commit Hold shift + click to select a range
31034a0
add WithdrawFee object to common structures
smk762 May 16, 2023
bb19ab5
update temlate for atomicdex methods
smk762 May 16, 2023
813bb2c
fix typo in withdraw doc
smk762 May 16, 2023
6aab7c4
add token withdraw objects to common structures
smk762 May 16, 2023
d5099cf
Update WithdrawData object params
smk762 May 16, 2023
7579cf3
add draft NFT docs
smk762 May 16, 2023
3312117
update sidebar
smk762 May 17, 2023
59aee21
fix sidebar path
smk762 May 17, 2023
1f30451
test heading tags
smk762 May 17, 2023
b480c89
add heading tags for NFT docs
smk762 May 17, 2023
8bdb582
fix links
smk762 May 17, 2023
46e5872
fix link
smk762 May 17, 2023
83cac1d
Merge branch 'dev' into add-nft-docs
smk762 May 25, 2023
8cf9139
updated NFT response descritions from review feedback
smk762 May 25, 2023
2fd9d09
add some DevComments for items needing clarification
smk762 May 25, 2023
6892872
add coin activation note for nft withdraw
smk762 May 26, 2023
0b82548
review fixed for NFT docs
smk762 May 26, 2023
93e64dc
Merge branch 'dev' into add-nft-docs
smk762 May 31, 2023
86857d5
Add token metadata object
smk762 May 31, 2023
f5b4288
nft docs review fixes
smk762 May 31, 2023
3c3b5b9
adds TokensRequest and TokenFilter objects
smk762 May 31, 2023
3d9d0c6
update nft req/resp for examples with filter params
smk762 May 31, 2023
5e86b5d
add `refresh_nft_metadata` and `update_nft`
smk762 May 31, 2023
a421916
rm comma
smk762 Jul 17, 2023
d26ec28
Update index.mdx
smk762 Jul 17, 2023
f3fcef0
Merge branch 'dev' into add-nft-docs
smk762 Aug 24, 2023
8497f45
add codegroup tags
smk762 Sep 9, 2023
83d87ec
Merge branch 'dev' into add-nft-docs
smk762 Sep 9, 2023
6d43eb4
removes sidebar.ts
gcharang Sep 9, 2023
451dda8
updates sidebar
gcharang Sep 9, 2023
a1a8fb3
Merge branch 'dev' into add-nft-docs
gcharang Sep 9, 2023
c8c7e96
fix internal link
gcharang Sep 9, 2023
197751e
fix internal link
gcharang Sep 9, 2023
71d114e
linter wip
gcharang Sep 9, 2023
f496a0b
linting wip
gcharang Sep 9, 2023
6fb177a
adds title and desc
gcharang Sep 9, 2023
0c0a6a9
edit
gcharang Sep 9, 2023
44138e2
slugs extracted
gcharang Sep 9, 2023
ddf9ff8
slugs extracted
gcharang Sep 9, 2023
f9f3202
slugs linter online
gcharang Sep 9, 2023
d37620c
fixing slugs wip
gcharang Sep 11, 2023
fcc5cc3
fixing slugs wip
gcharang Sep 11, 2023
4c0626a
slugs fixed
gcharang Sep 11, 2023
005c17e
Merge branch 'dev' into add-nft-docs
smk762 Sep 15, 2023
0693747
merge dev
gcharang Sep 28, 2023
e3907ef
add params to `TokenFilter`
laruh Sep 28, 2023
8e1c9ce
Merge branch 'dev' into add-nft-docs
gcharang Sep 29, 2023
1026083
Merge branch 'dev' into add-nft-docs
gcharang Sep 29, 2023
2b02e8e
updates to pass linter, added TODO
gcharang Sep 29, 2023
84fe379
[Bot] File and author data updated, validated and updated internal li…
gcharang Sep 29, 2023
56c4798
Merge pull request #126 from KomodoPlatform/lint-fix-patches/add-nft-…
gcharang Sep 29, 2023
b55adc6
fix some review notes for `get_nft_list`,`get_nft_transfers`, get_nft…
laruh Oct 1, 2023
d65310d
[Bot] File and author data updated, validated and updated internal li…
laruh Oct 1, 2023
83fa343
Merge pull request #144 from KomodoPlatform/lint-fix-patches/add-nft-…
gcharang Oct 3, 2023
f050d7b
Merge branch 'dev' into add-nft-docs
smk762 Oct 3, 2023
0e74d8b
add note for block height changes when transferring nfts
smk762 Oct 3, 2023
9465167
add link for unix epoch timestamps
smk762 Oct 3, 2023
0ee610b
add missing word
smk762 Oct 3, 2023
de88450
fix lint errors
smk762 Oct 3, 2023
eaf8912
fix typo and use "contract_type"
laruh Oct 4, 2023
881ea66
add url\_antispam into `update_nft`, `refresh_nft_metadata`
laruh Oct 4, 2023
4aeec66
remove "url" from `withdraw_nft` req
laruh Oct 4, 2023
fed4367
fix typo
laruh Oct 4, 2023
905250b
merge dev
gcharang Oct 4, 2023
5b5fc75
update linter
gcharang Oct 4, 2023
0ed721c
Merge branch 'dev' into add-nft-docs
gcharang Oct 4, 2023
7f7f905
Merge branch 'dev' into add-nft-docs
gcharang Oct 4, 2023
c788ab8
Merge branch 'dev' into add-nft-docs
smk762 Oct 10, 2023
8d48507
update contribs
smk762 Oct 10, 2023
7442b19
Merge branch 'dev' into add-nft-docs
smk762 Nov 22, 2023
8095434
Fix WithdrawNftData common structure
smk762 Nov 22, 2023
d9360c8
Merge branch 'add-nft-docs' of https://github.com/KomodoPlatform/komo…
smk762 Nov 22, 2023
da6eb07
linting and fix 302 url
smk762 Nov 22, 2023
17f6bd4
add get_nft_list
smk762 Nov 23, 2023
0f8003c
add get_nft_transfers
smk762 Nov 23, 2023
ee15fe6
add get_nft_metadata
smk762 Nov 23, 2023
c620113
add activation note
smk762 Nov 23, 2023
57ba4e8
split nft methods into own pages
smk762 Nov 23, 2023
0d9b43c
lint the updates
smk762 Nov 23, 2023
cbe6f0a
add spam protection example for nft list method
smk762 Nov 23, 2023
9319985
Add note to update_nft before get_nft_list
smk762 Nov 23, 2023
e13697c
add get_nft_metadata responses
smk762 Nov 23, 2023
decb803
add note about potentially long waits fot update_nft
smk762 Nov 23, 2023
93c697e
tweak description
smk762 Nov 23, 2023
c4f744f
add note about deprecation
smk762 Nov 23, 2023
3b9b268
add more notes, examples and error responses
smk762 Nov 23, 2023
44f6ba3
add NFT methods to postman
smk762 Nov 23, 2023
4d90636
add nft db tables
smk762 Dec 4, 2023
65ded0b
fix lint, update sidebar
smk762 Dec 4, 2023
7d78a11
add nft database table column descriptions
smk762 Dec 4, 2023
137f6a5
[Bot] File and author data updated, validated and updated internal li…
smk762 Dec 4, 2023
ea2c4a9
Merge pull request #165 from KomodoPlatform/lint-fix-patches/add-nft-…
gcharang Dec 4, 2023
77e16d4
Merge branch 'dev' into add-nft-docs
gcharang Dec 4, 2023
3b5929a
[Bot] File and author data updated, validated and updated internal li…
gcharang Dec 4, 2023
194e88f
Merge pull request #169 from KomodoPlatform/lint-fix-patches/add-nft-…
gcharang Dec 4, 2023
566bef4
review fixes
smk762 Dec 4, 2023
ae7e903
Merge branch 'add-nft-docs' of https://github.com/KomodoPlatform/komo…
smk762 Dec 4, 2023
6c1e55a
[Bot] File and author data updated, validated and updated internal li…
smk762 Dec 4, 2023
57156d7
Merge pull request #171 from KomodoPlatform/lint-fix-patches/add-nft-…
gcharang Jan 29, 2024
10b4d8d
Merge branch 'dev' into add-nft-docs
smk762 Feb 25, 2024
f5dbaee
add gpt contents
smk762 Feb 25, 2024
6e21f7a
update key type values
smk762 Feb 25, 2024
85f8df9
remove duplicated common structures
smk762 Feb 25, 2024
8504bb6
fix anchor links
smk762 Feb 25, 2024
3cd7280
make sql commands formatting consistent
gcharang Feb 27, 2024
e0267a3
fix headings
gcharang Feb 27, 2024
423eadf
ran tests
gcharang Feb 27, 2024
2a6297a
add clear_nft_db doc
smk762 Feb 29, 2024
2f685bf
Merge branch 'add-nft-docs' of https://github.com/KomodoPlatform/komo…
smk762 Feb 29, 2024
c7a5791
Merge branch 'dev' into add-nft-docs
gcharang Feb 29, 2024
5cf7168
Merge branch 'dev' into add-nft-docs
gcharang Feb 29, 2024
b819972
Merge branch 'dev' into add-nft-docs
gcharang Feb 29, 2024
7f0bef1
[Bot] File and author data updated, validated and updated internal li…
gcharang Feb 29, 2024
418d2d4
Merge pull request #212 from KomodoPlatform/lint-fix-patches/add-nft-…
gcharang Feb 29, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,6 @@ Thumbs.db
*.pid
*.sublime-*

#custom
# custom
filepathSlugs.json
links-to-manually-check
18 changes: 17 additions & 1 deletion STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ For example:
| Parameter | Type | Description |
| --------- | ------- | --------------------------------------------------------------------------------------- |
| coin | string | The name of the coin the user desires to activate. |
| fee | object | Optional. A standard [FeeInfo](/atomicdex/api/v20/#FeeInfo) object. |
| fee | object | Optional. A standard [FeeInfo](/atomicdex/api/common_structures/#FeeInfo) object. |
| amount | float | Required, unless `max` is `true`. The amount of balance to send. |
| max | boolean | Optional, defaults to `false`. Send whole balance. |
| memo | string | Optional, used for ZHTLC and Tendermint coins only. Attaches a memo to the transaction. |
Expand Down Expand Up @@ -142,6 +142,22 @@ For example, when method and title are the same:

We've got a few **MDX** components we use across the Docs. Below is a walkthrough of how to start writing and using the components that make up the Docs.

IMPORTANT: Alwats use double quotes inside mdx tags.

Example:

Correct:

```
<CollapsibleSection expandedText="Hide Examples" collapsedText="Show Examples">
```

Wrong:

```
<CollapsibleSection expandedText='Hide Examples' collapsedText='Show Examples'>
```

MDX supports standard markdown by default [CommonMark](https://commonmark.org/). However, this project also has [GFM](https://github.github.com/gfm/) installed.

> Many of the components mentioned here are simplified and possibly do more than **explicitly pointed out**.
Expand Down
10,529 changes: 6,183 additions & 4,346 deletions data-for-gpts/all-content.txt

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions data-for-gpts/komodefi-api/code.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131756,7 +131756,7 @@ pub struct GetTransactionResponse {
#[prost(message, optional, tag="1")]
pub transaction: ::core::option::Option<Transaction>,
#[prost(message, optional, tag="2")]
pub token_metadata: ::core::option::Option<SlpTokenMetadata>,
pub token_metadata: ::core::option::Option<SlpNftMetadata>,
}
/// Get an encoded transaction from a transaction hash.
#[derive(Clone, PartialEq, ::prost::Message)]
Expand Down Expand Up @@ -131898,7 +131898,7 @@ pub struct GetAddressUnspentOutputsResponse {
#[prost(message, repeated, tag="1")]
pub outputs: ::prost::alloc::vec::Vec<UnspentOutput>,
#[prost(message, repeated, tag="2")]
pub token_metadata: ::prost::alloc::vec::Vec<SlpTokenMetadata>,
pub token_metadata: ::prost::alloc::vec::Vec<SlpNftMetadata>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetUnspentOutputRequest {
Expand Down Expand Up @@ -131936,7 +131936,7 @@ pub struct GetUnspentOutputResponse {
#[prost(message, optional, tag="6")]
pub slp_token: ::core::option::Option<SlpToken>,
#[prost(message, optional, tag="7")]
pub token_metadata: ::core::option::Option<SlpTokenMetadata>,
pub token_metadata: ::core::option::Option<SlpNftMetadata>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetMerkleProofRequest {
Expand Down Expand Up @@ -132068,14 +132068,14 @@ pub struct SubscribeBlocksRequest {
pub serialize_block: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSlpTokenMetadataRequest {
pub struct GetSlpNftMetadataRequest {
#[prost(bytes="vec", repeated, tag="1")]
pub token_ids: ::prost::alloc::vec::Vec<::prost::alloc::vec::Vec<u8>>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSlpTokenMetadataResponse {
pub struct GetSlpNftMetadataResponse {
#[prost(message, repeated, tag="1")]
pub token_metadata: ::prost::alloc::vec::Vec<SlpTokenMetadata>,
pub token_metadata: ::prost::alloc::vec::Vec<SlpNftMetadata>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSlpParsedScriptRequest {
Expand Down Expand Up @@ -132628,17 +132628,17 @@ pub struct SlpV1Nft1ChildSendMetadata {
#[prost(bytes="vec", tag="1")]
pub group_token_id: ::prost::alloc::vec::Vec<u8>,
}
/// SlpTokenMetadata is used to marshal metadata about a specific TokenID
/// SlpNftMetadata is used to marshal metadata about a specific TokenID
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SlpTokenMetadata {
pub struct SlpNftMetadata {
#[prost(bytes="vec", tag="1")]
pub token_id: ::prost::alloc::vec::Vec<u8>,
#[prost(enumeration="SlpTokenType", tag="2")]
pub token_type: i32,
#[prost(oneof="slp_token_metadata::TypeMetadata", tags="3, 4, 5")]
pub type_metadata: ::core::option::Option<slp_token_metadata::TypeMetadata>,
}
/// Nested message and enum types in `SlpTokenMetadata`.
/// Nested message and enum types in `SlpNftMetadata`.
pub mod slp_token_metadata {
/// V1Fungible is used to marshal metadata specific to Type 1 token IDs
#[derive(Clone, PartialEq, ::prost::Message)]
Expand Down
Loading
Loading