파일코인 지갑 구조

파일코인의 중앙화 지갑은 다음과 같이 구성되어 있습니다.

대표주소
자식주소

TIP
파일코인은 수수료주소를 사용하지 않습니다.

자식주소

자식주소 생성 API를 호출하여 자식주소를 생성합니다. 일반적으로 자식주소는 엔드 유저 당 1개씩 부여합니다. 생성한 자식주소는 콘솔의 [자식주소 정보]에서 확인하거나 자식주소 목록 조회 API를 호출하여 확인할 수 있습니다.

Response 예시

[
  {
    "address": "t1mhblq57fq2ccd2crfcuqnslqorac3m7iiwjda3q",
    "name": "테스트용 자식주소"
  }
]

입금

입금 상태

외부에서 보낸 자산이 대표주소나 자식주소에 도착하면 옥텟은 이를 입금으로 인식합니다. 단, 입금 트랜잭션이 블록에 포함되었더라도 입금을 완료로 처리하지 않습니다. 트랜잭션의 완결성을 보장하기 위해 추가로 블록이 생성되어야 해당 트랜잭션을 완료(FINALIZED)로 처리합니다. 외부에서 자산을 보냈으나 대표주소나 자식주소에 도착하지 않았다면 해당 트랜잭션은 인식되지 않습니다. 따라서 입금 트랜잭션에는 실패(FAILED) 상태가 없습니다.

상태명	내용
`UNFINALIZED`	입금 트랜잭션이 블록에 포함된 상태
`FINALIZED`	입금 트랜잭션이 블록에 포함된 뒤 다음 블록이 생성된 상태

입금을 완료 처리하기 위해 필요한 블록의 개수는 네트워크에 따라 다릅니다. 테스트넷과 메인넷 모두 200개의 블록이 추가로 생성되어야 해당 트랜잭션을 입금 완료로 처리합니다.

테스트넷	메인넷
200 block (약 200분)	200 block (약 200분)

입금 확인

1. 콘솔에서 확인하기

콘솔의 [입출금 내역]에서 입금 내역을 확인할 수 있습니다. UNFINALIZED 상태인 입금은 '진행'으로 표시되며, FINALIZED 상태인 입금은 '완료'로 표시됩니다.

2. 웹훅으로 확인하기

대표주소나 자식주소에 입금이 완료되면 입금 웹훅이 전송됩니다. 전송된 웹훅으로 입금 여부를 확인할 수 있습니다. 웹훅 이용 방법과 전송되는 데이터 형태는 웹훅 페이지를 참고하세요.

집금

집금 과정 및 수수료

자식주소에 보관된 자산은 집금을 요청하기 전까지는 대표주소로 이동하지 않습니다. 따라서 대표주소의 잔액이 부족하지 않도록 주기적으로 집금을 진행해야 합니다.

특정 자산의 집금을 요청하면 모든 자식주소에 보관된 FIL이 대표주소로 이동합니다. 이때 자식주소 당 트랜잭션이 1개씩 발생합니다. 예를 들어 자식주소 10개에 FIL가 보관되어 있다면 총 10개의 트랜잭션이 발생하게 됩니다.

집금 수수료는 트랜잭션 당 1회씩 발생하며, 집금할 자산에서 차감됩니다. 집금할 자산이 예상 수수료보다 적은 자식주소에서는 집금이 진행되지 않습니다. 집금 진행 과정은 다음과 같습니다.

집금을 요청합니다.
집금을 실행할 자식주소 별 트랜잭션을 생성합니다.
최적 수수료를 계산한 뒤 트랜잭션을 전파합니다.
트랜잭션이 블록에 반영되면 집금이 완료됩니다.

집금 상태

집금 상태는 집금 과정에 따라 4가지로 구분됩니다. 자식주소에 보관된 자산은 집금 대기(AWAITING_GATHERING) 상태입니다.

집금을 요청하여 집금 트랜잭션이 생성되면 자산의 상태가 집금 중(GATHERING)으로 변경됩니다. 해당 트랜잭션이 블록에 포함되면 자산의 상태가 집금 완료(COMPLETED) 처리되며 집금이 완료됩니다.

집금을 시도했으나 트랜잭션이 실패한 경우 자산의 상태가 집금 실패(GATHERING_FAILED) 상태로 남게 됩니다. 집금 실패 상태인 자산은 다시 집금 대상에 포함됩니다. 집금을 시도했으나 수수료가 부족하여 트랜잭션이 생성되지 못한 경우 집금 대기(AWAITING_GATHERING) 상태로 남게 됩니다.

상태명	내용
`AWAITING_GATHERING`	집금 대기 중
`GATHERING`	집금 트랜잭션 생성
`COMPLETED`	집금 트랜잭션 완료
`GATHERING_FAILED`	집금 트랜잭션 실패

