secretfoundation / docs

Secret Network Documentation

cover	coverY
.gitbook/assets/header3.png	0

Secret Network Introduction

Secret Network offers scalable permissionless smart contracts with a private by default design— bringing novel use cases to blockchain not feasible on public systems. Secret Network was the first protocol to provide private smart contracts on mainnet, live since September 2020.

Secret Network is built with the Cosmos Software Development Kit (SDK) bringing interoperable privacy to the entire Cosmos and EVM ecosystems. Secret Network uses a combination of the Intel SGX (Software Guard Extension) Trusted Execution Environment technology, several encryption schemes, and key management to bring privacy by default to blockchain users. Secret Contracts are an implementation of the Rust-based smart contract compiling toolkit CosmWasm, adding private metadata possibilities. Secret Network is powered by the Native public coin SCRT which is used for fees, Proof-of-Stake, security, and Governance. With more than 30+ Dapps on mainnet and 100+ full time builders, Secret Network aims to bring privacy to the world.

Join the community

• Telegram
• Twitter
• Discord
• Forum
• Blog
• Homepage

Get the latest version: https://github.com/scrtlabs/SecretNetwork

docs's Issues

[DOCS] Fix Run Full Node Documentation

Contact details

[email protected] OR norfmenn#3396

What type of request are you making?

Update Content

Describe your documentation request

A few Secret Network community members have had trouble getting a node up and running by using the current state of documentation. This documentation needs to be updated to work as expected so developers can efficiently get their own nodes up and running.

General feedback

No response

[DOCS] Make Griptape-JS Guide

Contact details

[email protected] OR norfmenn#3396 on Discord

What type of request are you making?

New Content

Describe your documentation request

Griptape.js is a framework for developing DApps on the Secret Network. It is currently not referenced in the Secret documentation, but widely used by Secret Network developers. The Griptape framework provides patterns and good practices for keeping Secret DApps up and running.

The src files of griptape.js to be referenced in the Secret docs can be found here: https://github.com/stakeordie/griptape.js/tree/main/src

For this issue to be complete the Secret Documentation should include practical examples on how to use griptape.js functionality for:

• Authentication: account.ts
• Authentication: index.ts
• Authentication: permits.ts
• Authentication: types.ts
• Authentication: viewing-keys.ts
• Contracts: errors.ts
• Contracts: index.ts
• Contracts: types.ts
• Contracts: utils.ts
• Events: accounts.ts
• Events: index.ts
• Events: viewing-keys.ts
• Modules: auth.ts
• Modules: bank.ts
• Modules: base.ts
• Modules: distribution.ts
• Modules: governance.ts
• Modules: index.ts
• Modules: minting.ts
• Modules: slashing.ts
• Modules: staking.ts
• Modules: supply.ts
• Modules: tendermint.ts
• Modules: types.ts
• Modules: utils.ts
• bootstrap.ts
• globals.d.ts
• index.ts
• utils.ts
• wallet.ts

General feedback

No response

Missing sections in Ecosystem Overview beyond General Resources

We'd like to add Fadroma to the official docs, as it's still the first Secret Network-centric DevOps framework (although we went out of beta long after Polar and Griptape) and perhaps the only one actively maintained.

But where to add it? Products, Games, Explorers, Wallets, User Guides, Developer Guides, Developer Tools, Reference Contracts - all the links point to nowhere.

Deprecate/redirect build.scrt.network

Contact details

No response

What type of request are you making?

Other

Describe your documentation request

Old docs at build.scrt.network can trip up new users, since the move to docs.scrt.network the page should perhaps redirect there, or even link to the new docs.

General feedback

No response

[DOCS] Issue with directing users to SecretJS docs

Contact details

Srdtrk#3405

What type of request are you making?

Broken Link

Describe your documentation request

In the mainpage Readme.md, under the Docs header, there is a link How to use SecretJS to develop Secret dApps. This takes you to an unrelated link about secretcli

General feedback

No response

Review docs -> SecretCLI section

Epic: #31

• Install Secret CLI
• Secret CLI
• Governance

Review docs -> Protocol section

Epic: #31

• Components
• Encryption
• Transactions
• Intel SGX

Documentation Revamp - [ Development Overvew ]

