Skip to content
This repository was archived by the owner on May 26, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
33b74b8
[IN-166] Baseline documentation for indexer
inamirandaz Sep 26, 2022
4ef42d2
chore: add env scope to Portal title
frankmeds Sep 27, 2022
b97823d
chore: remove the name of the environment from the home page
frankmeds Sep 28, 2022
82d8771
[IN-166] Updated examples with testnet data
inamirandaz Sep 28, 2022
9eb633b
Merge pull request #1 from Zilliqa/feat/indexer-doc
inamirandaz Sep 28, 2022
d77bb45
WEB-55: "hreflang" conflicts within page source code
harunisik Sep 28, 2022
a1343dc
WEB-55: hreflang conflicts - remove alternate links
harunisik Sep 29, 2022
bade860
fix: Typo fix
harunisik Sep 29, 2022
784d76b
fix: update url config
harunisik Sep 29, 2022
30495e3
WEB-55: hreflang conflicts
harunisik Sep 29, 2022
32372fd
[IN-166] Added parameter description
inamirandaz Sep 29, 2022
1b0e247
[IN-166] updated ZRC2 graph query docs
himanshu-zilliqa Sep 30, 2022
28fb65b
[Fix] Updated descriptions
inamirandaz Sep 30, 2022
bd74823
WEB-55: ejected SiteMetadata component
harunisik Oct 2, 2022
8f8f7ae
[IN-239] Added queries for NFTs
inamirandaz Oct 9, 2022
fe0e9c8
Merge pull request #8 from Zilliqa/nfts
inamirandaz Oct 9, 2022
e6176cc
WEB-60: Fix bad link.
rrw-zilliqa Oct 16, 2022
3508d83
Merge pull request #9 from Zilliqa/WEB-60_fix_bad_link
rrw-zilliqa Oct 17, 2022
acba5f6
Added gamma env and improved attribute search
inamirandaz Oct 21, 2022
8b0120f
Merge pull request #10 from Zilliqa/gamma
inamirandaz Oct 21, 2022
e74ecd9
Added marketplace documentation
inamirandaz Nov 25, 2022
c742e76
Merge pull request #11 from Zilliqa/marketplace-docs
inamirandaz Nov 25, 2022
b22f1ac
Added native zil documentation
inamirandaz Dec 5, 2022
befea27
Merge pull request #12 from Zilliqa/native-zil
inamirandaz Dec 5, 2022
bac5476
DEVOPS-450: Adding deprecation notice
troels-im Dec 7, 2022
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
77 changes: 77 additions & 0 deletions OLD_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Zilliqa Developer Portal