집금하기

자식주소에 보관된 자산을 대표지갑으로 이동합니다. 다음과 같이 2가지 방법으로 집금을 진행할 수 있습니다.

1. 콘솔에서 집금하기

콘솔 - 지갑 선택 - [집금 내역]에서 집금을 진행할 수 있습니다. [집금하기] 버튼을 클릭하고 집금할 자산과 수량을 확인한 뒤 집금을 진행하세요.

2. API로 집금하기

집금 신청 API를 호출하면 집금이 진행됩니다.

Response 예시

[
    {
        "success": true,
        "uuid": "25c7aa4f-45e6-4f1c-977f-dc6123aac152",
        "childAddresses": [
            "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva"
        ]
    }
]

집금 확인

1. 콘솔에서 확인하기

지갑 선택 - [집금 내역] - [집금 내역]에서 집금 내역을 확인할 수 있습니다.

2. API로 확인하기

집금 신청 정보 조회 API를 호출하면 집금 내역을 확인할 수 있습니다.

Response 예시

{
    "idx": 22,
    "status": "GATHERING",
    "uuid": "25c7aa4f-45e6-4f1c-977f-dc6123aac152",
    "createdDate": "2023-06-14T03:35:46.904Z",
    "modifiedDate": "2023-06-14T03:35:50.000Z",
    "coin": {
        "idx": 113,
        "symbol": "FIL",
        "nameKo": "파일코인",
        "nameEn": "Filecoin",
        "status": "ACTIVATED",
        "type": "DEFAULT",
        "contractAddress": null,
        "decimals": 18,
        "createdDate": "2023-06-02T02:31:46.996Z",
        "modifiedDate": "2023-06-02T02:31:46.996Z"
    },
    "feeInjectionTransaction": null,
    "feeInjectionFee": null,
    "gatheringTransaction": {
        "idx": 177,
        "uuid": "25c7aa4f-45e6-4f1c-977f-dc6123aac152",
        "type": "GATHERING",
        "txid": "bafy2bzaceahyi3boucmmsyo7xj6yuobz3qjmh7nhoeegebncot3vs7hklkziw",
        "fromAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
        "toAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
        "amount": "3.99999984675548181800",
        "usedFee": null,
        "nonce": 0,
        "blockHeight": null,
        "serialized": "8a005501bdba675120f7a9ce79af847796276b8ffa88a9ae550138d376cf772ac30ea36c9875a5154956f42383180049003782daaaef7a38da1a0017509144000187c644000184020040",
        "memo": null,
        "status": "PENDING",
        "outputIndex": 0,
        "createdDate": "2023-06-14T03:35:50.456Z",
        "modifiedDate": "2023-06-14T03:35:50.456Z",
        "unfinalizedDate": null,
        "finalizedDate": null,
        "failedDate": null,
        "coin": {
            "idx": 113,
            "symbol": "FIL",
            "nameKo": "파일코인",
            "nameEn": "Filecoin",
            "status": "ACTIVATED",
            "type": "DEFAULT",
            "contractAddress": null,
            "decimals": 18,
            "createdDate": "2023-06-02T02:31:46.996Z",
            "modifiedDate": "2023-06-02T02:31:46.996Z"
        }
    },
    "gatheringFee": {
        "idx": 176,
        "gasLimit": "1527953.00000000000000000000",
        "gasPrice": "100294.00000000000000000000",
        "rate": null,
        "unit": "attoFIL",
        "createdDate": "2023-06-14T03:35:46.896Z",
        "modifiedDate": "2023-06-14T03:35:46.896Z"
    },
    "targets": [
        {
            "idx": 165,
            "uuid": "e87255c4-8373-4cd0-a710-7620b6a70b1b",
            "type": "DEPOSIT",
            "txid": "bafy2bzacebjbignostiew2r6csrqrrfkbpfv7254cjxxbm6jr4rpmuavmmbfs",
            "fromAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
            "toAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
            "amount": "1.00000000000000000000",
            "usedFee": "0.00000072386477277000",
            "nonce": 0,
            "blockHeight": "643810",
            "serialized": null,
            "memo": null,
            "status": "FINALIZED",
            "outputIndex": 0,
            "createdDate": "2023-06-13T07:18:31.179Z",
            "modifiedDate": "2023-06-13T08:59:02.000Z",
            "unfinalizedDate": "2023-06-13T07:18:31.000Z",
            "finalizedDate": "2023-06-13T08:59:02.000Z",
            "failedDate": null
        },
        {
            "idx": 174,
            "uuid": "e9f336bd-7c22-427b-bead-150f3b58beee",
            "type": "DEPOSIT",
            "txid": "bafy2bzaceaa4gpyhxju6dzc7v2thboxq5g3lttpfnqvnmgtbmw5xiz3oqeqme",
            "fromAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
            "toAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
            "amount": "1.00000000000000000000",
            "usedFee": "0.00000015351524876400",
            "nonce": 1,
            "blockHeight": "643991",
            "serialized": null,
            "memo": null,
            "status": "FINALIZED",
            "outputIndex": 0,
            "createdDate": "2023-06-13T08:49:01.423Z",
            "modifiedDate": "2023-06-13T10:29:31.000Z",
            "unfinalizedDate": "2023-06-13T08:49:01.000Z",
            "finalizedDate": "2023-06-13T10:29:31.000Z",
            "failedDate": null
        },
        {
            "idx": 175,
            "uuid": "8f169739-6029-4a93-8270-bc888b35e828",
            "type": "DEPOSIT",
            "txid": "bafy2bzacecfu4i742377olw5disyvm4wwsasoexgzaphpjp5a2ii4d6mkjuzy",
            "fromAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
            "toAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
            "amount": "1.00000000000000000000",
            "usedFee": "0.00000015266417894300",
            "nonce": 2,
            "blockHeight": "643991",
            "serialized": null,
            "memo": null,
            "status": "FINALIZED",
            "outputIndex": 0,
            "createdDate": "2023-06-13T08:49:01.549Z",
            "modifiedDate": "2023-06-13T10:29:31.000Z",
            "unfinalizedDate": "2023-06-13T08:49:02.000Z",
            "finalizedDate": "2023-06-13T10:29:31.000Z",
            "failedDate": null
        },
        {
            "idx": 176,
            "uuid": "ed396dc5-4220-4fcf-b837-ba9bf2c5c98c",
            "type": "DEPOSIT",
            "txid": "bafy2bzaceboa4jawafuntbqedwluhr452a4jglturib5g3mlata3oowphl2es",
            "fromAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
            "toAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
            "amount": "1.00000000000000000000",
            "usedFee": "0.00000015307825420600",
            "nonce": 3,
            "blockHeight": "643991",
            "serialized": null,
            "memo": null,
            "status": "FINALIZED",
            "outputIndex": 0,
            "createdDate": "2023-06-13T08:49:01.681Z",
            "modifiedDate": "2023-06-13T10:29:31.000Z",
            "unfinalizedDate": "2023-06-13T08:49:02.000Z",
            "finalizedDate": "2023-06-13T10:29:32.000Z",
            "failedDate": null
        }
    ],
    "errorCode": null,
    "errorMessage": null
}