Development overview chapter of docs.scrt.network, link issues for separate headers.

Please create a new issue when taking on a task

• overview - one page
  • for contract development
    • polar
    • toolkit
  • for frontend development
    • secretjs
    • keplr
    • griptape
  • for backend development
    • secret js
    • secret py
    • SecretCLI
• Testnet
• Secret contracts
  • Overview
    • Reference contracts
  • Core Components
    • Contract.rs
      • Init
      • Handles
      • queries
    • Msg.rs
      • Message definitions for init, handle, and queries
    • State.rs
      • Struct definitions and storage keys
    • Lib.rs
      • Holds names of all components .rs files
    • Schema.rs
  • Init
    • What should be in an init instead of handles.
    • Same purpose as a solidity constructor
  • Handles - Assigned to Danny
    • HandleMsg
    • HandleAnswer
  • Queries - Assigned to Danny
    • QueryMsg
    • QueryAnswer
  • Storage
    • Making/Handling storage keys, how they work. The fact that they all byte arrays, etc…
    • Saving to storage
    • Loading Storage
    • Removing storage
  • Viewing keys - Assigned to Lumi
    • Stored as an address and key pair, similar to username and password.
    • Why to use them
  • Certs and query permits - Assigned to Lumi
    • Why use certs as opposed to viewing keys in certain situations
  • How to use/create on chain entropy/randomness
  • Unique data handling
    • Uint128
      • When to use them instead of u128
      • Data hygiene, how Uint128s can sometimes be a security risk
    • Floats
      • DONT EVER USE THEM
  • Inter-Contract Interaction
    • CosmosMsg
    • Snip-20s
      • How to implement snip payments in your contract
      • Send vs Transfer
    • Regular inter contract handling
      • Init
      • Handles
      • Queries
  • HandleResponse
    • Messages
    • Logs
    • Data
  • Useful libraries
    • Secret-toolkit - this can be referenced in relevant sections where the toolkit is normally used.
  • Contract Hashes
    • What they are, when they are needed
  • How to send native SCRT
  • Contract Calls From Front-End (Get Xiphs Input)
• Building a frontend
  • using clean secretjs
  • using griptape
• Building backend services
  • using the secretcli
  • using node.js
  • using python
• Vanilla cosmwasm migration
• Secret CLI - Assigned to norfmenn

Documentation Revamp - [ Secret network overview ]

Secret network overview chapter of Docs.scrt.network , link issues for separate headers.

This section should contain 0 code and not reference community resources as explanation but have the full explanation written out.
For people to develop on SN they need to know what the core concepts are it uses.

Structure:

• What is Secret Network?
  • History / backstory of Secret Network
    - SN ethos
    - privacy in web3 vs web2
    - Enigma MPC --> SN SGX
    - timeline of launches
  • Tech overview
    • SGX + sdk (short) - Assigned to TripleA** -- Started
    • what is SCRT / sSCRT? - Assigned to TripleA -- DONE
  • SN use cases -- DONE
  • Roadmap
  • Socials - website
• Blockchain technology - Assigned to Kharnhash -- Started
  • The Cosmos basics
    - Tendermint core
    - Dpos/BFT
    - governance
    • SDK and ABCI
    • IBC
    • CosmWasm module
  • Network architecture
    - Validators, mempool, chain interaction
• Privacy technology
  • remote attestation
  • bootstrap/seed node
  • Encrypted transaction
    - user side encryption --> mempool --> full node SGX --> State change --> Viewing key to show
  • inputs/outputs
    • how it’s made
    • how to use
  • storage
  • Viewing keys/Permits
  • Privacy Roadmap (HME)
  • comparisons - Assigned to Ertemann -- Started
    • monero/zcash
    • phala/oasis?
    • aleo/dero/sero
    • penumbra/nym
    • dusk
  • Trust assumptions
    • SGX
    • Admin key
    • bridge (eth/bsc/monero)
    • IBC

[DOCS] Complete SecretJS Guide

Contact details

[email protected] OR on Discord --> Norfmenn#3396

What type of request are you making?

New Content

Describe your documentation request

SecretJS has been updated multiple times over the past few months. Our documentation has been updated to reflect the recent changes to SecretJS -- but only up until the 'transfer tokens - simple' example within the SecretJS-Templates. There are still several tutorials for how to use SecretJS missing from the documentation.