[![Discord chat](https://img.shields.io/discord/370992535725932544.svg)](https://discord.gg/XMRE9tt)

This repository holds the source files for Zilliqa's developer portal website.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Local Deployment via Docker container

To build the docker container

```
./build_container.sh
```

To run the container

```
./run_container.sh
```

You can then access the site via

```
http://localhost:8080
```

To stop and remove the container

```
./stop_container.sh
```

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

This is done via github actions.

Docusaurus takes its `baseUrl` from the `BASE_URL` environment variable, which is taken from the `BASE_URL` secret for the `github-pages` environment.
You will need to explicitly whitelist `master` in the allowed branches protection rules for `github-pages`, or deployment will fail with `Invalid deployment branch and no branch protection rules set in the environment`.

If you don't specify a secret, we'll build for the root - suitable for a production deploying with a custom URL, but best to explicitly set a root as `/`, just in case.

The staging site is held in a separate repository; push to it with `-f` and deploy to "ordinary" pages.
If you do, we'll use that as the base URL - for the staging repo, set the `BASE_URL` secret to `/<reponame>/`.

You can then issue a PR to the production repo against your staging repo with (hopefully!) the security that it will deploy correctly.


### Utilities

#### Check all links return HTTP status 200

```
cd docs
find */*.md -exec npx markdown-link-check {} \;
```
78 changes: 2 additions & 76 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,3 @@
# Zilliqa Developer Portal
# Deprecation Notice

[![Discord chat](https://img.shields.io/discord/370992535725932544.svg)](https://discord.gg/XMRE9tt)

This repository holds the source files for Zilliqa's developer portal website.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Local Deployment via Docker container

To build the docker container

```
./build_container.sh
```

To run the container

```
./run_container.sh
```

You can then access the site via

```
http://localhost:8080
```

To stop and remove the container

```
./stop_container.sh
```

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

This is done via github actions.

Docusaurus takes its `baseUrl` from the `BASE_URL` environment variable, which is taken from the `BASE_URL` secret for the `github-pages` environment.
You will need to explicitly whitelist `master` in the allowed branches protection rules for `github-pages`, or deployment will fail with `Invalid deployment branch and no branch protection rules set in the environment`.

If you don't specify a secret, we'll build for the root - suitable for a production deploying with a custom URL, but best to explicitly set a root as `/`, just in case.

The staging site is held in a separate repository; push to it with `-f` and deploy to "ordinary" pages.
If you do, we'll use that as the base URL - for the staging repo, set the `BASE_URL` secret to `/<reponame>/`.

You can then issue a PR to the production repo against your staging repo with (hopefully!) the security that it will deploy correctly.


### Utilities

#### Check all links return HTTP status 200

```
cd docs
find */*.md -exec npx markdown-link-check {} \;
```
This repository has been deprecated in favor of the [Zilliqa Developer Repo](https://github.com/Zilliqa/zilliqa-developer)
29 changes: 0 additions & 29 deletions docs/dev/dev-tools-neosavant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ keywords:
- installation
- vscode extension
- emacs
- vim
- zilliqa
description: Zilliqa Online Smart Contract (Scilla) IDE
---
Expand Down Expand Up @@ -64,34 +63,6 @@ ext install as1ndu.scilla
- Type info for variables (Hover over dotted lines to see they type information of a variable)
- Configuration via Vscode's UI

## Vim

A vim plugin for editing Scilla contracts is provided.

You can install the vim config files through Pathogen by:

```
git clone https://github.com/edisonljh/vim-scilla.git ~/.vim/bundle/vim-scilla
```

Or through Vundle by adding the following line to your `~/.vimrc`:

```
Plugin 'edisonljh/vim-scilla'
```

If you are using [ALE](https://github.com/w0rp/ale), you can enable [scilla-checker](https://scilla.readthedocs.io/en/latest/scilla-checker.html) to show errors right inside vim.

Here is how to enable it:

1. Install [ALE](https://github.com/w0rp/ale) vim plugin
2. Make `scilla-checker` executable available (https://github.com/Zilliqa/scilla#compiling-and-running)
3. Set STDLIB dir in vimrc: `let g:ale_scilla_checker_libdir = '<path>/stdlib'`
4. Set CHECKER in vimrc: ` let g:ale_scilla_checker_executable='<path>/scilla-checker'`
5. Enable the linter in vimrc: `autocmd FileType scilla let b:ale_linters = ['checker']`
6. Open any scilla file and ensure checker is working: `:ALEInfo`
Repo: [vim-scilla](https://github.com/edisonljh/vim-scilla).

## Emacs

An emacs major mode for editing Scilla contracts is [provided](https://github.com/Zilliqa/scilla/blob/master/misc/emacs-mode/scilla-mode.el).
Expand Down
26 changes: 26 additions & 0 deletions docs/indexer/indexer-introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: indexer-introduction
title: Getting Started
keywords:
- api
- introduction
description: Zindexer API
---

---

The Zilliqa Indexer API service is still under development and is subject to changes.


## GraphQL Playground
The GraphQL API playground is available at

| Chain(s) | URL(s) |
| --------------------- | ------------------------------------------------|
| **Zilliqa Mainnet** | https://gam-indexer-api.rialto.studio/zilliqa/prod <br/>*Note: This is a pre-production environment. Please report bugs at [email protected].* |
| **Developer Testnet** | https://stg-indexer-api.rialto.studio/zilliqa |

Schema can be downloaded from the above GraphQL playground.

Please contact [email protected] to request for an API key.

102 changes: 102 additions & 0 deletions docs/indexer/marketplace-brand-collectible-assets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
id: brand-collectible-asset
title: Brand Collectible NFTs
keywords:
- marketplace
- brand collectible
description: Assets in a brand collectible
---


---

Get list of all NFTs in a brand collectible.



### Parameters

| Name | Type | Required |Description
| ----------------- | ------- | -------- | ----------------------------------
| `collectionId` | String | Required | Id of a brand collectible


### Example Request

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="GraphQL"
values={[
{ label: 'GraphQL', value: 'GraphQL', },
{ label: 'cURL', value: 'cURL', },
]
}>

<TabItem value="GraphQL">

#### Query


```graphql
query BrandCollectibleNFTs($input: BrandCollectiblesNFTInput) {
brandCollectiblesNFTs(input: $input) {
cursor
brandCollectiblesNFTList {
collectionId
createdAt
collectionContract
}
}
}
```

#### Query Variables

```graphql
{
"input": {
"collectionId": "11"
}
}
```

#### HTTP Headers

```graphql
{
"Authorization": "Bearer <insert token>"
}
```

</TabItem>


<TabItem value="cURL">

```curl
```

</TabItem>
</Tabs>

### Example Response

```json
{
"data": {
"brandCollectiblesNFTs": {
"cursor": "100",
"brandCollectiblesNFTList": [
{
"collectionId": "11",
"createdAt": "2022-11-25T07:30:49.313217+00:00",
"collectionContract": "0x2878928cadf313ef27b35f985ef3e57b2aac7f4d"
}
]
}
}
}
```

Loading