3. 웹훅으로 확인하기

대표주소로 집금이 완료되면 집금 웹훅이 전송됩니다. 전송된 웹훅으로 집금 여부를 확인할 수 있습니다. 웹훅 이용 방법과 전송되는 데이터 형태는 웹훅 페이지를 참고하세요.

출금

출금 과정

중앙화 지갑에서 외부로 자산을 보내려면 반드시 대표주소에서 출금해야 합니다. 자식주소에서는 외부로 자산을 출금할 수 없습니다.

출금을 요청합니다.
트랜잭션을 생성합니다.
최적 수수료를 계산한 뒤 트랜잭션을 전파합니다.
트랜잭션이 블록에 반영되면 출금이 완료됩니다.

출금 상태

입금과는 달리 출금은 트랜잭션이 블록에 포함된 즉시 출금 완료(FINALIZED) 처리됩니다.

상태명	내용
`AWAITING_DECISION`	출금 승인 대기 중인 상태
`REJECTED`	출금이 거절된 상태
`AWAITING_WITHDRAWAL`	출금이 승인되어 출금 대기 중인 상태
`PENDING`	출금 트랜잭션이 생성된 상태
`FINALIZED`	출금 트랜잭션이 블록에 포함된 상태
`FAILED`	출금 트랜잭션이 실패한 상태

출금하기

출금 신청 API를 호출하면 대표주소에서 외부로 출금을 요청할 수 있습니다. 출금 요청에 성공하면 uuid 값이 반환됩니다. 해당 값으로 출금 진행 상태를 조회할 수 있습니다.

Response 예시

{
  "uuid": "8bc699a0-7dbd-4b34-b546-e908b448907d"
}

출금 확인

1. 콘솔에서 확인하기

콘솔의 [입출금 내역]에서 출금 내역을 확인할 수 있습니다. AWAITING_WITHDRAWAL와 PENDING 상태인 출금은 '진행'으로 표시되며, FINALIZED 상태인 출금은 '완료'로 표시됩니다.

2. API로 확인하기

출금 트랜잭션 정보 조회 API를 호출하면 특정 출금 트랜잭션의 진행 상태를 확인할 수 있습니다.

Response 예시