You can find the templates to model the SecretJS tutorial from here: https://github.com/scrtlabs/SecretJS-Templates

For this issue to be complete tutorials for the following SecretJS-templates need to be added to the documentation:

• npm run 4:advanced - Transfer tokens - advanced
• npm run 4:batch - Send multiple txs the same block
• npm run 4:batch_same_tx - Send multiple messages in the same transaction
• npm run 5 - Create, deploy and use a Secret Contract
• cd 6_wallets/keplr && npm i && npm run dev - Keplr wallet
• npm run 7 - SNIP-20 token. Creating and using fungible tokens
• cd 8_websocket && npm i && npm run dev - Consume Websocket contract events

The primary contributor working on the SecretJS-templates is @assafmo from Secret Labs.

General feedback

No response

Environment setup issues

this guide https://docs.scrt.network/secret-network-documentation/development/development-concepts/create-your-own-snip-20-token-on-secret-network indicates that the developer environment should be set up according to these guidelines: https://docs.scrt.network/secret-network-documentation/development/getting-started/setting-up-your-environment which help the user set up SN on a localhost. but then the SNIP-20 guide proceeds to build the contract on pulsar-3, which doesn't work

I've created an account on pulsar-3 and modified the script to use this account but am getting an error where the transaction is created but doesn't contain a .arrayLog value (it's undefined). instead, I see a .rawLog that contains something like:

signature verification failed; please verify account number (25421) and chain-id (pulsar-3): unable to verify single signer signature

and I haven't been able to figure out why this is happening. help?

Documentation Revamp - [ Ecosystem overview ]

Ecosystem overview chapter of Docs.scrt.network , link issues for separate headers.

• Home (AWSM secret) - @ertemann
  • tools
    • block explorers
    • wallets
    • tx history
    • secure secret calls
• Overview of entities/contributors - descriptions of the teams @ertemann, @pmuecke
  • Core
    • scrt labs
    • foundation
    • committees
  • Core infrastructure (API/bridge validators)
    • citadel, secretnodes, relayers (stake lab, cryptocre notional lavender)
  • Application
    • secure secrets, hydro, jackal, domerium, etc
  • Tooling/community
    • trivium, secret sauce, gmail, pmuecke, secret saturn etc
• Overview of applications (descriptions of the applications) - Education committee??
  • Secretswap
  • Siennaswap
  • Shade
  • btn
  • orbem wars
  • datavault
• Funding - Ertemann/Education committe
  • Secret labs grants
  • Ecosystem fund (TBD)
  • Community pool
  • Shade grants
  • SNAC

[DOCS] Add Polar Documentation

Contact details

[email protected] OR norfmenn#3396

What type of request are you making?

New Content

Describe your documentation request

Missing documentation for Polar, a development framework for building Secret Contracts.

For this issue to be complete, the following documentation needs to be added:

• How to install Polar
• Initialize project repos from Secret Contract templates with Polar
• Compile Secret Contracts with Polar
• Deploy Secret Contracts with Polar
• Interact with Secret Contracts with Polar

General feedback

No response

Documentation Revamp - [ Validator Overvew ]

Contact details

[email protected]

What type of request are you making?

Update Content

Describe your documentation request

• Validators
  • Overview
  • Hardware compliance
    • Providers
  • Security
  • Registration
  • Node monitoring
    • Docker monitoring
  • Delegation
  • Migration

General feedback

No response

Documentation Revamp [ full checklist ]

Branch "Doc_revamp" - Contributors @StoicNorth @dylanschultzie @reuvenpo @assafmo , Patrick, Gino

We will be creating a revamped docs.scrt.network as a collaboration effort between multiple committees, the Secret foundation and SCRT labs. Issue #127 Determines most of the categories to be worked on. Besides new content the new documentation will be hosted using a different compiler, possibly Gitbook or Docusaurus.

Structure:

• Secret network overview #130
• Ecosystem overview #131
• User guides
• Development #134
• Validators

https://docs.google.com/document/d/16_GIEqJG5y_knQ2KNbZDj_NTFyaG4svth_aNIFk_it0/edit?usp=sharing

[DOCS] Inaccuracy in Governance.md

Contact details

Srdtrk#3405

What type of request are you making?

Update Content

Describe your documentation request

In How to participate in on-chain governance section, the quorum requirement is stated as: ((YesVotes+NoVotes+NoWithVetoVotes) / totalBondedStake) >= 1/3

It should be ((YesVotes+NoVotes+NoWithVetoVotes+AbstainVotes) / totalBondedStake) >= 1/3

I also think there may be a further inaccuracy (according to cosmos docs), the veto requirement is stated as (NoWithVetoVotes / (YesVotes+NoVotes+NoWithVetoVotes)) < 1/3. I believe it should be (NoWithVetoVotes / (YesVotes+NoVotes+NoWithVetoVotes+AbstainVotes)) < 1/3

General feedback

No response

[DOCS] Create Secret Python Guide

Contact details

[email protected] OR norfmen#3396 on Discord

What type of request are you making?

New Content

Describe your documentation request

Secret Analytics made the secret-sdk-python toolkit for building software capable of interacting the the Secret blockchain. It can provide simple abstractions over core data structures, serialization, key management, and API request generation.

The documentation is missing how to use Secret Python to help develop Secret Contracts and interact with the Secret blockchain. Secret Analytics have created guides on how to use Secret Python here: https://github.com/secretanalytics/secret-sdk-python/tree/main/docs/guides. They also have a quickstart guide here: https://github.com/secretanalytics/secret-sdk-python/blob/main/docs/tutorial.rst

The Secret Documentation should reference Secret Python, and have introductory / basic tutorials on how to use Secret Python. For this issue to be complete the following needs to be done:

• Have a dedicated page within the Secret documentation for Secret Python
• Installing the Secret Python sdk
• How to use Secret Python with asyncio
• Implementing custom keys with Secret Python
• Getting blockchain info using the Secret sdk
• How to work in Secret Contracts using Secret Python
• Tutorial on building and signing transactions using Secret Python
• Guide for troubleshooting Secret Python

General feedback

No response

Phase 1 - initial pass

• #35
• #34
• #33

Secret-JS Templates

Contact details

[email protected]

What type of request are you making?

Update Content

Describe your documentation request

The Secret-JS templates need to be updated to reflect changes made to Secret-JS. Currently up to '4_transactions' is complete, but we need to have the following template sections updated:

• 5_contracts
• 6_wallets
• 7_snip20_token
• 8_websocket

Here is a link the the Secret-JS templates being referenced: https://github.com/scrtlabs/SecretJS-Templates/tree/update-secretjs

@assafmo

General feedback

No response

Fix install links for secretcli from 1.3.1 to 1.6.1

Went through this document:

https://github.com/SecretFoundation/docs/blob/gitbook/development/getting-started/setting-up-your-environment.md

secretcli version 1.3.1 fails at the instantiate contract step in the following document:

https://github.com/SecretFoundation/docs/blob/gitbook/development/getting-started/compile-and-deploy.md

with error:

Failed to get IO key. Make sure the CLI and the node you are targeting are operating in the same SGX mode
2023/02/07 23:13:42 invalid character 'i' looking for beginning of value
Error: invalid character 'i' looking for beginning of value

Confirmed 1.6.0+ works as expected.

Inaccuracy in Governance.md

In How to participate in on-chain governance section, the quorum requirement is stated as: ((YesVotes+NoVotes+NoWithVetoVotes) / totalBondedStake) >= 1/3

I believe it should be ((YesVotes+NoVotes+NoWithVetoVotes+AbstainVotes) / totalBondedStake) >= 1/3

[DOCS] Update optimizer docs

Contact details

No response

What type of request are you making?

Update Content

Describe your documentation request

Need to update the optimizer docs @ https://docs.scrt.network/dev/developing-secret-contracts.html#with-docker

General feedback

No response

Developer documentation overhaul - Bizdev/foundation initative

This issue is used to keep a detailed overview of the work done on the Bizdev developer documentation initiative proposal which was laid out in this forum post.

Summary:

The developer documentation is slightly outdated and incomplete. In order to improve the onboarding process of new developers and developers from other ecosystems @dylanschultzie proposes to follow this 6 step approach. These 6 steps are divided among 3 short and 3 long term goals. The first 3 steps are covered within the current proposal, the long term steps are still open for grants or a next proposal.

Steps Short term:

• 1. Do quick repairs on the docs - make sure links work, nothing is immediately incorrect, etc.

Some of this has been done already 1 , 2 , but it’s clear that more attention needs done from a quick pass perspective. This is intended as a stopgap solution. Get in, so that while working on 2, incoming developers are in a better state.

#31 used to track this step.

• 2. Go through the active dev docs

This is the bulk of the short-term work. It will include going through every single step on all tutorials provided on https://docs.scrt.network/ and Figment Learn | Secret , including fixing and improving upon them. Note that I don’t think figment currently accepts direct fixes, so this will be more involved.

I believe doing every tutorial is paramount to a job well done here, as reading over and reviewing the documentation isn’t the same as executing every command provided.

• 3. Do a thorough analysis of the docs

Finally, this will include comparing the documentation against source documentation, such as gaiacli. With Supernova, much of the cli has been updated and so the documentation is no longer correct. This documentation either needs to be reviewed, re-written, or purged completely. For much of the documentation I don’t see a ton of benefit to keeping what amounts to a copy & paste of the source docs, with gaiacli replaced with secretcli.

Steps Long term:

• 4. Coordinate internal Secret tooling

There are a ton of tools that have been built around Secret that aren’t in a unified location for developers to quickly access. These should be coordinated, and documented. Explain how to use them, why to use them, etc. As an example, why is Griptape not referenced?

• 5. Create a “How to Port your dApp from Terra to Secret”

We need more developers. Why not invite those from Terra and other ecosystems to port their dApps, but private?

• 6. Align Secret dev docs with external cosmwasm dev docs

Timeline

The following is a rough expectation of timeline, assuming the proposal goes through the week of January 3rd, 2022:

1. The initial pass will take up to 2 weeks, concluding January 15th
2. The thorough dev docs will take roughly 2 months, concluding around March 15th
3. The final pass should take another 1-2 weeks, concluding by April 1st

Developer documentation overhaul - Phase 1

Issue which covers phase 1/6 of issue #30

Do quick repairs on the docs - make sure links work, nothing is immediately incorrect, etc.

Some of this has been done already, but it’s clear that more attention needs done from a quick pass perspective. This is intended as a stopgap solution. Get in, so that while working on step 2, incoming developers are in a better state.

List of completed actions/necessary steps:

• Check all links
• etc
• more

ETA before 23 january 2022

Inaccuracy in send transactions in "Using Secret CLI"

(in multiple places) Whenever a send transaction example is made in the documentation, it uses secretcli tx send ... I believe it should be secretcli tx bank send ...

Review docs -> Developers section

Epic: #31

• Secret Contracts
• Privacy Model
• Development Guide
• Quickstart
• SecretJS
• Tutorials

Documentation lacks a direct link to Millionares Problem code

In this guide there is a reference to the msg.rs code to view the RicherResponse struct, but I have no way of finding this file.

Phase 2 chartering plan

This is the bulk of the short-term work. It will include going through every single step on all tutorials provided on https://docs.scrt.network/ 3 and Figment Learn | Secret 2, including fixing and improving upon them. Note that I don’t think figment currently accepts direct fixes, so this will be more involved.

I believe doing every tutorial is paramount to a job well done here, as reading over and reviewing the documentation isn’t the same as executing every command provided.

[DOCS] Inaccuracy in developing-secret-contracts.ms

Contact details

Srdtrk#3405

What type of request are you making?

Update Content

Describe your documentation request

The command given in the document for starting up localsecret is

$ docker run -it --rm \
 -p 26657:26657 -p 26656:26656 -p 1317:1317 \
 --name localsecret ghcr.io/scrtlabs/localsecret

It lacks the grpc port in the starting command, making it incompatible with the latest version of secretjs if someone wants to connect it, so I suggest you use

docker run -it --rm -p 9091:9091 -p 26657:26657 -p 1317:1317 -p 5000:5000 \
  --name localsecret ghcr.io/scrtlabs/localsecret

Also I think it is better to omit $ from the start of all commands in github since when you use the built in copy function for commands, it also copies the $

General feedback

No response

Full node documentation needs some update

Hi, just a few observations about the documentation.

secretd version in installation instructions

In https://github.com/SecretFoundation/docs/blob/gitbook/node-runners/node-setup/install-secretd.md, could update the secretd version to the current latest, which is v1.4.0 at the time to writing this issue.

# download secretd v1.3.1
wget "https://github.com/scrtlabs/SecretNetwork/releases/download/v1.3.1/secretnetwork_1.3.1_mainnet_goleveldb_amd64.deb"

# verify download
echo "3b501e572ab6021df3371d5fae73952cd6fc5a85b726310cf32a000f4c093207 secretnetwork_1.3.1_mainnet_goleveldb_amd64.deb" | sha256sum --check
# secretnetwork_1.3.1_mainnet_goleveldb_amd64.deb: OK

Question: Where can one get the sha256 hash? See https://docs.scrt.network/secret-network-documentation/post-mortems-upgrades/upgrade-instructions/shockwave-delta#upgrading-manually

bootstrap node URL

In https://github.com/SecretFoundation/docs/blob/gitbook/node-runners/node-setup/setup-full-node.md#configure-secretd:

secretd config chain-id secret-4
secretd config node https://lcd-secret.scrtlabs.com:443/rpc
secretd config output json

The URL https://lcd-secret.scrtlabs.com:443/rpc did not work in my setup attempts. Had to look at the API registry at https://github.com/scrtlabs/api-registry#secret-4-mainnet.

[DOCS] Making a submodule for the documentation in the main scrtlabs/SecretNetwork repo for the docs?

Contact details

No response

What type of request are you making?

New Content

Describe your documentation request

I have always wondered if we could link this repo as a submodule of the main repo. It would be nice to have both of them versions controlled by the parent, and auto-tag all documentation side-by-side during new releases or changes. But the documentation is maintained in this repo.

General feedback

No response

[DOCS] Documenting Viewing Keys and Permits

Contact details

Lumi#3045

What type of request are you making?

New Content

Describe your documentation request

I will be adding documentation on viewing keys and permits to the new documentation gitbook.

General feedback

No response

[DOCS] Migration to gitbook

Contact details

[email protected]

What type of request are you making?

New Content

Describe your documentation request

So i had started this with the infra committee back before documentation got separated,
Migrating the docs website to the gitbook setup,
Currently, it's not automatic updated unfortunetly : Gitbook Secret

I had given admin access to the Schultzie, but I know that at that point it was decided to continue on the docs.

Not sure if this is something the network would still want to maintain and do.

General feedback

No response

[DOCS] Add Information - Governance charter to Governance.md

Contact details

Ertemann#9832 and pmuecke#5619

What type of request are you making?

New Content

Describe your documentation request

Add information regarding Code of conduct to Governance procedure, add simple best practices for creating proposals.

https://wallet.keplr.app/#/secret/governance?detailId=81

General feedback

No response

Example Bounty

Contact details

[email protected]

What type of request are you making?

New Content

Describe your documentation request

Here is an example description of the project. In practice, each bounty will have it's own custom template for this specific purpose.

Secret Documentation is missing a section for creating and managing multisig wallets using the secretccli.

Completion of this task includes:

• Describe how to generate a multisig wallet using keys you own and DO NOT own with both verbal descriptions and code examples
• Describe how to confirm multisig generation is successful using the secretccli
• Section on the 'k' value when generating a multisig wallet
• Describe best practices associated with creating multisig wallets in relation to the k value
• Describe --flags relevant for creating multi sig wallets with code examples

Bounty for completion: $300

Leave a comment that you will be taking on this bounty. You have 3 business days to complete the bounty. If the bounty is not complete 3 business days after your claim, then the next person in line will get the opportunity to complete the bounty.

Upon completion, comment a link with the work done for review. After review is complete, and the request is complete / merged into the main branch. Funds will be paid with a TX hash posted as a comment on this issue, and the issue will be closed.

General feedback

No response

Documentation TOC/structure

This is the current structure of the Docs.scrt.network page. Work together in below document to set up the new structure.

https://docs.google.com/document/d/16_GIEqJG5y_knQ2KNbZDj_NTFyaG4svth_aNIFk_it0/edit?usp=sharing