Giter Club home page Giter Club logo

neutron-contracts's Introduction

Neutron Cosmwasm Contracts

This monorepository contains the source code of smart contracts and packages for interacting with Neutron blockchain

Overview

Neutron SDK

The Neutron SDK is contained inside packages folder and consists of the following subpackages:

Package Reference Description
Neutron Interchain Queries https://github.com/neutron-org/neutron-contracts/tree/main/packages/neutron-sdk/src/interchain_queries Queries, messages and helper methods for interacting with Neutron Interchain Queries Module
Neutron Interchain Transactions https://github.com/neutron-org/neutron-contracts/tree/main/packages/neutron-sdk/src/interchain_txs Queries, messages and helper methods for interacting with Neutron Interchain Transactions Module
Neutron Bindings https://github.com/neutron-org/neutron-contracts/tree/main/packages/neutron-sdk/src/bindings Structures and helper methods for interacting with Neutron blockchain
Neutron Sudo https://github.com/neutron-org/neutron-contracts/tree/main/packages/neutron-sdk/src/sudo Structures for Sudo Contract callbacks from Neutron blockchain
Neutron Errors https://github.com/neutron-org/neutron-contracts/tree/main/packages/neutron-sdk/src/errors Structures and helpers for Neutron specific error and result types
Neutron Proto Types https://github.com/neutron-org/neutron-contracts/tree/main/packages/neutron-sdk/src/proto_types Neutron specific protobuf types.

Contracts

The following contracts are maintained here:

Contract Reference Description
Neutron Interchain Queries Example Contract https://github.com/neutron-org/neutron-contracts/tree/main/contracts/neutron-interchain-queries The contract shows how to properly work with Interchain Queries Module using Interchain Queries SDK package via CosmWasm smart-contract.
Neutron Interchain Transactions Example Contract https://github.com/neutron-org/neutron-contracts/tree/main/contracts/neutron_interchain_txs The contract shows how to properly work with Neutron Interchain Transactions Module using Interchain Transactions SDK package via CosmWasm smart-contract.
Neutron IBC Transfer Example Contract https://github.com/neutron-org/neutron-contracts/tree/main/contracts/ibc_transfer The contract shows how to properly work with Neutron Sudo Package to handle a callback from IBC transfer.
Reflect https://github.com/neutron-org/neutron-contracts/tree/main/contracts/reflect This contract is used for tests in the main neutron repository.

Development

Environment Setup

  • Rust v1.60.0+
  • wasm32-unknown-unknown target
  • Docker
  1. Install rustup via https://rustup.rs/

  2. Run the following:

rustup default stable
rustup target add wasm32-unknown-unknown
  1. Make sure Docker is installed

Unit Tests

Each contract contains Rust unit tests embedded within the contract source directories. You can run:

make test

Generating schema

make schema

Production

For production builds, run the following:

make build

This performs several optimizations which can significantly reduce the final size of the contract binaries, which will be available inside the artifacts/ directory.

Documentation

Check you the documentation at <LINK_TO_DOCS_PAGE>.

License

Copyright 2022 Neutron

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

neutron-contracts's People

Contributors

pr0n00gler avatar ratik avatar zavgorodnii avatar swelf19 avatar neverhappened avatar sotnikov-s avatar foxpy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.