{
    "idx": 76,
    "coin": {
        "idx": 113,
        "symbol": "FIL",
        "nameKo": "파일코인",
        "nameEn": "Filecoin",
        "status": "ACTIVATED",
        "type": "DEFAULT",
        "contractAddress": null,
        "decimals": 18,
        "createdDate": "2023-06-02T02:31:46.996Z",
        "modifiedDate": "2023-06-02T02:31:46.996Z"
    },
    "uuid": "144d0137-5801-4a9c-90d0-f7372129f544",
    "fromAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
    "toAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
    "amount": "1.00000000000000000000",
    "memo": null,
    "requestId": "202306131553",
    "type": "API",
    "description": "",
    "requiredApprovalCount": 2,
    "useApiAutoApproval": true,
    "useFeeDelegation": false,
    "feePayerAddress": null,
    "status": "SENT",
    "createdDate": "2023-06-13T07:17:24.415Z",
    "modifiedDate": "2023-06-13T07:17:30.000Z",
    "rejectedDate": null,
    "transaction": {
        "idx": 164,
        "uuid": "144d0137-5801-4a9c-90d0-f7372129f544",
        "type": "WITHDRAWAL",
        "txid": "bafy2bzacebjbignostiew2r6csrqrrfkbpfv7254cjxxbm6jr4rpmuavmmbfs",
        "fromAddress": "t1xw5gouja66u446npqr3zmj3lr75irknops3idoa",
        "toAddress": "t1hdjxnt3xflbq5i3mtb22kfkjk32chayynqugvva",
        "amount": "1.00000000000000000000",
        "usedFee": null,
        "nonce": 0,
        "blockHeight": null,
        "serialized": "8a00550138d376cf772ac30ea36c9875a5154956f42383185501bdba675120f7a9ce79af847796276b8ffa88a9ae0049000de0b6b3a76400001a006dd1764400018d18440001888f0040",
        "memo": null,
        "status": "PENDING",
        "outputIndex": 0,
        "createdDate": "2023-06-13T07:17:30.807Z",
        "modifiedDate": "2023-06-13T07:17:30.807Z",
        "unfinalizedDate": null,
        "finalizedDate": null,
        "failedDate": null
    },
    "errorCode": null,
    "errorMessage": null
}

3. 웹훅으로 확인하기

대표주소에서 외부로 출금이 완료되면 출금 웹훅이 전송됩니다. 전송된 웹훅으로 출금 여부를 확인할 수 있습니다. 웹훅 이용 방법과 전송되는 데이터 형태는 웹훅 페이지를 참고하세요.

잔액 조회 기준

주소 잔액 조회 API를 호출하면 특정 주소에 보관된 자산의 잔액을 확인할 수 있습니다. 이때 조회되는 잔액은 총 잔액(Total Balance)과 사용 가능 잔액(Liquid Balance)으로 나누어집니다.

총 잔액은 confirmation이 1 이상인 모든 자산을 의미합니다.
사용 가능 잔액은 집금 또는 출금 가능한 자산을 의미합니다. 자식주소의 사용 가능 잔액은 집금 가능한 자산을 의미하며, 대표주소의 사용 가능 잔액은 출금 가능한 자산을 의미합니다.

수수료

예상 수수료 (최대 수수료)

예상 수수료는 가스 한도와 최대 가스 단가를 곱하여 계산합니다.

예상 수수료 = 가스 한도(Gas Limit) x 최대 가스 단가(Gas Fee Cap)

Gas Limit은 가스 사용량의 최댓값입니다. 실제 가스 사용량은 이보다 더 적을 수 있으며, 수수료는 실제 가스 사용량만큼만 부과됩니다.
Gas Fee Cap는 가스 당 가격의 최댓값입니다. 수수료 조회 API를 호출하여 이 값을 조회할 수 있습니다. 실제 가스 당 가격은 이보다 작을 수 있습니다.

트랜잭션 수수료

트랜잭션에 사용된 수수료는 사용한 가스의 양과 가스 단가를 곱하여 계산합니다. 추가로, 최대 수수료 상한선 내에서 블록 생성자에게 팁을 지불하게 됩니다.

트랜잭션 수수료 = {총 가스 사용량(Gas Used) x 가스 단가(Base Fee)} + {가스 프리미엄(Gas Premium) x 가스 한도(Gas Limit)}

Gas Used는 트랜잭션이 블록에 담기기까지 사용한 가스량입니다.
Base Fee는 가스 단가입니다.
Gas Premium은 블록 생성자에게 지불하는 팁의 가스 당 가격입니다.

Faucet

테스트넷일 경우 Faucet 사이트에서 테스트용 파일코인을 얻은 뒤 입금해야 합니다. 테스트넷에 실제 파일코인을 입금하면 입금이 인식되지 않습니다.